Microsoft.HybridCompute (preview:2024-11-10)

2024/12/04 • 73 new methods

Licenses_ValidateLicense (new)
Description :  The operation to validate a license.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the license validation operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_CreateOrUpdate (new)
Description :  The operation to create or update a license.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
licenseName:
{
Description: The name of the license. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create license operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_Update (new)
Description :  The operation to update a license.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
licenseName:
{
Description: The name of the license. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update license operation. ,
Required: True ,
}
{
properties:
{
Description: License Update properties ,
Required: False ,
}
{
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_Get (new)
Description :  Retrieves information about the view of a license.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
licenseName:
{
Description: The name of the license. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_Delete (new)
Description :  The operation to delete a license.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
licenseName:
{
Description: The name of the license. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_ListByResourceGroup (new)
Description :  The operation to get all licenses of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of licenses. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_ListBySubscription (new)
Description :  The operation to get all licenses of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/licenses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of licenses. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_CreateOrUpdate (new)
Description :  The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
hardwareProfile:
{
Description: Information about the machine's hardware ,
Required: False ,
}
{
totalPhysicalMemoryInBytes:
{
Description: The total physical memory on the machine ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCpuSockets:
{
Description: The total number of CPU sockets available on the machine ,
Format: int32 ,
Required: False ,
}
integer ,
processors:
{
Description: The physical processors of the machine. ,
Required: False ,
}
[
{
name:
{
Description: The name of the processor. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The total number of physical cores on the processor. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
storageProfile:
{
Description: Information about the machine's storage ,
Required: False ,
}
{
disks:
{
Description: The disks on the machine. ,
Required: False ,
}
[
{
path:
{
Description: The path of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: The type of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: The generated ID of the disk. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the disk. ,
Required: False ,
}
string ,
name:
{
Description: The name of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: The size of the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
usedSpaceInBytes:
{
Description: The amount of space used on the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
firmwareProfile:
{
Description: Information about the machine's firmware ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number of the firmware ,
Required: False ,
}
string ,
type:
{
Description: The type of the firmware ,
Required: False ,
}
string ,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
licenseProfile:
{
Description: Specifies the License related properties for a machine. ,
Required: False ,
}
{
licenseStatus:
{
Description: Indicates the license status of the OS. ,
Enum:
{
Unlicensed: No description available. ,
Licensed: No description available. ,
OOBGrace: No description available. ,
OOTGrace: No description available. ,
NonGenuineGrace: No description available. ,
Notification: No description available. ,
ExtendedGrace: No description available. ,
}
,
Required: False ,
}
enum ,
licenseChannel:
{
Description: Indicates the license channel. ,
Required: False ,
}
string ,
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Properties for the Machine ESU profile. ,
Required: False ,
}
{
assignedLicense:
{
Description: The assigned license resource. ,
Required: False ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
licenseAssignmentState:
{
Description: Describes the license assignment state (Assigned or NotAssigned). ,
Enum:
{
Assigned: No description available. ,
NotAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information (deprecated field) ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
osEdition:
{
Description: The edition of the Operating System. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
networkProfile:
{
Description: Information about the network the machine is on. ,
Required: False ,
}
{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
$expand:
{
Description: Expands referenced resources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
hardwareProfile:
{
Description: Information about the machine's hardware ,
Required: False ,
}
{
totalPhysicalMemoryInBytes:
{
Description: The total physical memory on the machine ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCpuSockets:
{
Description: The total number of CPU sockets available on the machine ,
Format: int32 ,
Required: False ,
}
integer ,
processors:
{
Description: The physical processors of the machine. ,
Required: False ,
}
[
{
name:
{
Description: The name of the processor. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The total number of physical cores on the processor. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
storageProfile:
{
Description: Information about the machine's storage ,
Required: False ,
}
{
disks:
{
Description: The disks on the machine. ,
Required: False ,
}
[
{
path:
{
Description: The path of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: The type of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: The generated ID of the disk. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the disk. ,
Required: False ,
}
string ,
name:
{
Description: The name of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: The size of the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
usedSpaceInBytes:
{
Description: The amount of space used on the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
firmwareProfile:
{
Description: Information about the machine's firmware ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number of the firmware ,
Required: False ,
}
string ,
type:
{
Description: The type of the firmware ,
Required: False ,
}
string ,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
licenseProfile:
{
Description: Specifies the License related properties for a machine. ,
Required: False ,
}
{
licenseStatus:
{
Description: Indicates the license status of the OS. ,
Enum:
{
Unlicensed: No description available. ,
Licensed: No description available. ,
OOBGrace: No description available. ,
OOTGrace: No description available. ,
NonGenuineGrace: No description available. ,
Notification: No description available. ,
ExtendedGrace: No description available. ,
}
,
Required: False ,
}
enum ,
licenseChannel:
{
Description: Indicates the license channel. ,
Required: False ,
}
string ,
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Properties for the Machine ESU profile. ,
Required: False ,
}
{
assignedLicense:
{
Description: The assigned license resource. ,
Required: False ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
licenseAssignmentState:
{
Description: Describes the license assignment state (Assigned or NotAssigned). ,
Enum:
{
Assigned: No description available. ,
NotAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information (deprecated field) ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
osEdition:
{
Description: The edition of the Operating System. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
networkProfile:
{
Description: Information about the network the machine is on. ,
Required: False ,
}
{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Update (new)
Description :  The operation to update a hybrid machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
hardwareProfile:
{
Description: Information about the machine's hardware ,
Required: False ,
}
{
totalPhysicalMemoryInBytes:
{
Description: The total physical memory on the machine ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCpuSockets:
{
Description: The total number of CPU sockets available on the machine ,
Format: int32 ,
Required: False ,
}
integer ,
processors:
{
Description: The physical processors of the machine. ,
Required: False ,
}
[
{
name:
{
Description: The name of the processor. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The total number of physical cores on the processor. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
storageProfile:
{
Description: Information about the machine's storage ,
Required: False ,
}
{
disks:
{
Description: The disks on the machine. ,
Required: False ,
}
[
{
path:
{
Description: The path of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: The type of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: The generated ID of the disk. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the disk. ,
Required: False ,
}
string ,
name:
{
Description: The name of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: The size of the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
usedSpaceInBytes:
{
Description: The amount of space used on the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
firmwareProfile:
{
Description: Information about the machine's firmware ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number of the firmware ,
Required: False ,
}
string ,
type:
{
Description: The type of the firmware ,
Required: False ,
}
string ,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
licenseProfile:
{
Description: Specifies the License related properties for a machine. ,
Required: False ,
}
{
licenseStatus:
{
Description: Indicates the license status of the OS. ,
Enum:
{
Unlicensed: No description available. ,
Licensed: No description available. ,
OOBGrace: No description available. ,
OOTGrace: No description available. ,
NonGenuineGrace: No description available. ,
Notification: No description available. ,
ExtendedGrace: No description available. ,
}
,
Required: False ,
}
enum ,
licenseChannel:
{
Description: Indicates the license channel. ,
Required: False ,
}
string ,
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Properties for the Machine ESU profile. ,
Required: False ,
}
{
assignedLicense:
{
Description: The assigned license resource. ,
Required: False ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
licenseAssignmentState:
{
Description: Describes the license assignment state (Assigned or NotAssigned). ,
Enum:
{
Assigned: No description available. ,
NotAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information (deprecated field) ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
osEdition:
{
Description: The edition of the Operating System. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
networkProfile:
{
Description: Information about the network the machine is on. ,
Required: False ,
}
{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Delete (new)
Description :  The operation to delete a hybrid machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Get (new)
Description :  Retrieves information about the model view or the instance view of a hybrid machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
hardwareProfile:
{
Description: Information about the machine's hardware ,
Required: False ,
}
{
totalPhysicalMemoryInBytes:
{
Description: The total physical memory on the machine ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCpuSockets:
{
Description: The total number of CPU sockets available on the machine ,
Format: int32 ,
Required: False ,
}
integer ,
processors:
{
Description: The physical processors of the machine. ,
Required: False ,
}
[
{
name:
{
Description: The name of the processor. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The total number of physical cores on the processor. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
storageProfile:
{
Description: Information about the machine's storage ,
Required: False ,
}
{
disks:
{
Description: The disks on the machine. ,
Required: False ,
}
[
{
path:
{
Description: The path of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: The type of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: The generated ID of the disk. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the disk. ,
Required: False ,
}
string ,
name:
{
Description: The name of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: The size of the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
usedSpaceInBytes:
{
Description: The amount of space used on the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
firmwareProfile:
{
Description: Information about the machine's firmware ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number of the firmware ,
Required: False ,
}
string ,
type:
{
Description: The type of the firmware ,
Required: False ,
}
string ,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
licenseProfile:
{
Description: Specifies the License related properties for a machine. ,
Required: False ,
}
{
licenseStatus:
{
Description: Indicates the license status of the OS. ,
Enum:
{
Unlicensed: No description available. ,
Licensed: No description available. ,
OOBGrace: No description available. ,
OOTGrace: No description available. ,
NonGenuineGrace: No description available. ,
Notification: No description available. ,
ExtendedGrace: No description available. ,
}
,
Required: False ,
}
enum ,
licenseChannel:
{
Description: Indicates the license channel. ,
Required: False ,
}
string ,
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Properties for the Machine ESU profile. ,
Required: False ,
}
{
assignedLicense:
{
Description: The assigned license resource. ,
Required: False ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
licenseAssignmentState:
{
Description: Describes the license assignment state (Assigned or NotAssigned). ,
Enum:
{
Assigned: No description available. ,
NotAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information (deprecated field) ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
osEdition:
{
Description: The edition of the Operating System. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
networkProfile:
{
Description: Information about the network the machine is on. ,
Required: False ,
}
{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LicenseProfiles_CreateOrUpdate (new)
Description :  The operation to create or update a license profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
licenseProfileName:
{
Description: The name of the license profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create or Update license profile operation. ,
Required: True ,
}
{
properties:
{
Description: Describe the properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describe the properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}
,
$schema:
{
Description: Describes a license profile in a hybrid machine. ,
}
{
properties:
{
Description: Describe the properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LicenseProfiles_Update (new)
Description :  The operation to update a license profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
licenseProfileName:
{
Description: The name of the license profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update license profile operation. ,
Required: True ,
}
{
properties:
{
Description: Describe the Update properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile Update properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile Update properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
productFeatures:
{
Description: The list of product feature updates. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the new status of the product feature. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describe the properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LicenseProfiles_Get (new)
Description :  Retrieves information about the view of a license profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
licenseProfileName:
{
Description: The name of the license profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describe the properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LicenseProfiles_Delete (new)
Description :  The operation to delete a license profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
licenseProfileName:
{
Description: The name of the license profile. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LicenseProfiles_List (new)
Description :  The operation to get all license profiles of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the machine. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of license profiles. ,
Required: True ,
}
[
{
properties:
{
Description: Describe the properties of a license profile. ,
Required: False ,
}
{
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Hybrid Compute ESU Profile properties ,
Required: False ,
}
{
assignedLicense:
{
Description: The resource id of the license. ,
Required: False ,
}
string ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_AssessPatches (new)
Description :  The operation to assess patches on a hybrid machine identity in Azure.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
availablePatchCountByClassification:
{
Description: Summarization of patches available for installation on the machine by classification. ,
Required: False ,
}
{
security:
{
Description: Number of security patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
critical:
{
Description: Number of critical patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
definition:
{
Description: Number of definition patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
updateRollup:
{
Description: Number of update Rollup patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
featurePack:
{
Description: Number of feature pack patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
servicePack:
{
Description: Number of service pack patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
tools:
{
Description: Number of tools patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
updates:
{
Description: Number of updates category patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
other:
{
Description: Number of other patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp when the operation finished. ,
Format: date-time ,
Required: False ,
}
string ,
startedBy:
{
Description: Indicates if operation was triggered by user or by platform. ,
Enum:
{
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
patchServiceUsed:
{
Description: Specifies the patch service used for the operation. ,
Enum:
{
Unknown: No description available. ,
WU: No description available. ,
WU_WSUS: No description available. ,
YUM: No description available. ,
APT: No description available. ,
Zypper: No description available. ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: The operating system type of the machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_InstallPatches (new)
Description :  The operation to install patches on a hybrid machine identity in Azure.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
installPatchesInput:
{
Description: Input for InstallPatches as directly received by the API ,
Required: True ,
}
{
maximumDuration:
{
Description: Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) ,
Required: True ,
}
string ,
rebootSetting:
{
Description: Defines when it is acceptable to reboot a VM during a software update operation. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: True ,
}
enum ,
windowsParameters:
{
Description: Input for InstallPatches on a Windows VM, as directly received by the API ,
Required: False ,
}
{
classificationsToInclude:
{
Description: The update classifications to select when installing patches for Windows. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Kbs to include in the patch operation ,
Required: False ,
}
[
string ,
]
,
kbNumbersToExclude:
{
Description: Kbs to exclude in the patch operation ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. ,
Required: False ,
}
boolean ,
maxPatchPublishDate:
{
Description: This is used to install patches that were published on or before this given max published date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
linuxParameters:
{
Description: Input for InstallPatches on a Linux VM, as directly received by the API ,
Required: False ,
}
{
classificationsToInclude:
{
Description: The update classifications to select when installing patches for Linux. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: packages to include in the patch operation. Format: packageName_packageVersion ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToExclude:
{
Description: packages to exclude in the patch operation. Format: packageName_packageVersion ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: The reboot state of the VM following completion of the operation. ,
Enum:
{
Unknown: No description available. ,
NotNeeded: No description available. ,
Required: No description available. ,
Started: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowExceeded:
{
Description: Whether the operation ran out of time before it completed all its intended actions. ,
Required: False ,
}
boolean ,
excludedPatchCount:
{
Description: The number of patches that were not installed due to the user blocking their installation. ,
Format: int32 ,
Required: False ,
}
integer ,
notSelectedPatchCount:
{
Description: The number of patches that were detected as available for install, but did not meet the operation's criteria. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The number of patches successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The number of patches that could not be installed due to some issue. See errors for details. ,
Format: int32 ,
Required: False ,
}
integer ,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp when the operation finished. ,
Format: date-time ,
Required: False ,
}
string ,
startedBy:
{
Description: Indicates if operation was triggered by user or by platform. ,
Enum:
{
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
patchServiceUsed:
{
Description: Specifies the patch service used for the operation. ,
Enum:
{
Unknown: No description available. ,
WU: No description available. ,
WU_WSUS: No description available. ,
YUM: No description available. ,
APT: No description available. ,
Zypper: No description available. ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: The operating system type of the machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_ListByResourceGroup (new)
Description :  Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Expands referenced resources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
hardwareProfile:
{
Description: Information about the machine's hardware ,
Required: False ,
}
{
totalPhysicalMemoryInBytes:
{
Description: The total physical memory on the machine ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCpuSockets:
{
Description: The total number of CPU sockets available on the machine ,
Format: int32 ,
Required: False ,
}
integer ,
processors:
{
Description: The physical processors of the machine. ,
Required: False ,
}
[
{
name:
{
Description: The name of the processor. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The total number of physical cores on the processor. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
storageProfile:
{
Description: Information about the machine's storage ,
Required: False ,
}
{
disks:
{
Description: The disks on the machine. ,
Required: False ,
}
[
{
path:
{
Description: The path of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: The type of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: The generated ID of the disk. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the disk. ,
Required: False ,
}
string ,
name:
{
Description: The name of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: The size of the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
usedSpaceInBytes:
{
Description: The amount of space used on the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
firmwareProfile:
{
Description: Information about the machine's firmware ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number of the firmware ,
Required: False ,
}
string ,
type:
{
Description: The type of the firmware ,
Required: False ,
}
string ,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
licenseProfile:
{
Description: Specifies the License related properties for a machine. ,
Required: False ,
}
{
licenseStatus:
{
Description: Indicates the license status of the OS. ,
Enum:
{
Unlicensed: No description available. ,
Licensed: No description available. ,
OOBGrace: No description available. ,
OOTGrace: No description available. ,
NonGenuineGrace: No description available. ,
Notification: No description available. ,
ExtendedGrace: No description available. ,
}
,
Required: False ,
}
enum ,
licenseChannel:
{
Description: Indicates the license channel. ,
Required: False ,
}
string ,
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Properties for the Machine ESU profile. ,
Required: False ,
}
{
assignedLicense:
{
Description: The assigned license resource. ,
Required: False ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
licenseAssignmentState:
{
Description: Describes the license assignment state (Assigned or NotAssigned). ,
Enum:
{
Assigned: No description available. ,
NotAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information (deprecated field) ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
osEdition:
{
Description: The edition of the Operating System. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
networkProfile:
{
Description: Information about the network the machine is on. ,
Required: False ,
}
{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_ListBySubscription (new)
Description :  Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
hardwareProfile:
{
Description: Information about the machine's hardware ,
Required: False ,
}
{
totalPhysicalMemoryInBytes:
{
Description: The total physical memory on the machine ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfCpuSockets:
{
Description: The total number of CPU sockets available on the machine ,
Format: int32 ,
Required: False ,
}
integer ,
processors:
{
Description: The physical processors of the machine. ,
Required: False ,
}
[
{
name:
{
Description: The name of the processor. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The total number of physical cores on the processor. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
storageProfile:
{
Description: Information about the machine's storage ,
Required: False ,
}
{
disks:
{
Description: The disks on the machine. ,
Required: False ,
}
[
{
path:
{
Description: The path of the disk. ,
Required: False ,
}
string ,
diskType:
{
Description: The type of the disk. ,
Required: False ,
}
string ,
generatedId:
{
Description: The generated ID of the disk. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the disk. ,
Required: False ,
}
string ,
name:
{
Description: The name of the disk. ,
Required: False ,
}
string ,
maxSizeInBytes:
{
Description: The size of the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
usedSpaceInBytes:
{
Description: The amount of space used on the disk, in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
firmwareProfile:
{
Description: Information about the machine's firmware ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number of the firmware ,
Required: False ,
}
string ,
type:
{
Description: The type of the firmware ,
Required: False ,
}
string ,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
agentUpgrade:
{
Description: The info of the machine w.r.t Agent Upgrade ,
Required: False ,
}
{
desiredVersion:
{
Description: Specifies the version info w.r.t AgentUpgrade for the machine. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID associated with an agent upgrade operation. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Specifies if the machine's agent should be upgraded ,
Required: False ,
}
boolean ,
lastAttemptDesiredVersion:
{
Description: Specifies the version of the last attempt ,
Required: False ,
}
string ,
lastAttemptTimestamp:
{
Description: Timestamp of last upgrade attempt ,
Required: False ,
}
string ,
lastAttemptStatus:
{
Description: Specifies the status of Agent Upgrade. ,
Enum:
{
Success: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastAttemptMessage:
{
Description: Failure message of last upgrade attempt if any. ,
Required: False ,
}
string ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
hotpatchEnablementStatus:
{
Description: Indicates the current status of the hotpatch being enabled or disabled. ,
Enum:
{
Unknown: No description available. ,
PendingEvaluation: No description available. ,
Disabled: No description available. ,
ActionRequired: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The errors that were encountered during the hotpatch capability enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
licenseProfile:
{
Description: Specifies the License related properties for a machine. ,
Required: False ,
}
{
licenseStatus:
{
Description: Indicates the license status of the OS. ,
Enum:
{
Unlicensed: No description available. ,
Licensed: No description available. ,
OOBGrace: No description available. ,
OOTGrace: No description available. ,
NonGenuineGrace: No description available. ,
Notification: No description available. ,
ExtendedGrace: No description available. ,
}
,
Required: False ,
}
enum ,
licenseChannel:
{
Description: Indicates the license channel. ,
Required: False ,
}
string ,
softwareAssurance:
{
Required: False ,
}
{
softwareAssuranceCustomer:
{
Description: Specifies if this machine is licensed as part of a Software Assurance agreement. ,
Required: False ,
}
boolean ,
}
,
esuProfile:
{
Description: Properties for the Machine ESU profile. ,
Required: False ,
}
{
assignedLicense:
{
Description: The assigned license resource. ,
Required: False ,
}
{
properties:
{
Description: Hybrid Compute License properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Describes the tenant id. ,
Required: False ,
}
string ,
licenseType:
{
Description: The type of the license resource. ,
Enum:
{
ESU: No description available. ,
}
,
Required: False ,
}
enum ,
licenseDetails:
{
Description: Describes the properties of a License. ,
Required: False ,
}
{
state:
{
Description: Describes the state of the license. ,
Enum:
{
Activated: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Describes the license target server. ,
Enum:
{
Windows Server 2012: No description available. ,
Windows Server 2012 R2: No description available. ,
}
,
Required: False ,
}
enum ,
edition:
{
Description: Describes the edition of the license. The values are either Standard or Datacenter. ,
Enum:
{
Standard: No description available. ,
Datacenter: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Describes the license core type (pCore or vCore). ,
Enum:
{
pCore: No description available. ,
vCore: No description available. ,
}
,
Required: False ,
}
enum ,
processors:
{
Description: Describes the number of processors. ,
Format: int32 ,
Required: False ,
}
integer ,
assignedLicenses:
{
Description: Describes the number of assigned licenses. ,
Format: int32 ,
Required: False ,
}
integer ,
immutableId:
{
Description: Describes the immutable id. ,
Required: False ,
}
string ,
volumeLicenseDetails:
{
Description: A list of volume license details. ,
Required: False ,
}
[
{
programYear:
{
Description: Describes the program year the volume license is for. ,
Enum:
{
Year 1: No description available. ,
Year 2: No description available. ,
Year 3: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceId:
{
Description: The invoice id for the volume license. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
licenseAssignmentState:
{
Description: Describes the license assignment state (Assigned or NotAssigned). ,
Enum:
{
Assigned: No description available. ,
NotAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
productProfile:
{
Description: Hybrid Compute Product Profile properties ,
Required: False ,
}
{
subscriptionStatus:
{
Description: Indicates the subscription status of the product. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
productType:
{
Description: Indicates the product type of the license. ,
Enum:
{
WindowsServer: No description available. ,
WindowsIoTEnterprise: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
productFeatures:
{
Description: The list of product features. ,
Required: False ,
}
[
{
name:
{
Description: Product feature name. ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Indicates the current status of the product features. ,
Enum:
{
Unknown: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Disabling: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDate:
{
Description: The timestamp in UTC when the user enrolls the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingStartDate:
{
Description: The timestamp in UTC when the billing starts. ,
Format: date-time ,
Required: False ,
}
string ,
disenrollmentDate:
{
Description: The timestamp in UTC when the user disenrolled the feature. ,
Format: date-time ,
Required: False ,
}
string ,
billingEndDate:
{
Description: The timestamp in UTC when the billing ends. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during the feature enrollment or disenrollment. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information (deprecated field) ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
osEdition:
{
Description: The edition of the Operating System. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
networkProfile:
{
Description: Information about the network the machine is on. ,
Required: False ,
}
{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. ,
Enum:
{
AVS: No description available. ,
HCI: No description available. ,
SCVMM: No description available. ,
VMware: No description available. ,
EPS: No description available. ,
GCP: No description available. ,
AWS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_CreateOrUpdate (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Update (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Update Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Delete (new)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the machine where the extension should be deleted. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Get (new)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_List (new)
Description :  The operation to get all extensions of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extensions ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpgradeExtensions (new)
Description :  The operation to Upgrade Machine Extensions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
extensionUpgradeParameters:
{
Description: Parameters supplied to the Upgrade Extensions operation. ,
Required: True ,
}
{
extensionTargets:
{
Description: Describes the Extension Target Properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadata_Get (new)
Description :  Gets an Extension Metadata based on location, publisher, extensionType and version
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Extension being received. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
version:
{
Description: The version of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The single extension based on search criteria ,
Required: False ,
}
{
version:
{
Description: The version of the Extension being received. ,
Required: False ,
}
string ,
extensionType:
{
Description: The type of the Extension being received. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadata_List (new)
Description :  Gets all Extension versions based on location, publisher, extensionType
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Extension being received. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extension metadata ,
Required: False ,
}
[
{
properties:
{
Description: The single extension based on search criteria ,
Required: False ,
}
{
version:
{
Description: The version of the Extension being received. ,
Required: False ,
}
string ,
extensionType:
{
Description: The type of the Extension being received. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadataV2_Get (new)
Description :  Gets an Extension Metadata based on location, publisher, extensionType and version
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
version:
{
Description: The version of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The single extension based on search criteria. ,
Required: False ,
}
{
extensionUris:
{
Description: A list of locations where the extension packages can be found. ,
Required: False ,
}
[
string ,
]
,
extensionSignatureUri:
{
Description: Location of the signature files for the extension. ,
Format: uri ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system (Windows, Linux, etc.) this extension supports. ,
Required: False ,
}
string ,
architecture:
{
Description: Architectures (x64, arms64, etc.) that this extension supports. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadataV2_List (new)
Description :  Gets all Extension versions based on location, publisher, extensionType
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extension metadata. ,
Required: False ,
}
[
{
properties:
{
Description: The single extension based on search criteria. ,
Required: False ,
}
{
extensionUris:
{
Description: A list of locations where the extension packages can be found. ,
Required: False ,
}
[
string ,
]
,
extensionSignatureUri:
{
Description: Location of the signature files for the extension. ,
Format: uri ,
Required: False ,
}
string ,
operatingSystem:
{
Description: The operating system (Windows, Linux, etc.) this extension supports. ,
Required: False ,
}
string ,
architecture:
{
Description: Architectures (x64, arms64, etc.) that this extension supports. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of extension metadata. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionType_List (new)
Description :  Gets all Extension types based on location and publisher
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extension types. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the extension type. ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of extension types. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionPublisher_List (new)
Description :  Gets all Extension publishers based on the location
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/locations/{location}/publishers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extension publishers. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the extension publisher. ,
Required: False ,
}
string ,
name:
{
Description: The name of the extension publisher. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of extension publishers. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of compute operations ,
Required: False ,
}
[
{
origin:
{
Description: The origin of the compute operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
display:
{
Description: Display properties ,
Required: False ,
}
{
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: This property indicates if the operation is an action or a data action ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkProfile_Get (new)
Description :  The operation to get network information of hybrid machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/networkProfile
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
macAddress:
{
Description: Represents MAC address of the network interface. ,
Required: False ,
}
string ,
id:
{
Description: Represents the ID of the network interface. ,
Required: False ,
}
string ,
name:
{
Description: Represents the name of the network interface. ,
Required: False ,
}
string ,
ipAddresses:
{
Description: The list of IP addresses in this interface. ,
Required: False ,
}
[
{
address:
{
Description: Represents the IP Address. ,
Required: False ,
}
string ,
ipAddressVersion:
{
Description: Represents the Ip Address Version. ,
Required: False ,
}
string ,
subnet:
{
Description: The subnet to which this IP address belongs. ,
Required: False ,
}
{
addressPrefix:
{
Description: Represents address prefix. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_Get (new)
Description :  Implements HybridIdentityMetadata GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/hybridIdentityMetadata/{metadataName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
metadataName:
{
Description: Name of the HybridIdentityMetadata. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
vmId:
{
Description: The unique identifier for the resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: The Public Key. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
systemData:
{
Description: The system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridIdentityMetadata_ListByMachines (new)
Description :  Returns the list of HybridIdentityMetadata of the given machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/hybridIdentityMetadata
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Url to follow for getting next page of HybridIdentityMetadata. ,
Required: False ,
}
string ,
value:
{
Description: Array of HybridIdentityMetadata ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: True ,
}
{
vmId:
{
Description: The unique identifier for the resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: The Public Key. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
systemData:
{
Description: The system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentVersion_List (new)
Description :  Gets all Agent Versions along with the download link currently present.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/osType/{osType}/agentVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
osType:
{
Description: Defines the os type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available Agent Versions. ,
Required: False ,
}
[
{
agentVersion:
{
Description: Represents the agent version. ,
Required: False ,
}
string ,
downloadLink:
{
Description: Represents the download link of specific agent version. ,
Required: False ,
}
string ,
osType:
{
Description: Defines the os type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next 10 available Agent Versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentVersion_Get (new)
Description :  Gets an Agent Version along with the download link currently present.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/osType/{osType}/agentVersions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
osType:
{
Description: Defines the os type ,
Required: True ,
}
string ,
version:
{
Description: Defines the agent version. To get latest, use latest or else a specific agent version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
agentVersion:
{
Description: Represents the agent version. ,
Required: False ,
}
string ,
downloadLink:
{
Description: Represents the download link of specific agent version. ,
Required: False ,
}
string ,
osType:
{
Description: Defines the os type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineRunCommands_CreateOrUpdate (new)
Description :  The operation to create or update a run command.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the run command. ,
Required: True ,
}
string ,
runCommandProperties:
{
Description: Parameters supplied to the Create Run Command. ,
Required: True ,
}
{
properties:
{
Description: Describes Run Command Properties ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the machine. ,
Required: False ,
}
string ,
scriptUri:
{
Description: Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. ,
Required: False ,
}
string ,
commandId:
{
Description: Specifies the commandId of predefined built-in script. ,
Required: False ,
}
string ,
scriptUriManagedIdentity:
{
Description: User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
}
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
protectedParameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
asyncExecution:
{
Description: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the machine when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the machine when executing the run command. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: The timeout in seconds to execute the run command. ,
Format: int32 ,
Required: False ,
}
integer ,
outputBlobUri:
{
Description: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
errorBlobUri:
{
Description: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
outputBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
errorBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine run command instance view. ,
Required: False ,
}
{
executionState:
{
Description: Script execution status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
executionMessage:
{
Description: Communicate script configuration errors or execution messages. ,
Required: False ,
}
string ,
exitCode:
{
Description: Exit code returned from script execution. ,
Format: int32 ,
Required: False ,
}
integer ,
output:
{
Description: Script output stream. ,
Required: False ,
}
string ,
error:
{
Description: Script error stream. ,
Required: False ,
}
string ,
startTime:
{
Description: Script start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Script end time. ,
Format: date-time ,
Required: False ,
}
string ,
statuses:
{
Description: The status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Run Command Properties ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the machine. ,
Required: False ,
}
string ,
scriptUri:
{
Description: Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. ,
Required: False ,
}
string ,
commandId:
{
Description: Specifies the commandId of predefined built-in script. ,
Required: False ,
}
string ,
scriptUriManagedIdentity:
{
Description: User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
}
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
protectedParameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
asyncExecution:
{
Description: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the machine when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the machine when executing the run command. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: The timeout in seconds to execute the run command. ,
Format: int32 ,
Required: False ,
}
integer ,
outputBlobUri:
{
Description: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
errorBlobUri:
{
Description: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
outputBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
errorBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine run command instance view. ,
Required: False ,
}
{
executionState:
{
Description: Script execution status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
executionMessage:
{
Description: Communicate script configuration errors or execution messages. ,
Required: False ,
}
string ,
exitCode:
{
Description: Exit code returned from script execution. ,
Format: int32 ,
Required: False ,
}
integer ,
output:
{
Description: Script output stream. ,
Required: False ,
}
string ,
error:
{
Description: Script error stream. ,
Required: False ,
}
string ,
startTime:
{
Description: Script start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Script end time. ,
Format: date-time ,
Required: False ,
}
string ,
statuses:
{
Description: The status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}
,
$schema:
{
Description: Describes a Run Command ,
}
{
properties:
{
Description: Describes Run Command Properties ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the machine. ,
Required: False ,
}
string ,
scriptUri:
{
Description: Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. ,
Required: False ,
}
string ,
commandId:
{
Description: Specifies the commandId of predefined built-in script. ,
Required: False ,
}
string ,
scriptUriManagedIdentity:
{
Description: User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
}
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
protectedParameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
asyncExecution:
{
Description: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the machine when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the machine when executing the run command. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: The timeout in seconds to execute the run command. ,
Format: int32 ,
Required: False ,
}
integer ,
outputBlobUri:
{
Description: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
errorBlobUri:
{
Description: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
outputBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
errorBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine run command instance view. ,
Required: False ,
}
{
executionState:
{
Description: Script execution status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
executionMessage:
{
Description: Communicate script configuration errors or execution messages. ,
Required: False ,
}
string ,
exitCode:
{
Description: Exit code returned from script execution. ,
Format: int32 ,
Required: False ,
}
integer ,
output:
{
Description: Script output stream. ,
Required: False ,
}
string ,
error:
{
Description: Script error stream. ,
Required: False ,
}
string ,
startTime:
{
Description: Script start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Script end time. ,
Format: date-time ,
Required: False ,
}
string ,
statuses:
{
Description: The status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineRunCommands_Update (new)
Description :  The operation to update the run command.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the run command. ,
Required: True ,
}
string ,
runCommandProperties:
{
Description: Parameters supplied to the Create Run Command. ,
Required: True ,
}
object ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Run Command Properties ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the machine. ,
Required: False ,
}
string ,
scriptUri:
{
Description: Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. ,
Required: False ,
}
string ,
commandId:
{
Description: Specifies the commandId of predefined built-in script. ,
Required: False ,
}
string ,
scriptUriManagedIdentity:
{
Description: User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
}
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
protectedParameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
asyncExecution:
{
Description: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the machine when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the machine when executing the run command. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: The timeout in seconds to execute the run command. ,
Format: int32 ,
Required: False ,
}
integer ,
outputBlobUri:
{
Description: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
errorBlobUri:
{
Description: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
outputBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
errorBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine run command instance view. ,
Required: False ,
}
{
executionState:
{
Description: Script execution status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
executionMessage:
{
Description: Communicate script configuration errors or execution messages. ,
Required: False ,
}
string ,
exitCode:
{
Description: Exit code returned from script execution. ,
Format: int32 ,
Required: False ,
}
integer ,
output:
{
Description: Script output stream. ,
Required: False ,
}
string ,
error:
{
Description: Script error stream. ,
Required: False ,
}
string ,
startTime:
{
Description: Script start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Script end time. ,
Format: date-time ,
Required: False ,
}
string ,
statuses:
{
Description: The status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineRunCommands_Delete (new)
Description :  The operation to delete a run command.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the run command. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineRunCommands_Get (new)
Description :  The operation to get a run command.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the run command. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Run Command Properties ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the machine. ,
Required: False ,
}
string ,
scriptUri:
{
Description: Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. ,
Required: False ,
}
string ,
commandId:
{
Description: Specifies the commandId of predefined built-in script. ,
Required: False ,
}
string ,
scriptUriManagedIdentity:
{
Description: User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
}
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
protectedParameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
asyncExecution:
{
Description: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the machine when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the machine when executing the run command. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: The timeout in seconds to execute the run command. ,
Format: int32 ,
Required: False ,
}
integer ,
outputBlobUri:
{
Description: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
errorBlobUri:
{
Description: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
outputBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
errorBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine run command instance view. ,
Required: False ,
}
{
executionState:
{
Description: Script execution status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
executionMessage:
{
Description: Communicate script configuration errors or execution messages. ,
Required: False ,
}
string ,
exitCode:
{
Description: Exit code returned from script execution. ,
Format: int32 ,
Required: False ,
}
integer ,
output:
{
Description: Script output stream. ,
Required: False ,
}
string ,
error:
{
Description: Script error stream. ,
Required: False ,
}
string ,
startTime:
{
Description: Script start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Script end time. ,
Format: date-time ,
Required: False ,
}
string ,
statuses:
{
Description: The status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineRunCommands_List (new)
Description :  The operation to get all the run commands of a non-Azure machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of run commands ,
Required: False ,
}
[
{
properties:
{
Description: Describes Run Command Properties ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the machine. ,
Required: False ,
}
string ,
scriptUri:
{
Description: Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. ,
Required: False ,
}
string ,
commandId:
{
Description: Specifies the commandId of predefined built-in script. ,
Required: False ,
}
string ,
scriptUriManagedIdentity:
{
Description: User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
}
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
protectedParameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
asyncExecution:
{
Description: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the machine when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the machine when executing the run command. ,
Required: False ,
}
string ,
timeoutInSeconds:
{
Description: The timeout in seconds to execute the run command. ,
Format: int32 ,
Required: False ,
}
integer ,
outputBlobUri:
{
Description: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
errorBlobUri:
{
Description: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. ,
Required: False ,
}
string ,
outputBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
errorBlobManagedIdentity:
{
Description: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged ,
Required: False ,
}
{
clientId:
{
Description: Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. ,
Required: False ,
}
string ,
objectId:
{
Description: Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine run command instance view. ,
Required: False ,
}
{
executionState:
{
Description: Script execution status. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Running: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
executionMessage:
{
Description: Communicate script configuration errors or execution messages. ,
Required: False ,
}
string ,
exitCode:
{
Description: Exit code returned from script execution. ,
Format: int32 ,
Required: False ,
}
integer ,
output:
{
Description: Script output stream. ,
Required: False ,
}
string ,
error:
{
Description: Script error stream. ,
Required: False ,
}
string ,
startTime:
{
Description: Script start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Script end time. ,
Format: date-time ,
Required: False ,
}
string ,
statuses:
{
Description: The status information. ,
Required: False ,
}
[
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_CreateOrUpdate (new)
Description :  The operation to create or update a gateway.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the Gateway. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create gateway operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}
,
$schema:
{
Description: Describes an Arc Gateway. ,
}
{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_Update (new)
Description :  The operation to update a gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the Gateway. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update gateway operation. ,
Required: True ,
}
{
properties:
{
Description: Gateway Update properties ,
Required: False ,
}
{
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_Get (new)
Description :  Retrieves information about the view of a gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the Gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_Delete (new)
Description :  The operation to delete a gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: The name of the Gateway. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_ListByResourceGroup (new)
Description :  The operation to get all gateways of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Gateways. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Gateways. Call ListNext() with this URI to fetch the next page of Gateways. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_ListBySubscription (new)
Description :  The operation to get all gateways of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/gateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Gateways. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Gateway properties ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayId:
{
Description: A unique, immutable, identifier for the Gateway. ,
Required: False ,
}
string ,
gatewayType:
{
Description: The type of the Gateway resource. ,
Enum:
{
Public: No description available. ,
}
,
Required: False ,
}
enum ,
gatewayEndpoint:
{
Description: The endpoint fqdn for the Gateway. ,
Required: False ,
}
string ,
allowedFeatures:
{
Description: Specifies the list of features that are enabled for this Gateway. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Gateways. Call ListNext() with this URI to fetch the next page of Gateways. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Settings_Get (new)
Description :  Returns the base Settings for the target resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
baseProvider:
{
Description: The name of the base Resource Provider. ,
Required: True ,
}
string ,
baseResourceType:
{
Description: The name of the base Resource Type. ,
Required: True ,
}
string ,
baseResourceName:
{
Description: The name of the base resource. ,
Required: True ,
}
string ,
settingsResourceName:
{
Description: The name of the settings resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Settings properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
gatewayProperties:
{
Description: Settings Gateway properties ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Associated Gateway Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Settings_Update (new)
Description :  Updates the base Settings of the target resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
baseProvider:
{
Description: The name of the base Resource Provider. ,
Required: True ,
}
string ,
baseResourceType:
{
Description: The name of the base Resource Type. ,
Required: True ,
}
string ,
baseResourceName:
{
Description: The name of the base resource. ,
Required: True ,
}
string ,
settingsResourceName:
{
Description: The name of the settings resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Settings details ,
Required: True ,
}
{
properties:
{
Description: Settings properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
gatewayProperties:
{
Description: Settings Gateway properties ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Associated Gateway Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Settings properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
gatewayProperties:
{
Description: Settings Gateway properties ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Associated Gateway Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Settings properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
gatewayProperties:
{
Description: Settings Gateway properties ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Associated Gateway Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Settings_Patch (new)
Description :  Update the base Settings of the target resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
baseProvider:
{
Description: The name of the base Resource Provider. ,
Required: True ,
}
string ,
baseResourceType:
{
Description: The name of the base Resource Type. ,
Required: True ,
}
string ,
baseResourceName:
{
Description: The name of the base resource. ,
Required: True ,
}
string ,
settingsResourceName:
{
Description: The name of the settings resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Settings details ,
Required: True ,
}
{
properties:
{
Description: Settings properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
gatewayProperties:
{
Description: Settings Gateway properties ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Associated Gateway Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Settings properties ,
Required: False ,
}
{
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
gatewayProperties:
{
Description: Settings Gateway properties ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Associated Gateway Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SetupExtensions (new)
Description :  The operation to Setup Machine Extensions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/addExtensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
extensions:
{
Description: Parameters supplied to the Setup Extensions operation. ,
Required: True ,
}
{
extensions:
{
Description: The list of extensions ,
Required: False ,
}
[
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
extensions:
{
Description: The list of extensions ,
Required: False ,
}
[
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_List (new)
Description :  Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Arc PrivateLinkScope definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_ListByResourceGroup (new)
Description :  Gets a list of Azure Arc PrivateLinkScopes within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Arc PrivateLinkScope definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_Delete (new)
Description :  Deletes a Azure Arc PrivateLinkScope.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_Get (new)
Description :  Returns a Azure Arc PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_CreateOrUpdate (new)
Description :  Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope. ,
Required: True ,
}
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_UpdateTags (new)
Description :  Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
PrivateLinkScopeTags:
{
Description: Updated tag information to set into the PrivateLinkScope instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByPrivateLinkScope (new)
Description :  Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByPrivateLinkScope (new)
Description :  Gets all private endpoint connections on a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_GetValidationDetails (new)
Description :  Returns a Azure Arc PrivateLinkScope's validation details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}
{
location:
{
Description: The location of the target resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateLinkScopeId:
{
Description: The id (Guid) of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
connectionDetails:
{
Description: List of Private Endpoint Connection details. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private endpoint connection private ip address ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: The private endpoint connection link identifier ,
Required: False ,
}
string ,
groupId:
{
Description: The private endpoint connection group id ,
Required: False ,
}
string ,
memberName:
{
Description: The private endpoint connection member name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_GetValidationDetailsForMachine (new)
Description :  Returns a Azure Arc PrivateLinkScope's validation details for a given machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the target machine to get the private link scope validation details for. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
connectionDetails:
{
Description: List of Private Endpoint Connection details. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private endpoint connection private ip address ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: The private endpoint connection link identifier ,
Required: False ,
}
string ,
groupId:
{
Description: The private endpoint connection group id ,
Required: False ,
}
string ,
memberName:
{
Description: The private endpoint connection member name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkConfigurations_Get (new)
Description :  Returns a NetworkConfiguration for the target resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.HybridCompute/networkConfigurations/current
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the target machine to get the private link scope validation details for. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Network configuration properties ,
Required: False ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
networkConfigurationScopeId:
{
Description: Associated Network Configuration Scope Id (GUID) ,
Required: False ,
}
string ,
networkConfigurationScopeResourceId:
{
Description: Associated Network Configuration Scope Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
keyProperties:
{
Description: Public key information for client authentication ,
Required: False ,
}
{
clientPublicKey:
{
Description: Current public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
candidatePublicKey:
{
Description: Candidate public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkConfigurations_CreateOrUpdate (new)
Description :  Create or update the NetworkConfiguration of the target resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.HybridCompute/networkConfigurations/current
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the target machine to get the private link scope validation details for. ,
Required: True ,
}
string ,
parameters:
{
Description: Network Configuration details ,
Required: True ,
}
{
properties:
{
Description: Network configuration properties ,
Required: False ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
networkConfigurationScopeId:
{
Description: Associated Network Configuration Scope Id (GUID) ,
Required: False ,
}
string ,
networkConfigurationScopeResourceId:
{
Description: Associated Network Configuration Scope Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
keyProperties:
{
Description: Public key information for client authentication ,
Required: False ,
}
{
clientPublicKey:
{
Description: Current public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
candidatePublicKey:
{
Description: Candidate public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Network configuration properties ,
Required: False ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
networkConfigurationScopeId:
{
Description: Associated Network Configuration Scope Id (GUID) ,
Required: False ,
}
string ,
networkConfigurationScopeResourceId:
{
Description: Associated Network Configuration Scope Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
keyProperties:
{
Description: Public key information for client authentication ,
Required: False ,
}
{
clientPublicKey:
{
Description: Current public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
candidatePublicKey:
{
Description: Candidate public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Network configuration properties ,
Required: False ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
networkConfigurationScopeId:
{
Description: Associated Network Configuration Scope Id (GUID) ,
Required: False ,
}
string ,
networkConfigurationScopeResourceId:
{
Description: Associated Network Configuration Scope Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
keyProperties:
{
Description: Public key information for client authentication ,
Required: False ,
}
{
clientPublicKey:
{
Description: Current public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
candidatePublicKey:
{
Description: Candidate public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkConfigurations_Update (new)
Description :  Update the endpoint to the target resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.HybridCompute/networkConfigurations/current
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the target machine to get the private link scope validation details for. ,
Required: True ,
}
string ,
parameters:
{
Description: Network Configuration details ,
Required: True ,
}
{
properties:
{
Description: Network configuration properties ,
Required: False ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
networkConfigurationScopeId:
{
Description: Associated Network Configuration Scope Id (GUID) ,
Required: False ,
}
string ,
networkConfigurationScopeResourceId:
{
Description: Associated Network Configuration Scope Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
keyProperties:
{
Description: Public key information for client authentication ,
Required: False ,
}
{
clientPublicKey:
{
Description: Current public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
candidatePublicKey:
{
Description: Candidate public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Network configuration properties ,
Required: False ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
tenantId:
{
Description: Azure resource tenant Id ,
Required: False ,
}
string ,
networkConfigurationScopeId:
{
Description: Associated Network Configuration Scope Id (GUID) ,
Required: False ,
}
string ,
networkConfigurationScopeResourceId:
{
Description: Associated Network Configuration Scope Resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
keyProperties:
{
Description: Public key information for client authentication ,
Required: False ,
}
{
clientPublicKey:
{
Description: Current public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
candidatePublicKey:
{
Description: Candidate public key details ,
Required: False ,
}
{
publicKey:
{
Description: Public key ,
Required: False ,
}
string ,
notAfter:
{
Description: Key expiration date ,
Format: date-time ,
Required: False ,
}
string ,
renewAfter:
{
Description: Recommended key renewal date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_GetByPrivateLinkScope (new)
Description :  Gets the network security perimeter configuration for a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
perimeterName:
{
Description: The name, in the format {perimeterGuid}.{associationName}, of the Network Security Perimeter resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
name:
{
Description: Azure resource name ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: Properties that define a Network Security Perimeter resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Current state of this NetworkSecurityPerimeter: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
provisioningIssues:
{
Description: Provisioning issues. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provisioning issue. ,
Required: False ,
}
string ,
properties:
{
Description: Provisioning issue properties ,
Required: False ,
}
{
issueType:
{
Description: Issue type ,
Enum:
{
MissingPerimeterConfiguration: Perimeter configuration is missing. ,
MissingIdentityConfiguration: Identity configuration is missing. ,
ConfigurationPropagationFailure: Configuration failed to propagate. ,
Other: Other failure. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the provisioning issue. ,
Enum:
{
Warning: Warnings can cause connectivity issues after provisioning succeeds. ,
Error: Errors will cause association provisioning to fail. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the provisioning issue. ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM Ids of the resources that can be associated to the same perimeter to remediate the issue ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the perimeter to remediate the issue ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule. ,
Required: False ,
}
string ,
properties:
{
Description: Access rule properties ,
Required: False ,
}
{
direction:
{
Description: Direction of the access rule. ,
Enum:
{
Inbound: Traffic originates outside of network. ,
Outbound: Traffic originates inside the network ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes that are allowed access. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: The Network Security Perimeter associated with this configuration. ,
Required: False ,
}
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Regional location of the perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: The Resource Association. ,
Required: False ,
}
{
name:
{
Description: Name of the Resource Association ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode ,
Enum:
{
enforced: Indicates that resource access is controlled by the NSP definition. ,
audit: Dry run mode, where traffic is evaluated against NSP Rules, logged but not enforced. ,
learning: Enables traffic evaluation to fall back to resource-specific firewall configurations. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network Security Perimeter profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Access rules version number ,
Format: int32 ,
Required: False ,
}
integer ,
accessRules:
{
Description: Collection of access rules for the profile ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule. ,
Required: False ,
}
string ,
properties:
{
Description: Access rule properties ,
Required: False ,
}
{
direction:
{
Description: Direction of the access rule. ,
Enum:
{
Inbound: Traffic originates outside of network. ,
Outbound: Traffic originates inside the network ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes that are allowed access. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version number ,
Format: int32 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: Collection of enabled log categories for the profile ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_ListByPrivateLinkScope (new)
Description :  Lists the network security perimeter configurations for a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
name:
{
Description: Azure resource name ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: Properties that define a Network Security Perimeter resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Current state of this NetworkSecurityPerimeter: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
provisioningIssues:
{
Description: Provisioning issues. ,
Required: False ,
}
[
{
name:
{
Description: Name of the provisioning issue. ,
Required: False ,
}
string ,
properties:
{
Description: Provisioning issue properties ,
Required: False ,
}
{
issueType:
{
Description: Issue type ,
Enum:
{
MissingPerimeterConfiguration: Perimeter configuration is missing. ,
MissingIdentityConfiguration: Identity configuration is missing. ,
ConfigurationPropagationFailure: Configuration failed to propagate. ,
Other: Other failure. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the provisioning issue. ,
Enum:
{
Warning: Warnings can cause connectivity issues after provisioning succeeds. ,
Error: Errors will cause association provisioning to fail. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the provisioning issue. ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: ARM Ids of the resources that can be associated to the same perimeter to remediate the issue ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the perimeter to remediate the issue ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule. ,
Required: False ,
}
string ,
properties:
{
Description: Access rule properties ,
Required: False ,
}
{
direction:
{
Description: Direction of the access rule. ,
Enum:
{
Inbound: Traffic originates outside of network. ,
Outbound: Traffic originates inside the network ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes that are allowed access. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: The Network Security Perimeter associated with this configuration. ,
Required: False ,
}
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the Network Security Perimeter ,
Required: False ,
}
string ,
location:
{
Description: Regional location of the perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: The Resource Association. ,
Required: False ,
}
{
name:
{
Description: Name of the Resource Association ,
Required: False ,
}
string ,
accessMode:
{
Description: The access mode ,
Enum:
{
enforced: Indicates that resource access is controlled by the NSP definition. ,
audit: Dry run mode, where traffic is evaluated against NSP Rules, logged but not enforced. ,
learning: Enables traffic evaluation to fall back to resource-specific firewall configurations. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network Security Perimeter profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Access rules version number ,
Format: int32 ,
Required: False ,
}
integer ,
accessRules:
{
Description: Collection of access rules for the profile ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule. ,
Required: False ,
}
string ,
properties:
{
Description: Access rule properties ,
Required: False ,
}
{
direction:
{
Description: Direction of the access rule. ,
Enum:
{
Inbound: Traffic originates outside of network. ,
Outbound: Traffic originates inside the network ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes that are allowed access. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version number ,
Format: int32 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: Collection of enabled log categories for the profile ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_ReconcileForPrivateLinkScope (new)
Description :  Forces the network security perimeter configuration to refresh for a private link scope.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}/reconcile
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
perimeterName:
{
Description: The name, in the format {perimeterGuid}.{associationName}, of the Network Security Perimeter resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}