Microsoft.Compute (stable:2024-11-01)

2025/03/10 • 184 new methods

AvailabilitySets_CreateOrUpdate (new)
Description :  Create or update an availability set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Availability Set operation. ,
Required: True ,
}
{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_Update (new)
Description :  Update an availability set.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Availability Set operation. ,
Required: True ,
}
{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_Delete (new)
Description :  Delete an availability set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_Get (new)
Description :  Retrieves information about an availability set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_ListBySubscription (new)
Description :  Lists all availability sets in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply to the operation. Allowed values are 'virtualMachines/$ref'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availability sets ,
Required: True ,
}
[
{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_List (new)
Description :  Lists all availability sets in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availability sets ,
Required: True ,
}
[
{
properties:
{
Description: The instance view of a resource. ,
Required: False ,
}
{
platformUpdateDomainCount:
{
Description: Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomainCount:
{
Description: Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachines:
{
Description: A list of references to all virtual machines in the availability set. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. ,
Required: False ,
}
{
userInitiatedRedeploy:
{
Description: The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Redeploy Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
userInitiatedReboot:
{
Description: The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. ,
Required: False ,
}
{
automaticallyApprove:
{
Description: Specifies Reboot Scheduled Event related configurations. ,
Required: False ,
}
boolean ,
}
,
scheduledEventsAdditionalPublishingTargets:
{
Description: The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. ,
Required: False ,
}
{
eventGridAndResourceGraph:
{
Description: The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. ,
Required: False ,
}
{
enable:
{
Description: Specifies if event grid and resource graph is enabled for Scheduled event related configurations. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
virtualMachineScaleSetMigrationInfo:
{
Description: Describes the migration properties on the Availability Set. ,
Required: False ,
}
{
defaultVirtualMachineScaleSetInfo:
{
Description: Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
constrainedMaximumCapacity:
{
Description: Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. ,
Required: False ,
}
boolean ,
defaultVirtualMachineScaleSet:
{
Description: The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
migrateToVirtualMachineScaleSet:
{
Description: Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_ListAvailableSizes (new)
Description :  Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machine sizes. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine size. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskSizeInMB:
{
Description: The OS disk size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceDiskSizeInMB:
{
Description: The resource disk size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryInMB:
{
Description: The amount of memory, in MB, supported by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDataDiskCount:
{
Description: The maximum number of data disks that can be attached to the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_StartMigrationToVirtualMachineScaleSet (new)
Description :  Start migration operation on an Availability Set to move its Virtual Machines to a Virtual Machine Scale Set. This should be followed by a migrate operation on each Virtual Machine that triggers a downtime on the Virtual Machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/startMigrationToVirtualMachineScaleSet
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the migrate operation on the availability set. ,
Required: True ,
}
{
virtualMachineScaleSetFlexible:
{
Description: Specifies information about the Virtual Machine Scale Set that the Availability Set should be migrated to. Minimum api‐version: 2024‐11‐01. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_CancelMigrationToVirtualMachineScaleSet (new)
Description :  Cancel the migration operation on an Availability Set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/cancelMigrationToVirtualMachineScaleSet
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_ValidateMigrationToVirtualMachineScaleSet (new)
Description :  Validates that the Virtual Machines in the Availability Set can be migrated to the provided Virtual Machine Scale Set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/validateMigrationToVirtualMachineScaleSet
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the migrate operation on the availability set. ,
Required: True ,
}
{
virtualMachineScaleSetFlexible:
{
Description: Specifies information about the Virtual Machine Scale Set that the Availability Set should be migrated to. Minimum api‐version: 2024‐11‐01. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
AvailabilitySets_ConvertToVirtualMachineScaleSet (new)
Description :  Create a new Flexible Virtual Machine Scale Set and migrate all the Virtual Machines in the Availability Set. This does not trigger a downtime on the Virtual Machines.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/convertToVirtualMachineScaleSet
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
availabilitySetName:
{
Description: The name of the availability set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the migrate operation on the availability set. ,
Required: False ,
}
{
virtualMachineScaleSetName:
{
Description: Specifies information about the Virtual Machine Scale Set that the Availability Set should be converted to. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservationGroups_CreateOrUpdate (new)
Description :  The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create capacity reservation Group. ,
Required: True ,
}
{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservationGroups_Update (new)
Description :  The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update capacity reservation Group operation. ,
Required: True ,
}
{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservationGroups_Delete (new)
Description :  The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservationGroups_Get (new)
Description :  The operation that retrieves information about a capacity reservation group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservationGroups_ListByResourceGroup (new)
Description :  Lists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity reservation groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of capacity reservation groups ,
Required: True ,
}
[
{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservationGroups_ListBySubscription (new)
Description :  Lists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response. ,
Required: False ,
}
string ,
resourceIdsOnly:
{
Description: The query option to fetch Capacity Reservation Group Resource Ids.
'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription.
'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription.
'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of capacity reservation groups ,
Required: True ,
}
[
{
properties:
{
Description: capacity reservation group Properties. ,
Required: False ,
}
{
capacityReservations:
{
Description: A list of all capacity reservation resource ids that belong to capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualMachinesAssociated:
{
Description: A list of references to all virtual machines associated to the capacity reservation group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. ,
Required: False ,
}
{
capacityReservations:
{
Description: List of instance view of the capacity reservations under the capacity reservation group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the capacity reservation. ,
Required: False ,
}
string ,
}
,
]
,
sharedSubscriptionIds:
{
Description: List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
sharingProfile:
{
Description: Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
{
subscriptionIds:
{
Description: Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
zones:
{
Description: Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservations_CreateOrUpdate (new)
Description :  The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. Please refer to https://aka.ms/CapacityReservation for more details.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
capacityReservationName:
{
Description: The name of the capacity reservation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create capacity reservation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservations_Update (new)
Description :  The operation to update a capacity reservation.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
capacityReservationName:
{
Description: The name of the capacity reservation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update capacity reservation operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservations_Delete (new)
Description :  The operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. Please refer to https://aka.ms/CapacityReservation for more details.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
capacityReservationName:
{
Description: The name of the capacity reservation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservations_Get (new)
Description :  The operation that retrieves information about the capacity reservation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
capacityReservationName:
{
Description: The name of the capacity reservation. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CapacityReservations_ListByCapacityReservationGroup (new)
Description :  Lists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity reservations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of capacity reservations ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the Capacity reservation. ,
Required: False ,
}
{
reservationId:
{
Description: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. ,
Required: False ,
}
string ,
platformFaultDomainCount:
{
Description: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAssociated:
{
Description: A list of all virtual machine resource ids that are associated with the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
provisioningTime:
{
Description: The date time when the capacity reservation was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The Capacity reservation instance view. ,
Required: False ,
}
{
utilizationInfo:
{
Description: Unutilized capacity of the capacity reservation. ,
Required: False ,
}
{
currentCapacity:
{
Description: The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualMachinesAllocated:
{
Description: A list of all virtual machines resource ids allocated against the capacity reservation. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
zones:
{
Description: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Gets a list of compute operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Compute/operations
{
api-version:
{
Description: Client Api Version. ,
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: Describes the properties of a Compute Operation Value Display. ,
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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Usage_List (new)
Description :  Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages
{
location:
{
Description: The location for which resource usage is queried. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of compute resource usages. ,
Required: True ,
}
[
{
unit:
{
Description: An enum describing the unit of usage measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current usage of the resource. ,
Format: int32 ,
Required: True ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineSizes_List (new)
Description :  This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes
{
location:
{
Description: The location upon which virtual-machine-sizes is queried. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machine sizes. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine size. ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskSizeInMB:
{
Description: The OS disk size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
resourceDiskSizeInMB:
{
Description: The resource disk size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryInMB:
{
Description: The amount of memory, in MB, supported by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDataDiskCount:
{
Description: The maximum number of data disks that can be attached to the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHostGroups_CreateOrUpdate (new)
Description :  Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Dedicated Host Group. ,
Required: True ,
}
{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHostGroups_Update (new)
Description :  Update an dedicated host group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Dedicated Host Group operation. ,
Required: True ,
}
{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHostGroups_Delete (new)
Description :  Delete a dedicated host group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHostGroups_Get (new)
Description :  Retrieves information about a dedicated host group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHostGroups_ListByResourceGroup (new)
Description :  Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated host groups ,
Required: True ,
}
[
{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHostGroups_ListBySubscription (new)
Description :  Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated host groups ,
Required: True ,
}
[
{
properties:
{
Description: Dedicated Host Group Properties. ,
Required: False ,
}
{
platformFaultDomainCount:
{
Description: Number of fault domains that the host group can span. ,
Format: int32 ,
Required: True ,
}
integer ,
hosts:
{
Description: A list of references to all dedicated hosts in the dedicated host group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
instanceView:
{
Description: The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
{
hosts:
{
Description: List of instance view of the dedicated hosts under the dedicated host group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dedicated host. ,
Required: False ,
}
string ,
}
,
]
,
}
,
supportAutomaticPlacement:
{
Description: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. ,
Required: False ,
}
boolean ,
}
,
}
,
zones:
{
Description: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_CreateOrUpdate (new)
Description :  Create or update a dedicated host .
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host . ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Dedicated Host. ,
Required: True ,
}
{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_Update (new)
Description :  Update a dedicated host .
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host . ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Dedicated Host operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: [List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_Delete (new)
Description :  Delete a dedicated host.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_Get (new)
Description :  Retrieves information about a dedicated host.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_ListByHostGroup (new)
Description :  Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated hosts ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the dedicated host. ,
Required: False ,
}
{
platformFaultDomain:
{
Description: Fault domain of the dedicated host within a dedicated host group. ,
Format: int32 ,
Required: False ,
}
integer ,
autoReplaceOnFailure:
{
Description: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. ,
Required: False ,
}
boolean ,
hostId:
{
Description: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. ,
Required: False ,
}
string ,
virtualMachines:
{
Description: A list of references to all virtual machines in the Dedicated Host. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
licenseType:
{
Description: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** ,
Enum:
{
None: No description available. ,
Windows_Server_Hybrid: No description available. ,
Windows_Server_Perpetual: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningTime:
{
Description: The date when the host was first provisioned. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The dedicated host instance view. ,
Required: False ,
}
{
assetId:
{
Description: Specifies the unique id of the dedicated physical machine on which the dedicated host resides. ,
Required: False ,
}
string ,
availableCapacity:
{
Description: Unutilized capacity of the dedicated host. ,
Required: False ,
}
{
allocatableVMs:
{
Description: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. ,
Required: False ,
}
[
{
vmSize:
{
Description: VM size in terms of which the unutilized capacity is represented. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
statuses:
{
Description: The resource 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 ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. ,
Required: True ,
}
{
name:
{
Description: The sku name. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_Restart (new)
Description :  Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/restart
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_Redeploy (new)
Description :  Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/redeploy
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
DedicatedHosts_ListAvailableSizes (new)
Description :  Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing dedicated host.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
hostGroupName:
{
Description: The name of the dedicated host group. ,
Required: True ,
}
string ,
hostName:
{
Description: The name of the dedicated host. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of dedicated host sizes. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Images_CreateOrUpdate (new)
Description :  Create or update an image.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Image operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Images_Update (new)
Description :  Update an image.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Image operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Images_Delete (new)
Description :  Deletes an Image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Images_Get (new)
Description :  Gets an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
imageName:
{
Description: The name of the image. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Images_ListByResourceGroup (new)
Description :  Gets the list of images under a resource group. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Images_List (new)
Description :  Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/images
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of an Image. ,
Required: False ,
}
{
sourceVirtualMachine:
{
Description: The source virtual machine from which Image is created. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: The OS State. For managed images, use Generalized. ,
Enum:
{
Generalized: Generalized image. Needs to be provisioned during deployment time. ,
Specialized: Specialized image. Contains already provisioned OS Disk. ,
}
,
Required: True ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
zoneResilient:
{
Description: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location of the Image. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_ExportRequestRateByInterval (new)
Description :  Export logs that show Api requests made by this subscription in the given time window to show throttling activities.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval
{
parameters:
{
Description: Parameters supplied to the LogAnalytics getRequestRateByInterval Api. ,
Required: True ,
}
{
intervalLength:
{
Description: Interval value in minutes used to create LogAnalytics call rate logs. ,
Enum:
{
ThreeMins: No description available. ,
FiveMins: No description available. ,
ThirtyMins: No description available. ,
SixtyMins: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
location:
{
Description: The location upon which virtual-machine-sizes is queried. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: LogAnalyticsOutput ,
Required: False ,
}
{
output:
{
Description: Output file Uri path to blob container. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_ExportThrottledRequests (new)
Description :  Export logs that show total throttled Api requests for this subscription in the given time window.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests
{
parameters:
{
Description: Parameters supplied to the LogAnalytics getThrottledRequests Api. ,
Required: True ,
}
string ,
location:
{
Description: The location upon which virtual-machine-sizes is queried. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: LogAnalyticsOutput ,
Required: False ,
}
{
output:
{
Description: Output file Uri path to blob container. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ProximityPlacementGroups_CreateOrUpdate (new)
Description :  Create or update a proximity placement group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
proximityPlacementGroupName:
{
Description: The name of the proximity placement group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create Proximity Placement Group operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ProximityPlacementGroups_Update (new)
Description :  Update a proximity placement group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
proximityPlacementGroupName:
{
Description: The name of the proximity placement group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Proximity Placement Group operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ProximityPlacementGroups_Delete (new)
Description :  Delete a proximity placement group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
proximityPlacementGroupName:
{
Description: The name of the proximity placement group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ProximityPlacementGroups_Get (new)
Description :  Retrieves information about a proximity placement group .
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
proximityPlacementGroupName:
{
Description: The name of the proximity placement group. ,
Required: True ,
}
string ,
includeColocationStatus:
{
Description: includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ProximityPlacementGroups_ListBySubscription (new)
Description :  Lists all proximity placement groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of proximity placement groups ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of proximity placement groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
ProximityPlacementGroups_ListByResourceGroup (new)
Description :  Lists all proximity placement groups in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of proximity placement groups ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Proximity Placement Group. ,
Required: False ,
}
{
proximityPlacementGroupType:
{
Description: Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. ,
Enum:
{
Standard: No description available. ,
Ultra: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachines:
{
Description: A list of references to all virtual machines in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
virtualMachineScaleSets:
{
Description: A list of references to all virtual machine scale sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
availabilitySets:
{
Description: A list of references to all availability sets in the proximity placement group. ,
Required: False ,
}
[
{
colocationStatus:
{
Description: Describes colocation status of a resource in the Proximity Placement Group. ,
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 ,
}
,
}
,
]
,
colocationStatus:
{
Description: Describes colocation status of the Proximity Placement Group. ,
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 ,
}
,
intent:
{
Description: Specifies the user intent of the proximity placement group. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies possible sizes of virtual machines that can be created in the proximity placement group. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
zones:
{
Description: Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of proximity placement groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePointCollections_CreateOrUpdate (new)
Description :  The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create or Update restore point collection operation. ,
Required: True ,
}
{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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)

{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePointCollections_Update (new)
Description :  The operation to update the restore point collection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update restore point collection operation. ,
Required: True ,
}
{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePointCollections_Delete (new)
Description :  The operation to delete the restore point collection. This operation will also delete all the contained restore points.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the Restore Point Collection. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePointCollections_Get (new)
Description :  The operation to get the restore point collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePointCollections_List (new)
Description :  Gets the list of restore point collections in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of restore point collections. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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 RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePointCollections_ListAll (new)
Description :  Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of restore point collections. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point collection properties. ,
Required: False ,
}
{
source:
{
Description: The properties of the source resource that this restore point collection is created from. ,
Required: False ,
}
{
location:
{
Description: Location of the source resource used to create this restore point collection. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the source resource used to create this restore point collection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the restore point collection. ,
Required: False ,
}
string ,
restorePointCollectionId:
{
Description: The unique id of the restore point collection. ,
Required: False ,
}
string ,
restorePoints:
{
Description: A list containing all restore points created under this restore point collection. ,
Required: False ,
}
[
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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 RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePoints_Create (new)
Description :  The operation to create the restore point. Updating properties of an existing restore point is not allowed
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection. ,
Required: True ,
}
string ,
restorePointName:
{
Description: The name of the restore point. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create restore point operation. ,
Required: True ,
}
{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePoints_Delete (new)
Description :  The operation to delete the restore point.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the Restore Point Collection. ,
Required: True ,
}
string ,
restorePointName:
{
Description: The name of the restore point. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
RestorePoints_Get (new)
Description :  The operation to get the restore point.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
restorePointCollectionName:
{
Description: The name of the restore point collection. ,
Required: True ,
}
string ,
restorePointName:
{
Description: The name of the restore point. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The restore point properties. ,
Required: False ,
}
{
excludeDisks:
{
Description: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. ,
Required: False ,
}
[
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
]
,
sourceMetadata:
{
Description: Gets the details of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Gets the hardware profile. ,
Required: False ,
}
{
vmSize:
{
Description: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. ,
Enum:
{
Basic_A0: No description available. ,
Basic_A1: No description available. ,
Basic_A2: No description available. ,
Basic_A3: No description available. ,
Basic_A4: No description available. ,
Standard_A0: No description available. ,
Standard_A1: No description available. ,
Standard_A2: No description available. ,
Standard_A3: No description available. ,
Standard_A4: No description available. ,
Standard_A5: No description available. ,
Standard_A6: No description available. ,
Standard_A7: No description available. ,
Standard_A8: No description available. ,
Standard_A9: No description available. ,
Standard_A10: No description available. ,
Standard_A11: No description available. ,
Standard_A1_v2: No description available. ,
Standard_A2_v2: No description available. ,
Standard_A4_v2: No description available. ,
Standard_A8_v2: No description available. ,
Standard_A2m_v2: No description available. ,
Standard_A4m_v2: No description available. ,
Standard_A8m_v2: No description available. ,
Standard_B1s: No description available. ,
Standard_B1ms: No description available. ,
Standard_B2s: No description available. ,
Standard_B2ms: No description available. ,
Standard_B4ms: No description available. ,
Standard_B8ms: No description available. ,
Standard_D1: No description available. ,
Standard_D2: No description available. ,
Standard_D3: No description available. ,
Standard_D4: No description available. ,
Standard_D11: No description available. ,
Standard_D12: No description available. ,
Standard_D13: No description available. ,
Standard_D14: No description available. ,
Standard_D1_v2: No description available. ,
Standard_D2_v2: No description available. ,
Standard_D3_v2: No description available. ,
Standard_D4_v2: No description available. ,
Standard_D5_v2: No description available. ,
Standard_D2_v3: No description available. ,
Standard_D4_v3: No description available. ,
Standard_D8_v3: No description available. ,
Standard_D16_v3: No description available. ,
Standard_D32_v3: No description available. ,
Standard_D64_v3: No description available. ,
Standard_D2s_v3: No description available. ,
Standard_D4s_v3: No description available. ,
Standard_D8s_v3: No description available. ,
Standard_D16s_v3: No description available. ,
Standard_D32s_v3: No description available. ,
Standard_D64s_v3: No description available. ,
Standard_D11_v2: No description available. ,
Standard_D12_v2: No description available. ,
Standard_D13_v2: No description available. ,
Standard_D14_v2: No description available. ,
Standard_D15_v2: No description available. ,
Standard_DS1: No description available. ,
Standard_DS2: No description available. ,
Standard_DS3: No description available. ,
Standard_DS4: No description available. ,
Standard_DS11: No description available. ,
Standard_DS12: No description available. ,
Standard_DS13: No description available. ,
Standard_DS14: No description available. ,
Standard_DS1_v2: No description available. ,
Standard_DS2_v2: No description available. ,
Standard_DS3_v2: No description available. ,
Standard_DS4_v2: No description available. ,
Standard_DS5_v2: No description available. ,
Standard_DS11_v2: No description available. ,
Standard_DS12_v2: No description available. ,
Standard_DS13_v2: No description available. ,
Standard_DS14_v2: No description available. ,
Standard_DS15_v2: No description available. ,
Standard_DS13-4_v2: No description available. ,
Standard_DS13-2_v2: No description available. ,
Standard_DS14-8_v2: No description available. ,
Standard_DS14-4_v2: No description available. ,
Standard_E2_v3: No description available. ,
Standard_E4_v3: No description available. ,
Standard_E8_v3: No description available. ,
Standard_E16_v3: No description available. ,
Standard_E32_v3: No description available. ,
Standard_E64_v3: No description available. ,
Standard_E2s_v3: No description available. ,
Standard_E4s_v3: No description available. ,
Standard_E8s_v3: No description available. ,
Standard_E16s_v3: No description available. ,
Standard_E32s_v3: No description available. ,
Standard_E64s_v3: No description available. ,
Standard_E32-16_v3: No description available. ,
Standard_E32-8s_v3: No description available. ,
Standard_E64-32s_v3: No description available. ,
Standard_E64-16s_v3: No description available. ,
Standard_F1: No description available. ,
Standard_F2: No description available. ,
Standard_F4: No description available. ,
Standard_F8: No description available. ,
Standard_F16: No description available. ,
Standard_F1s: No description available. ,
Standard_F2s: No description available. ,
Standard_F4s: No description available. ,
Standard_F8s: No description available. ,
Standard_F16s: No description available. ,
Standard_F2s_v2: No description available. ,
Standard_F4s_v2: No description available. ,
Standard_F8s_v2: No description available. ,
Standard_F16s_v2: No description available. ,
Standard_F32s_v2: No description available. ,
Standard_F64s_v2: No description available. ,
Standard_F72s_v2: No description available. ,
Standard_G1: No description available. ,
Standard_G2: No description available. ,
Standard_G3: No description available. ,
Standard_G4: No description available. ,
Standard_G5: No description available. ,
Standard_GS1: No description available. ,
Standard_GS2: No description available. ,
Standard_GS3: No description available. ,
Standard_GS4: No description available. ,
Standard_GS5: No description available. ,
Standard_GS4-8: No description available. ,
Standard_GS4-4: No description available. ,
Standard_GS5-16: No description available. ,
Standard_GS5-8: No description available. ,
Standard_H8: No description available. ,
Standard_H16: No description available. ,
Standard_H8m: No description available. ,
Standard_H16m: No description available. ,
Standard_H16r: No description available. ,
Standard_H16mr: No description available. ,
Standard_L4s: No description available. ,
Standard_L8s: No description available. ,
Standard_L16s: No description available. ,
Standard_L32s: No description available. ,
Standard_M64s: No description available. ,
Standard_M64ms: No description available. ,
Standard_M128s: No description available. ,
Standard_M128ms: No description available. ,
Standard_M64-32ms: No description available. ,
Standard_M64-16ms: No description available. ,
Standard_M128-64ms: No description available. ,
Standard_M128-32ms: No description available. ,
Standard_NC6: No description available. ,
Standard_NC12: No description available. ,
Standard_NC24: No description available. ,
Standard_NC24r: No description available. ,
Standard_NC6s_v2: No description available. ,
Standard_NC12s_v2: No description available. ,
Standard_NC24s_v2: No description available. ,
Standard_NC24rs_v2: No description available. ,
Standard_NC6s_v3: No description available. ,
Standard_NC12s_v3: No description available. ,
Standard_NC24s_v3: No description available. ,
Standard_NC24rs_v3: No description available. ,
Standard_ND6s: No description available. ,
Standard_ND12s: No description available. ,
Standard_ND24s: No description available. ,
Standard_ND24rs: No description available. ,
Standard_NV6: No description available. ,
Standard_NV12: No description available. ,
Standard_NV24: No description available. ,
}
,
Required: False ,
}
enum ,
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. ,
Required: False ,
}
{
vCPUsAvailable:
{
Description: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). ,
Format: int32 ,
Required: False ,
}
integer ,
vCPUsPerCore:
{
Description: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
storageProfile:
{
Description: Gets the storage profile. ,
Required: False ,
}
{
osDisk:
{
Description: Gets the OS disk of the VM captured at the time of the restore point creation. ,
Required: False ,
}
{
osType:
{
Description: Gets the Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Gets the disk encryption settings. ,
Required: False ,
}
{
diskEncryptionKey:
{
Description: Specifies the location of the disk encryption key, which is a Key Vault Secret. ,
Required: False ,
}
{
secretUrl:
{
Description: The URL referencing a secret in a Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the secret. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: The relative URL of the Key Vault containing the key. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
enabled:
{
Description: Specifies whether disk encryption should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the disk size in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Gets the managed disk details ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: Gets the data disks of the VM captured at the time of the restore point creation. ,
Required: False ,
}
[
{
lun:
{
Description: Gets the logical unit number. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Gets the caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: Contains the managed disk details. ,
Required: False ,
}
{
storageAccountType:
{
Description: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. ,
Enum:
{
Standard_LRS: No description available. ,
Premium_LRS: No description available. ,
StandardSSD_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
Premium_ZRS: No description available. ,
StandardSSD_ZRS: No description available. ,
PremiumV2_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Specifies the security profile for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. ,
Enum:
{
VMGuestStateOnly: No description available. ,
DiskWithVMGuestState: No description available. ,
NonPersistedTPM: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. ,
Required: False ,
}
string ,
}
,
}
,
diskRestorePoint:
{
Description: Contains Disk Restore Point properties. ,
Required: False ,
}
{
encryption:
{
Description: Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. ,
Required: False ,
}
{
diskEncryptionSet:
{
Description: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. ,
Required: False ,
}
string ,
type:
{
Description: The type of key used to encrypt the data of the disk restore point. ,
Enum:
{
EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key. ,
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. ,
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. ,
}
,
Required: False ,
}
enum ,
}
,
sourceDiskRestorePoint:
{
Description: Resource Id of the source disk restore point. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Shows true if the disk is write-accelerator enabled. ,
Required: False ,
}
boolean ,
}
,
]
,
diskControllerType:
{
Description: Gets the disk controller type of the VM captured at the time of the restore point creation. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
osProfile:
{
Description: Gets the OS profile. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) ,
Required: False ,
}
string ,
customData:
{
Description: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: Specifies Windows operating system settings on the virtual machine. ,
Required: False ,
}
{
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
enableAutomaticUpdates:
{
Description: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. ,
Required: False ,
}
boolean ,
timeZone:
{
Description: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). ,
Required: False ,
}
string ,
additionalUnattendContent:
{
Description: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. ,
Required: False ,
}
[
{
passName:
{
Description: The pass name. Currently, the only allowable value is OobeSystem. ,
Enum:
{
OobeSystem: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. ,
Enum:
{
Microsoft-Windows-Shell-Setup: No description available. ,
}
,
Required: False ,
}
enum ,
settingName:
{
Description: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. ,
Enum:
{
AutoLogon: No description available. ,
FirstLogonCommands: No description available. ,
}
,
Required: False ,
}
enum ,
content:
{
Description: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. ,
Required: False ,
}
string ,
}
,
]
,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Windows. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ,
Enum:
{
Manual: No description available. ,
AutomaticByOS: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
enableHotpatching:
{
Description: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. ,
Required: False ,
}
boolean ,
assessmentMode:
{
Description: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
winRM:
{
Description: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. ,
Required: False ,
}
{
listeners:
{
Description: The list of Windows Remote Management listeners ,
Required: False ,
}
[
{
protocol:
{
Description: Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** ,
Enum:
{
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. ,
Required: False ,
}
boolean ,
}
,
linuxConfiguration:
{
Description: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). ,
Required: False ,
}
{
disablePasswordAuthentication:
{
Description: Specifies whether password authentication should be disabled. ,
Required: False ,
}
boolean ,
ssh:
{
Description: Specifies the ssh key configuration for a Linux OS. ,
Required: False ,
}
{
publicKeys:
{
Description: The list of SSH public keys used to authenticate with linux based VMs. ,
Required: False ,
}
[
{
path:
{
Description: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys ,
Required: False ,
}
string ,
keyData:
{
Description: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisionVMAgent:
{
Description: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. ,
Required: False ,
}
boolean ,
patchSettings:
{
Description: [Preview Feature] Specifies settings related to VM Guest Patching on Linux. ,
Required: False ,
}
{
patchMode:
{
Description: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentMode:
{
Description: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
automaticByPlatformSettings:
{
Description: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. ,
Required: False ,
}
{
rebootSetting:
{
Description: Specifies the reboot setting for all AutomaticByPlatform patch installation operations. ,
Enum:
{
Unknown: No description available. ,
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: False ,
}
enum ,
bypassPlatformSafetyChecksOnUserSchedule:
{
Description: Enables customer to schedule patching without accidental upgrades ,
Required: False ,
}
boolean ,
}
,
}
,
enableVMAgentPlatformUpdates:
{
Description: Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. ,
Required: False ,
}
boolean ,
}
,
secrets:
{
Description: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). ,
Required: False ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
allowExtensionOperations:
{
Description: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
diagnosticsProfile:
{
Description: Gets the diagnostics profile. ,
Required: False ,
}
{
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
licenseType:
{
Description: Gets the license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
vmId:
{
Description: Gets the virtual machine unique id. ,
Required: False ,
}
string ,
securityProfile:
{
Description: Gets the security profile. ,
Required: False ,
}
{
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. ,
Required: False ,
}
boolean ,
}
,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. ,
Enum:
{
TrustedLaunch: No description available. ,
ConfidentialVM: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionIdentity:
{
Description: Specifies the Managed Identity used by ADE to get access token for keyvault operations. ,
Required: False ,
}
{
userAssignedIdentityResourceId:
{
Description: Specifies ARM Resource ID of one of the user identities associated with the VM. ,
Required: False ,
}
string ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. ,
Required: False ,
}
boolean ,
mode:
{
Description: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
}
,
Required: False ,
}
enum ,
keyIncarnationId:
{
Description: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. ,
Format: int32 ,
Required: False ,
}
integer ,
wireServer:
{
Description: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
imds:
{
Description: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. ,
Required: False ,
}
{
mode:
{
Description: Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Description: Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Location of the VM from which the restore point was created. ,
Required: False ,
}
string ,
userData:
{
Description: UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: HyperVGeneration of the source VM for which restore point is captured. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Gets the provisioning state of the restore point. ,
Required: False ,
}
string ,
consistencyMode:
{
Description: ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. ,
Enum:
{
CrashConsistent: No description available. ,
FileSystemConsistent: No description available. ,
ApplicationConsistent: No description available. ,
}
,
Required: False ,
}
enum ,
timeCreated:
{
Description: Gets the creation time of the restore point. ,
Format: date-time ,
Required: False ,
}
string ,
sourceRestorePoint:
{
Description: Resource Id of the source restore point from which a copy needs to be created. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
instanceView:
{
Description: The restore point instance view. ,
Required: False ,
}
{
diskRestorePoints:
{
Description: The disk restore points information. ,
Required: False ,
}
[
{
id:
{
Description: Disk restore point Id. ,
Required: False ,
}
string ,
replicationStatus:
{
Description: The disk restore point replication status information. ,
Required: False ,
}
{
status:
{
Description: The resource 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 ,
}
,
completionPercent:
{
Description: Replication completion percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
statuses:
{
Description: The resource 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: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineRunCommands_List (new)
Description :  Lists all available run commands for a subscription in a location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands
{
location:
{
Description: The location upon which run commands is queried. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machine run commands. ,
Required: True ,
}
[
{
$schema:
{
Description: The VM run command schema. ,
Required: True ,
}
string ,
id:
{
Description: The VM run command id. ,
Required: True ,
}
string ,
osType:
{
Description: The Operating System type. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
label:
{
Description: The VM run command label. ,
Required: True ,
}
string ,
description:
{
Description: The VM run command description. ,
Required: True ,
}
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 ,
}
VirtualMachineRunCommands_Get (new)
Description :  Gets specific run command for a subscription in a location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}
{
location:
{
Description: The location upon which run commands is queried. ,
Required: True ,
}
string ,
commandId:
{
Description: The command id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
script:
{
Description: The script to be executed. ,
Required: True ,
}
[
string ,
]
,
parameters:
{
Description: The parameters used by the script. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
type:
{
Description: The run command parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: The run command parameter default value. ,
Required: False ,
}
string ,
required:
{
Description: The run command parameter required. ,
Required: False ,
}
boolean ,
}
,
]
,
}
VirtualMachines_RunCommand (new)
Description :  Run command on the VM.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Run command operation. ,
Required: True ,
}
{
commandId:
{
Description: The run command id. ,
Required: True ,
}
string ,
script:
{
Description: Optional. The script to be executed. When this value is given, the given script will override the default script of the command. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The run command parameters. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Run command operation response. ,
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)

{}
VirtualMachineScaleSetVMs_RunCommand (new)
Description :  Run command on a virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
instanceId:
{
Description: The instance ID of the virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Run command operation. ,
Required: True ,
}
{
commandId:
{
Description: The run command id. ,
Required: True ,
}
string ,
script:
{
Description: Optional. The script to be executed. When this value is given, the given script will override the default script of the command. ,
Required: False ,
}
[
string ,
]
,
parameters:
{
Description: The run command parameters. ,
Required: False ,
}
[
{
name:
{
Description: The run command parameter name. ,
Required: True ,
}
string ,
value:
{
Description: The run command parameter value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Run command operation response. ,
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)

{}
VirtualMachineRunCommands_CreateOrUpdate (new)
Description :  The operation to create or update the run command.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine where the run command should be created or updated. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the virtual machine run command. ,
Required: True ,
}
string ,
runCommand:
{
Description: Parameters supplied to the Create Virtual Machine RunCommand operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineRunCommands_Update (new)
Description :  The operation to update the run command.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine where the run command should be updated. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the virtual machine run command. ,
Required: True ,
}
string ,
runCommand:
{
Description: Parameters supplied to the Update Virtual Machine RunCommand operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineRunCommands_Delete (new)
Description :  The operation to delete the run command.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine where the run command should be deleted. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the virtual machine run command. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineRunCommands_GetByVirtualMachine (new)
Description :  The operation to get the run command.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine containing the run command. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the virtual machine run command. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineRunCommands_ListByVirtualMachine (new)
Description :  The operation to get all run commands of a Virtual Machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine containing the run command. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of run commands ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual 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 resource 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 ,
}
,
]
,
}
,
treatFailureAsDeploymentFailure:
{
Description: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of run commands. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
VirtualMachineScaleSetVMRunCommands_CreateOrUpdate (new)
Description :  The operation to create or update the VMSS VM run command.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
instanceId:
{
Description: The instance ID of the virtual machine. ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the virtual machine run command. ,
Required: True ,
}
string ,
runCommand:
{
Description: Parameters supplied to the Create Virtual Machine RunCommand operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Virtual Machine run command. ,
Required: False ,
}
{
source:
{
Description: The source of the run command script. ,
Required: False ,
}
{
script:
{
Description: Specifies the script content to be executed on the VM. ,
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 a 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 the script starts and will not wait for script to complete. ,
Required: False ,
}
boolean ,
runAsUser:
{
Description: Specifies the user account on the VM when executing the run command. ,
Required: False ,
}
string ,
runAsPassword:
{
Description: Specifies the user account password on the VM 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 ,