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 ,
}
,
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 ,
}
,
}
VirtualMachineScaleSetVMRunCommands_Update (new)
Description :  The operation to update the VMSS VM run command.
Reference :  Link ¶

⚼ Request

PATCH:  /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 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 ,
}
,
}
VirtualMachineScaleSetVMRunCommands_Delete (new)
Description :  The operation to delete the VMSS VM run command.
Reference :  Link ¶

⚼ Request

DELETE:  /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 ,
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 ,
}
,
}
VirtualMachineScaleSetVMRunCommands_Get (new)
Description :  The operation to get the VMSS VM run command.
Reference :  Link ¶

⚼ Request

GET:  /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 ,
$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 ,
}
,
}
VirtualMachineScaleSetVMRunCommands_List (new)
Description :  The operation to get all run commands of an instance in Virtual Machine Scaleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands
{
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 ,
$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 ,
}
,
}
SshPublicKeys_ListBySubscription (new)
Description :  Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys
{
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 SSH public keys ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys. ,
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 ,
}
,
}
SshPublicKeys_ListByResourceGroup (new)
Description :  Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys
{
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 SSH public keys ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys. ,
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 ,
}
,
}
SshPublicKeys_Create (new)
Description :  Creates a new SSH public key resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
sshPublicKeyName:
{
Description: The name of the SSH public key. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the SSH public key. ,
Required: True ,
}
{
properties:
{
Description: Properties of the SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
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 SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
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 ,
}
,
}
SshPublicKeys_Update (new)
Description :  Updates a new SSH public key resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
sshPublicKeyName:
{
Description: The name of the SSH public key. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update the SSH public key. ,
Required: True ,
}
{
properties:
{
Description: Properties of the SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
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 SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
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 ,
}
,
}
SshPublicKeys_Delete (new)
Description :  Delete an SSH public key.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
sshPublicKeyName:
{
Description: The name of the SSH public key. ,
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 ,
}
,
}
SshPublicKeys_Get (new)
Description :  Retrieves information about an SSH public key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
sshPublicKeyName:
{
Description: The name of the SSH public key. ,
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: Properties of the SSH public key. ,
Required: False ,
}
{
publicKey:
{
Description: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ,
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 ,
}
,
}
SshPublicKeys_GenerateKeyPair (new)
Description :  Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
sshPublicKeyName:
{
Description: The name of the SSH public key. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to generate the SSH public key. ,
Required: False ,
}
{
encryptionType:
{
Description: The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA ,
Enum:
{
RSA: No description available. ,
Ed25519: 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)

{
privateKey:
{
Description: Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret. ,
Required: True ,
}
string ,
publicKey:
{
Description: Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format. ,
Required: True ,
}
string ,
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName} ,
Required: True ,
}
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 ,
}
,
}
VirtualMachineExtensions_CreateOrUpdate (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine where the extension should be created or updated. ,
Required: True ,
}
string ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Virtual Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineExtensions_Update (new)
Description :  The operation to update the extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine where the extension should be updated. ,
Required: True ,
}
string ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Update Virtual Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
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 Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineExtensions_Delete (new)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine where the extension should be deleted. ,
Required: True ,
}
string ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
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 ,
}
,
}
VirtualMachineExtensions_Get (new)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine containing the extension. ,
Required: True ,
}
string ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
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 Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineExtensions_List (new)
Description :  The operation to get all extensions of a Virtual Machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine containing the extension. ,
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 extensions ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachines_ListByLocation (new)
Description :  Gets all the virtual machines under the specified subscription for the specified location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines
{
location:
{
Description: The location for which virtual machines under the subscription are 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 machines. ,
Required: True ,
}
[
{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines. ,
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 ,
}
,
}
VirtualMachines_Capture (new)
Description :  Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture
{
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 Capture Virtual Machine operation. ,
Required: True ,
}
{
vhdPrefix:
{
Description: The captured virtual hard disk's name prefix. ,
Required: True ,
}
string ,
destinationContainerName:
{
Description: The destination container name. ,
Required: True ,
}
string ,
overwriteVhds:
{
Description: Specifies whether to overwrite the destination virtual hard disk, in case of conflict. ,
Required: True ,
}
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)

{
$schema:
{
Description: the schema of the captured virtual machine ,
Required: False ,
}
string ,
contentVersion:
{
Description: the version of the content ,
Required: False ,
}
string ,
parameters:
{
Description: parameters of the captured virtual machine ,
Required: False ,
}
object ,
resources:
{
Description: a list of resource items of the captured virtual machine ,
Required: False ,
}
[
object ,
]
,
}

⚐ 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 ,
}
,
}
VirtualMachines_CreateOrUpdate (new)
Description :  The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
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 Create Virtual Machine operation. ,
Required: True ,
}
{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
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 ,
If-Match:
{
Description: The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
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 ,
}
,
}
VirtualMachines_Update (new)
Description :  The operation to update a virtual machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
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 Update Virtual Machine operation. ,
Required: True ,
}
{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine 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 ,
If-Match:
{
Description: The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
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 ,
}
,
}
VirtualMachines_Delete (new)
Description :  The operation to delete a virtual machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
forceDeletion:
{
Description: Optional parameter to force delete virtual machines. NOTE: As of api-version 2024-11-01, we are rolling out a feature where if the forceDeletion parameter is unspecified OR not explicitly set to false, AND all of the VM's attached disks including the OS disk are marked with the delete option, then the VM will be force deleted. For more details on how to configure delete options for a VM's resources, see [Delete a VM and attached resources](https://learn.microsoft.com/en-us/azure/virtual-machines/delete). To avoid defaulting to force delete, ensure that the forceDeletion parameter is explicitly set to false. This feature is expected to rollout by end of March 2025. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachines_Get (new)
Description :  Retrieves information about the model view or the instance view of a virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update 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)

{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
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 ,
}
,
}
VirtualMachines_InstanceView (new)
Description :  Retrieves information about the run-time state of a virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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)

{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
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 ,
}
,
}
VirtualMachines_ConvertToManagedDisks (new)
Description :  Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 (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 ,
}
,
}
VirtualMachines_Deallocate (new)
Description :  Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
hibernate:
{
Description: Optional parameter to hibernate a virtual machine. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachines_Generalize (new)
Description :  Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/azure/virtual-machines/windows/capture-image-resource). For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/azure/virtual-machines/linux/capture-image).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 ,
}
,
}
VirtualMachines_List (new)
Description :  Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$filter:
{
Description: The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}' ,
Required: False ,
}
string ,
$expand:
{
Description: The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified ,
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 virtual machines. ,
Required: True ,
}
[
{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines. ,
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 ,
}
,
}
VirtualMachines_ListAll (new)
Description :  Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines
{
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 ,
statusOnly:
{
Description: statusOnly=true enables fetching run time status of all Virtual Machines in the subscription. ,
Required: False ,
}
string ,
$filter:
{
Description: The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}' ,
Required: False ,
}
string ,
$expand:
{
Description: The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machines. ,
Required: True ,
}
[
{
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine. ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
scheduledEventsPolicy:
{
Description: Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. ,
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 ,
}
,
}
,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. ,
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 ,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
virtualMachineScaleSet:
{
Description: Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priority:
{
Description: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
host:
{
Description: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: Specifies the update domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: Specifies the fault domain of the virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
computerName:
{
Description: The computer name assigned to the virtual machine. ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the virtual machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the virtual machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type associated with a resource ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The virtual machine disk information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
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 ,
}
,
]
,
patchStatus:
{
Description: [Preview Feature] The status of virtual machine patch operations. ,
Required: False ,
}
{
availablePatchSummary:
{
Description: The available patch summary of the latest assessment operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
lastPatchInstallationSummary:
{
Description: The installation summary of the latest installation operation for the virtual machine. ,
Required: False ,
}
{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
maintenanceWindowExceeded:
{
Description: Describes whether the operation ran out of time before it completed all its intended actions ,
Required: False ,
}
boolean ,
notSelectedPatchCount:
{
Description: The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. ,
Format: int32 ,
Required: False ,
}
integer ,
excludedPatchCount:
{
Description: The number of all available patches but excluded explicitly by a customer-specified exclusion list match. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of all available patches expected to be installed over the course of the patch installation operation. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The count of patches that successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The count of patches that failed installation. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}
,
configurationStatuses:
{
Description: The enablement status of the specified patchMode ,
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 ,
}
,
]
,
}
,
isVMInStandbyPool:
{
Description: [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. ,
Required: False ,
}
boolean ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ,
Required: False ,
}
string ,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
platformFaultDomain:
{
Description: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. ,
Format: int32 ,
Required: False ,
}
integer ,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS. ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
managedBy:
{
Description: ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. ,
Required: False ,
}
string ,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
placement:
{
Description: Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. ,
Required: False ,
}
{
zonePlacementPolicy:
{
Description: Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
excludeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines. ,
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 ,
}
,
}
VirtualMachines_ListAvailableSizes (new)
Description :  Lists all available virtual machine sizes to which the specified virtual machine can be resized.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 ,
}
,
}
VirtualMachines_PowerOff (new)
Description :  The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine. NOTE: This operation is not allowed on a virtual machine that is being deallocated or has already been deallocated.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
skipShutdown:
{
Description: The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachines_Reapply (new)
Description :  The operation to reapply a virtual machine's state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 (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 ,
}
,
}
VirtualMachines_Restart (new)
Description :  The operation to restart a virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 (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 ,
}
,
}
VirtualMachines_Start (new)
Description :  The operation to start a virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 (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 ,
}
,
}
VirtualMachines_Redeploy (new)
Description :  Shuts down the virtual machine, moves it to a new node, and powers it back on.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 (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 ,
}
,
}
VirtualMachines_Reimage (new)
Description :  Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage
{
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 Reimage Virtual Machine operation. ,
Required: False ,
}
{
tempDisk:
{
Description: Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk. ,
Required: False ,
}
boolean ,
exactVersion:
{
Description: Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk. ,
Required: False ,
}
string ,
osProfile:
{
Description: Specifies information required for reimaging the non-ephemeral OS disk. ,
Required: False ,
}
{
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/). If 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 ,
}
,
}
,
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 (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 ,
}
,
}
VirtualMachines_RetrieveBootDiagnosticsData (new)
Description :  The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
sasUriExpirationTimeInMinutes:
{
Description: Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes. ,
Format: int32 ,
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)

{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob URI. ,
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 ,
}
,
}
VirtualMachines_PerformMaintenance (new)
Description :  The operation to perform maintenance on a virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 (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 ,
}
,
}
VirtualMachines_SimulateEviction (new)
Description :  The operation to simulate the eviction of spot virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 ,
}
,
}
VirtualMachines_AssessPatches (new)
Description :  Assess patches on the VM.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/assessPatches
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
criticalAndSecurityPatchCount:
{
Description: The number of critical or security patches that have been detected as available and not yet installed. ,
Format: int32 ,
Required: False ,
}
integer ,
otherPatchCount:
{
Description: The number of all available patches excluding critical and security. ,
Format: int32 ,
Required: False ,
}
integer ,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
availablePatches:
{
Description: The list of patches that have been detected as available for installation. ,
Required: False ,
}
[
{
patchId:
{
Description: A unique identifier for the patch. ,
Required: False ,
}
string ,
name:
{
Description: The friendly name of the patch. ,
Required: False ,
}
string ,
version:
{
Description: The version number of the patch. This property applies only to Linux patches. ,
Required: False ,
}
string ,
kbId:
{
Description: The KBID of the patch. Only applies to Windows patches. ,
Required: False ,
}
string ,
classifications:
{
Description: The classification(s) of the patch as provided by the patch publisher. ,
Required: False ,
}
[
string ,
]
,
rebootBehavior:
{
Description: Describes the reboot requirements of the patch. ,
Enum:
{
Unknown: No description available. ,
NeverReboots: No description available. ,
AlwaysRequiresReboot: No description available. ,
CanRequestReboot: No description available. ,
}
,
Required: False ,
}
enum ,
activityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
publishedDate:
{
Description: The UTC timestamp when the repository published this patch. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp of the last update to this patch record. ,
Format: date-time ,
Required: False ,
}
string ,
assessmentState:
{
Description: Describes the availability of a given patch. ,
Enum:
{
Unknown: No description available. ,
Available: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}

⚐ 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 ,
}
,
}
VirtualMachines_InstallPatches (new)
Description :  Installs patches on the VM.
Reference :  Link ¶

⚼ Request

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

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: The reboot state of the VM following completion of the operation. ,
Enum:
{
Unknown: No description available. ,
NotNeeded: No description available. ,
Required: No description available. ,
Started: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowExceeded:
{
Description: Whether the operation ran out of time before it completed all its intended actions. ,
Required: False ,
}
boolean ,
excludedPatchCount:
{
Description: The number of patches that were not installed due to the user blocking their installation. ,
Format: int32 ,
Required: False ,
}
integer ,
notSelectedPatchCount:
{
Description: The number of patches that were detected as available for install, but did not meet the operation's criteria. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The number of patches successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The number of patches that could not be installed due to some issue. See errors for details. ,
Format: int32 ,
Required: False ,
}
integer ,
patches:
{
Description: The patches that were installed during the operation. ,
Required: False ,
}
[
{
patchId:
{
Description: A unique identifier for the patch. ,
Required: False ,
}
string ,
name:
{
Description: The friendly name of the patch. ,
Required: False ,
}
string ,
version:
{
Description: The version string of the package. It may conform to Semantic Versioning. Only applies to Linux. ,
Required: False ,
}
string ,
kbId:
{
Description: The KBID of the patch. Only applies to Windows patches. ,
Required: False ,
}
string ,
classifications:
{
Description: The classification(s) of the patch as provided by the patch publisher. ,
Required: False ,
}
[
string ,
]
,
installationState:
{
Description: The state of the patch after the installation operation completed. ,
Enum:
{
Unknown: No description available. ,
Installed: No description available. ,
Failed: No description available. ,
Excluded: No description available. ,
NotSelected: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
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 ,
}
,
}

⚐ 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 ,
}
,
}
VirtualMachines_AttachDetachDataDisks (new)
Description :  Attach and detach data disks to/from the virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks
{
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 attach and detach data disks operation on the virtual machine. ,
Required: True ,
}
{
dataDisksToAttach:
{
Description: The list of managed data disks to be attached. ,
Required: False ,
}
[
{
diskId:
{
Description: ID of the managed data disk. ,
Required: True ,
}
string ,
lun:
{
Description: 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. If not specified, lun would be auto assigned. ,
Format: int32 ,
Required: False ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
]
,
dataDisksToDetach:
{
Description: The list of managed data disks to be detached. ,
Required: False ,
}
[
{
diskId:
{
Description: ID of the managed data disk. ,
Required: True ,
}
string ,
detachOption:
{
Description: Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}

⚐ 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 ,
}
,
}
VirtualMachines_migrateToVMScaleSet (new)
Description :  Migrate a virtual machine from availability set to Flexible Virtual Machine Scale Set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/migrateToVirtualMachineScaleSet
{
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 Migrate Virtual Machine operation. ,
Required: False ,
}
{
targetZone:
{
Description: The target zone of VM migration to Flexible Virtual Machine Scale Set. ,
Required: False ,
}
string ,
targetFaultDomain:
{
Description: The target compute fault domain of VM migration to Flexible Virtual Machine Scale Set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetVMSize:
{
Description: The target Virtual Machine size of VM migration to Flexible Virtual Machine Scale Set. ,
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 ,
}
,
}
VirtualMachineExtensionImages_Get (new)
Description :  Gets a virtual machine extension image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
version:
{
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 Virtual Machine Extension Image. ,
Required: False ,
}
{
operatingSystem:
{
Description: The operating system this extension supports. ,
Required: True ,
}
string ,
computeRole:
{
Description: The type of role (IaaS or PaaS) this extension supports. ,
Required: True ,
}
string ,
handlerSchema:
{
Description: The schema defined by publisher, where extension consumers should provide settings in a matching schema. ,
Required: True ,
}
string ,
vmScaleSetEnabled:
{
Description: Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. ,
Required: False ,
}
boolean ,
supportsMultipleExtensions:
{
Description: Whether the handler can support multiple extensions. ,
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 ,
}
,
}
VirtualMachineExtensionImages_ListTypes (new)
Description :  Gets a list of virtual machine extension image types.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
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 Virtual Machine Extension Image. ,
Required: False ,
}
{
operatingSystem:
{
Description: The operating system this extension supports. ,
Required: True ,
}
string ,
computeRole:
{
Description: The type of role (IaaS or PaaS) this extension supports. ,
Required: True ,
}
string ,
handlerSchema:
{
Description: The schema defined by publisher, where extension consumers should provide settings in a matching schema. ,
Required: True ,
}
string ,
vmScaleSetEnabled:
{
Description: Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. ,
Required: False ,
}
boolean ,
supportsMultipleExtensions:
{
Description: Whether the handler can support multiple extensions. ,
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 ,
}
,
}
VirtualMachineExtensionImages_ListVersions (new)
Description :  Gets a list of virtual machine extension image versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
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 Extension Image. ,
Required: False ,
}
{
operatingSystem:
{
Description: The operating system this extension supports. ,
Required: True ,
}
string ,
computeRole:
{
Description: The type of role (IaaS or PaaS) this extension supports. ,
Required: True ,
}
string ,
handlerSchema:
{
Description: The schema defined by publisher, where extension consumers should provide settings in a matching schema. ,
Required: True ,
}
string ,
vmScaleSetEnabled:
{
Description: Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. ,
Required: False ,
}
boolean ,
supportsMultipleExtensions:
{
Description: Whether the handler can support multiple extensions. ,
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 ,
}
,
}
VirtualMachineImages_Get (new)
Description :  Gets a virtual machine image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
Required: True ,
}
string ,
offer:
{
Description: A valid image publisher offer. ,
Required: True ,
}
string ,
skus:
{
Description: A valid image SKU. ,
Required: True ,
}
string ,
version:
{
Description: A valid image SKU version. ,
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 Virtual Machine Image. ,
Required: False ,
}
{
plan:
{
Description: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. ,
Required: False ,
}
{
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
}
,
osDiskImage:
{
Description: Contains the os disk image information. ,
Required: False ,
}
{
operatingSystem:
{
Description: The operating system of the osDiskImage. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
dataDiskImages:
{
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: False ,
}
integer ,
}
,
]
,
automaticOSUpgradeProperties:
{
Description: Describes automatic OS upgrade properties on the image. ,
Required: False ,
}
{
automaticOSUpgradeSupported:
{
Description: Specifies whether automatic OS upgrade is supported on the image. ,
Required: True ,
}
boolean ,
}
,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
disallowed:
{
Description: Specifies disallowed configuration for the VirtualMachine created from the image ,
Required: False ,
}
{
vmDiskType:
{
Description: VM disk types which are disallowed. ,
Enum:
{
None: No description available. ,
Unmanaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
features:
{
Required: False ,
}
[
{
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
value:
{
Description: The corresponding value for the feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: Specifies the Architecture Type ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
imageDeprecationStatus:
{
Description: Describes image deprecation status properties on the image. ,
Required: False ,
}
{
imageState:
{
Description: Describes the state of the image. ,
Enum:
{
Active: No description available. ,
ScheduledForDeprecation: No description available. ,
Deprecated: No description available. ,
}
,
Required: False ,
}
enum ,
scheduledDeprecationTime:
{
Description: The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher. ,
Format: date-time ,
Required: False ,
}
string ,
alternativeOption:
{
Description: Describes the alternative option specified by the Publisher for this image when this image is deprecated. ,
Required: False ,
}
{
type:
{
Description: Describes the type of the alternative option. ,
Enum:
{
None: No description available. ,
Offer: No description available. ,
Plan: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan. ,
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 ,
}
,
}
VirtualMachineImages_List (new)
Description :  Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
Required: True ,
}
string ,
offer:
{
Description: A valid image publisher offer. ,
Required: True ,
}
string ,
skus:
{
Description: A valid image SKU. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImages_ListOffers (new)
Description :  Gets a list of virtual machine image offers for the specified location and publisher.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImages_ListPublishers (new)
Description :  Gets a list of virtual machine image publishers for the specified Azure location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers
{
location:
{
Description: The name of a supported Azure region. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImages_ListSkus (new)
Description :  Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
Required: True ,
}
string ,
offer:
{
Description: A valid image publisher offer. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImagesEdgeZone_Get (new)
Description :  Gets a virtual machine image in an edge zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
edgeZone:
{
Description: The name of the edge zone. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
Required: True ,
}
string ,
offer:
{
Description: A valid image publisher offer. ,
Required: True ,
}
string ,
skus:
{
Description: A valid image SKU. ,
Required: True ,
}
string ,
version:
{
Description: A valid image SKU version. ,
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 Virtual Machine Image. ,
Required: False ,
}
{
plan:
{
Description: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. ,
Required: False ,
}
{
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
name:
{
Description: The plan ID. ,
Required: True ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: True ,
}
string ,
}
,
osDiskImage:
{
Description: Contains the os disk image information. ,
Required: False ,
}
{
operatingSystem:
{
Description: The operating system of the osDiskImage. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
dataDiskImages:
{
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: False ,
}
integer ,
}
,
]
,
automaticOSUpgradeProperties:
{
Description: Describes automatic OS upgrade properties on the image. ,
Required: False ,
}
{
automaticOSUpgradeSupported:
{
Description: Specifies whether automatic OS upgrade is supported on the image. ,
Required: True ,
}
boolean ,
}
,
hyperVGeneration:
{
Description: Specifies the HyperVGeneration Type ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
disallowed:
{
Description: Specifies disallowed configuration for the VirtualMachine created from the image ,
Required: False ,
}
{
vmDiskType:
{
Description: VM disk types which are disallowed. ,
Enum:
{
None: No description available. ,
Unmanaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
features:
{
Required: False ,
}
[
{
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
value:
{
Description: The corresponding value for the feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: Specifies the Architecture Type ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
imageDeprecationStatus:
{
Description: Describes image deprecation status properties on the image. ,
Required: False ,
}
{
imageState:
{
Description: Describes the state of the image. ,
Enum:
{
Active: No description available. ,
ScheduledForDeprecation: No description available. ,
Deprecated: No description available. ,
}
,
Required: False ,
}
enum ,
scheduledDeprecationTime:
{
Description: The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher. ,
Format: date-time ,
Required: False ,
}
string ,
alternativeOption:
{
Description: Describes the alternative option specified by the Publisher for this image when this image is deprecated. ,
Required: False ,
}
{
type:
{
Description: Describes the type of the alternative option. ,
Enum:
{
None: No description available. ,
Offer: No description available. ,
Plan: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan. ,
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 ,
}
,
}
VirtualMachineImagesEdgeZone_List (new)
Description :  Gets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
edgeZone:
{
Description: The name of the edge zone. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
Required: True ,
}
string ,
offer:
{
Description: A valid image publisher offer. ,
Required: True ,
}
string ,
skus:
{
Description: A valid image SKU. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: An integer value specifying the number of images to return that matches supplied values. ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: Specifies the order of the results returned. Formatted as an OData query. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImagesEdgeZone_ListOffers (new)
Description :  Gets a list of virtual machine image offers for the specified location, edge zone and publisher.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
edgeZone:
{
Description: The name of the edge zone. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImagesEdgeZone_ListPublishers (new)
Description :  Gets a list of virtual machine image publishers for the specified Azure location and edge zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
edgeZone:
{
Description: The name of the edge zone. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineImages_ListByEdgeZone (new)
Description :  Gets a list of all virtual machine image versions for the specified edge zone
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/vmimages
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
edgeZone:
{
Description: The name of the edge zone. ,
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 VMImages in EdgeZone ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages. ,
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 ,
}
,
}
VirtualMachineImagesEdgeZone_ListSkus (new)
Description :  Gets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus
{
location:
{
Description: The name of a supported Azure region. ,
Required: True ,
}
string ,
edgeZone:
{
Description: The name of the edge zone. ,
Required: True ,
}
string ,
publisherName:
{
Description: A valid image publisher. ,
Required: True ,
}
string ,
offer:
{
Description: A valid image publisher offer. ,
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)

{
name:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
location:
{
Description: The supported Azure location of the resource. ,
Required: True ,
}
string ,
tags:
{
Description: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). ,
Required: False ,
}
object ,
extendedLocation:
{
Description: The extended location of the Virtual Machine. ,
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 ,
}
,
}
VirtualMachineScaleSets_ListByLocation (new)
Description :  Gets all the VM scale sets under the specified subscription for the specified location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets
{
location:
{
Description: The location for which VM scale sets under the subscription are 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 scale sets. ,
Required: True ,
}
[
{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS. ,
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 ,
}
,
}
VirtualMachineScaleSets_CreateOrUpdate (new)
Description :  Create or update a VM scale set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: The scale set object. ,
Required: True ,
}
{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
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 ,
If-Match:
{
Description: The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
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 ,
}
,
}
VirtualMachineScaleSets_Update (new)
Description :  Update a VM scale set.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: The scale set object. ,
Required: True ,
}
{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: The purchase plan when deploying a virtual machine scale set from VM Marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: The virtual machine scale set OS profile. ,
Required: False ,
}
{
customData:
{
Description: A base-64 encoded string of custom data. ,
Required: False ,
}
string ,
windowsConfiguration:
{
Description: The Windows Configuration of the OS profile. ,
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: The Linux Configuration of the OS profile. ,
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: The List of certificates for addition to the VM. ,
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 ,
}
,
]
,
}
,
]
,
}
,
storageProfile:
{
Description: The virtual machine scale set storage profile. ,
Required: False ,
}
{
imageReference:
{
Description: The image reference. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: The OS disk. ,
Required: False ,
}
{
caching:
{
Description: The caching type. ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 ,
Format: int32 ,
Required: False ,
}
integer ,
image:
{
Description: The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: The list of virtual hard disk container uris. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: The data disks. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: The virtual machine scale set network profile. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: False ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. ,
Required: False ,
}
{
primary:
{
Description: Whether this is a primary NIC on a virtual machine. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: The virtual machine scale set IP Configuration. ,
Required: False ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: False ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: The subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: False ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: The application gateway backend address pools. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: The load balancer backend address pools. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: The load balancer inbound nat pools. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityPostureReference:
{
Description: The virtual machine scale set security posture reference. ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: False ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The virtual machine scale set 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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: The virtual machine scale set 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 ,
}
,
}
,
extensionProfile:
{
Description: The virtual machine scale set extension profile. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: The license type, which is for bring your own license scenario. ,
Required: False ,
}
string ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01 ,
Required: False ,
}
string ,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
}
,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set 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 ,
If-Match:
{
Description: The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
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 ,
}
,
}
VirtualMachineScaleSets_Delete (new)
Description :  Deletes a VM scale set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
forceDeletion:
{
Description: Optional parameter to force delete a VM scale set. (Feature in Preview) ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_Get (new)
Description :  Display information about a virtual machine scale set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 ,
$expand:
{
Description: The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
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 ,
}
,
}
VirtualMachineScaleSets_Deallocate (new)
Description :  Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
Required: False ,
}
[
string ,
]
,
}
,
hibernate:
{
Description: Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only) ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_DeleteInstances (new)
Description :  Deletes virtual machines in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: True ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. ,
Required: True ,
}
[
string ,
]
,
}
,
forceDeletion:
{
Description: Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview) ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_GetInstanceView (new)
Description :  Gets the status of a VM scale set instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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)

{
virtualMachine:
{
Description: The instance view status summary for the virtual machine scale set. ,
Required: False ,
}
{
statusesSummary:
{
Description: The extensions information. ,
Required: False ,
}
[
{
code:
{
Description: The instance view status code. ,
Required: False ,
}
string ,
count:
{
Description: The number of instances having a particular status code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
statusesSummary:
{
Description: The extensions information. ,
Required: False ,
}
[
{
code:
{
Description: The instance view status code. ,
Required: False ,
}
string ,
count:
{
Description: The number of instances having a particular status code. ,
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 ,
}
,
]
,
orchestrationServices:
{
Description: The orchestration services information. ,
Required: False ,
}
[
{
serviceName:
{
Description: The name of the service. ,
Enum:
{
AutomaticRepairs: No description available. ,
}
,
Required: False ,
}
enum ,
serviceState:
{
Description: The current state of the service. ,
Enum:
{
NotRunning: No description available. ,
Running: No description available. ,
Suspended: 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 ,
}
,
}
VirtualMachineScaleSets_List (new)
Description :  Gets a list of all VM scale sets under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets
{
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 virtual machine scale sets. ,
Required: True ,
}
[
{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS. ,
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 ,
}
,
}
VirtualMachineScaleSetExtensions_CreateOrUpdate (new)
Description :  The operation to create or update an extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set where the extension should be create or updated. ,
Required: True ,
}
string ,
vmssExtensionName:
{
Description: The name of the VM scale set extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create VM scale set Extension operation. ,
Required: True ,
}
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
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)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetExtensions_Update (new)
Description :  The operation to update an extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set where the extension should be updated. ,
Required: True ,
}
string ,
vmssExtensionName:
{
Description: The name of the VM scale set extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Update VM scale set Extension operation. ,
Required: True ,
}
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
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)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetExtensions_Delete (new)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set where the extension should be deleted. ,
Required: True ,
}
string ,
vmssExtensionName:
{
Description: The name of the VM scale set extension. ,
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 ,
}
,
}
VirtualMachineScaleSetExtensions_Get (new)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set containing the extension. ,
Required: True ,
}
string ,
vmssExtensionName:
{
Description: The name of the VM scale set extension. ,
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)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetExtensions_List (new)
Description :  Gets a list of all extensions in a VM scale set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set containing the extension. ,
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 VM scale set extensions. ,
Required: True ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions. ,
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 ,
}
,
}
VirtualMachineScaleSets_ListAll (new)
Description :  Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets
{
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 scale sets. ,
Required: True ,
}
[
{
sku:
{
Description: The virtual machine scale set sku. ,
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 ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set. ,
Required: False ,
}
{
upgradePolicy:
{
Description: The upgrade policy. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. ,
Required: False ,
}
{
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. ,
Required: False ,
}
boolean ,
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. Default value is false. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. ,
Required: False ,
}
boolean ,
}
,
}
,
scheduledEventsPolicy:
{
Description: The ScheduledEventsPolicy. ,
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 ,
}
,
}
,
}
,
automaticRepairsPolicy:
{
Description: Policy for automatic repairs. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
gracePeriod:
{
Description: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). ,
Required: False ,
}
string ,
repairAction:
{
Description: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. ,
Enum:
{
Replace: No description available. ,
Restart: No description available. ,
Reimage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualMachineProfile:
{
Description: The virtual machine profile. ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the virtual machines in the scale set. ,
Required: False ,
}
{
computerNamePrefix:
{
Description: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. ,
Required: False ,
}
string ,
adminUsername:
{
Description: Specifies the name of the administrator account.

**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. For using cloud-init for your 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 machines in the scale set. 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 scale set. This may only be set to False when no extensions are present on the virtual machine scale set. ,
Required: False ,
}
boolean ,
requireGuestProvisionSignal:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: Specifies information about the operating system disk used by the virtual machines in the scale set. 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 ,
}
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diffDiskSettings:
{
Description: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Specifies information about the unmanaged user image to base the scale set on. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
vhdContainers:
{
Description: Specifies the container urls that are used to store operating system disks for the scale set. ,
Required: False ,
}
[
string ,
]
,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dataDisks:
{
Description: Specifies the parameters that are used to add data disks to the virtual machines in the scale set. 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 ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
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 ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: The create option. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. ,
Format: int64 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies properties of the network interfaces of the virtual machines in the scale set. ,
Required: False ,
}
{
healthProbe:
{
Description: A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'. ,
Enum:
{
2020-11-01: No description available. ,
2022-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machines in the scale set. ,
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 ,
}
,
}
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
extensionProfile:
{
Description: Specifies a collection of settings for extensions installed on virtual machines in the scale set. ,
Required: False ,
}
{
extensions:
{
Description: The virtual machine scale set child extension resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
]
,
extensionsTimeBudget:
{
Description: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
}
,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
priority:
{
Description: Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. ,
Enum:
{
Regular: No description available. ,
Low: No description available. ,
Spot: No description available. ,
}
,
Required: False ,
}
enum ,
evictionPolicy:
{
Description: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. ,
Enum:
{
Deallocate: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfile:
{
Description: Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. ,
Required: False ,
}
{
maxPrice:
{
Description: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. ,
Format: double ,
Required: False ,
}
number ,
}
,
scheduledEventsProfile:
{
Description: Specifies Scheduled Event related configurations. ,
Required: False ,
}
{
terminateNotificationProfile:
{
Description: Specifies Terminate Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the Terminate Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
osImageNotificationProfile:
{
Description: Specifies OS Image Scheduled Event related configurations. ,
Required: False ,
}
{
notBeforeTimeout:
{
Description: Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) ,
Required: False ,
}
string ,
enable:
{
Description: Specifies whether the OS Image Scheduled event is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
userData:
{
Description: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. ,
Required: False ,
}
string ,
capacityReservation:
{
Description: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. ,
Required: False ,
}
{
capacityReservationGroup:
{
Description: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
applicationProfile:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
{
galleryApplications:
{
Description: Specifies the gallery applications that should be made available to the VM/VMSS ,
Required: False ,
}
[
{
tags:
{
Description: Optional, Specifies a passthrough value for more generic context. ,
Required: False ,
}
string ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} ,
Required: True ,
}
string ,
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
hardwareProfile:
{
Description: Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. ,
Required: False ,
}
{
vmSizeProperties:
{
Description: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. 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 ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
string ,
}
,
securityPostureReference:
{
Description: Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 ,
Required: False ,
}
{
id:
{
Description: The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest ,
Required: True ,
}
string ,
excludeExtensions:
{
Description: The list of virtual machine extension names to exclude when applying the security posture. ,
Required: False ,
}
[
string ,
]
,
isOverridable:
{
Description: Whether the security posture can be overridden by the user. ,
Required: False ,
}
boolean ,
}
,
timeCreated:
{
Description: Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
overprovision:
{
Description: Specifies whether the Virtual Machine Scale Set should be overprovisioned. ,
Required: False ,
}
boolean ,
doNotRunExtensionsOnOverprovisionedVMs:
{
Description: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. ,
Required: False ,
}
boolean ,
uniqueId:
{
Description: Specifies the ID which uniquely identifies a Virtual Machine Scale Set. ,
Required: False ,
}
string ,
singlePlacementGroup:
{
Description: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. ,
Required: False ,
}
boolean ,
zoneBalance:
{
Description: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. ,
Required: False ,
}
boolean ,
platformFaultDomainCount:
{
Description: Fault Domain count for each placement group. ,
Format: int32 ,
Required: False ,
}
integer ,
proximityPlacementGroup:
{
Description: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
scaleInPolicy:
{
Description: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. ,
Required: False ,
}
{
rules:
{
Description: The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

,
Required: False ,
}
[
string ,
]
,
forceDeletion:
{
Description: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
prioritizeUnhealthyVMs:
{
Description: This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) ,
Required: False ,
}
boolean ,
}
,
orchestrationMode:
{
Description: Specifies the orchestration mode for the virtual machine scale set. ,
Enum:
{
Uniform: No description available. ,
Flexible: No description available. ,
}
,
Required: False ,
}
enum ,
spotRestorePolicy:
{
Description: Specifies the Spot Restore properties for the virtual machine scale set. ,
Required: False ,
}
{
enabled:
{
Description: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints ,
Required: False ,
}
boolean ,
restoreTimeout:
{
Description: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances ,
Required: False ,
}
string ,
}
,
priorityMixPolicy:
{
Description: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. ,
Required: False ,
}
{
baseRegularPriorityCount:
{
Description: The base number of regular priority VMs that will be created in this scale set as it scales out. ,
Format: int32 ,
Required: False ,
}
integer ,
regularPriorityPercentageAboveBase:
{
Description: The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
constrainedMaximumCapacity:
{
Description: Optional property which must either be set to True or omitted. ,
Required: False ,
}
boolean ,
resiliencyPolicy:
{
Description: Policy for Resiliency ,
Required: False ,
}
{
resilientVMCreationPolicy:
{
Description: The configuration parameters used while performing resilient VM creation. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
resilientVMDeletionPolicy:
{
Description: The configuration parameters used while performing resilient VM deletion. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
}
,
automaticZoneRebalancingPolicy:
{
Description: The configuration parameters used while performing automatic AZ balancing. ,
Required: False ,
}
{
enabled:
{
Description: Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. ,
Required: False ,
}
boolean ,
rebalanceStrategy:
{
Description: Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. ,
Enum:
{
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
rebalanceBehavior:
{
Description: Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. ,
Enum:
{
CreateBeforeDelete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
zonalPlatformFaultDomainAlignMode:
{
Description: Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. ,
Enum:
{
Aligned: No description available. ,
Unaligned: No description available. ,
}
,
Required: False ,
}
enum ,
skuProfile:
{
Description: Specifies the sku profile for the virtual machine scale set. ,
Required: False ,
}
{
vmSizes:
{
Description: Specifies the VM sizes for the virtual machine scale set. ,
Required: False ,
}
[
{
name:
{
Description: Specifies the name of the VM Size. ,
Required: False ,
}
string ,
rank:
{
Description: Specifies the rank (a.k.a priority) associated with the VM Size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
allocationStrategy:
{
Description: Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. ,
Enum:
{
LowestPrice: No description available. ,
CapacityOptimized: No description available. ,
Prioritized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The identity of the virtual machine scale set, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
zones:
{
Description: The virtual machine scale set zones. ,
Required: False ,
}
[
string ,
]
,
extendedLocation:
{
Description: The extended location of the Virtual Machine Scale Set. ,
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 ,
}
,
etag:
{
Description: Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets. ,
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 ,
}
,
}
VirtualMachineScaleSets_ListSkus (new)
Description :  Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 skus available for the virtual machine scale set. ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the sku applies to. ,
Required: False ,
}
string ,
sku:
{
Description: The Sku. ,
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 ,
}
,
capacity:
{
Description: Specifies the number of virtual machines in the scale set. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity that can be set. ,
Format: int64 ,
Required: False ,
}
integer ,
defaultCapacity:
{
Description: The default capacity. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
Automatic: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus. ,
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 ,
}
,
}
VirtualMachineScaleSets_GetOSUpgradeHistory (new)
Description :  Gets list of OS upgrades on a VM scale set instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 OS upgrades performed on the virtual machine scale set. ,
Required: True ,
}
[
{
properties:
{
Description: Information about the properties of the upgrade operation. ,
Required: False ,
}
{
runningStatus:
{
Description: Information about the overall status of the upgrade operation. ,
Required: False ,
}
{
code:
{
Description: Code indicating the current status of the upgrade. ,
Enum:
{
RollingForward: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the upgrade. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the upgrade. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
progress:
{
Description: Counts of the VMs in each state. ,
Required: False ,
}
{
successfulInstanceCount:
{
Description: The number of instances that have been successfully upgraded. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstanceCount:
{
Description: The number of instances that have failed to be upgraded successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
inProgressInstanceCount:
{
Description: The number of instances that are currently being upgraded. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingInstanceCount:
{
Description: The number of instances that have not yet begun to be upgraded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Description: Error Details for this upgrade if there are any. ,
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 ,
}
,
startedBy:
{
Description: Invoker of the Upgrade Operation ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
targetImageReference:
{
Description: Image Reference details ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
rollbackInfo:
{
Description: Information about OS rollback if performed ,
Required: False ,
}
{
successfullyRolledbackInstanceCount:
{
Description: The number of instances which have been successfully rolled back. ,
Format: int32 ,
Required: False ,
}
integer ,
failedRolledbackInstanceCount:
{
Description: The number of instances which failed to rollback. ,
Format: int32 ,
Required: False ,
}
integer ,
rollbackError:
{
Description: Error details if OS rollback failed. ,
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 ,
}
,
}
,
}
,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades. ,
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 ,
}
,
}
VirtualMachineScaleSets_PowerOff (new)
Description :  Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Additionally, this operation is not allowed on virtual machines in a VM scale set that are being deallocated or have already been deallocated.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
Required: False ,
}
[
string ,
]
,
}
,
skipShutdown:
{
Description: The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_Restart (new)
Description :  Restarts one or more virtual machines in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_Start (new)
Description :  Starts one or more virtual machines in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_Reapply (new)
Description :  Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reapply
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 (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 ,
}
,
}
VirtualMachineScaleSets_Redeploy (new)
Description :  Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_PerformMaintenance (new)
Description :  Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_UpdateInstances (new)
Description :  Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: True ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. ,
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 (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 ,
}
,
}
VirtualMachineScaleSets_Reimage (new)
Description :  Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmScaleSetReimageInput:
{
Description: Parameters for Reimaging VM ScaleSet. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_ReimageAll (new)
Description :  Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_ApproveRollingUpgrade (new)
Description :  Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approveRollingUpgrade
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
vmInstanceIDs:
{
Description: A list of virtual machine instance IDs from the VM scale set. ,
Required: False ,
}
{
instanceIds:
{
Description: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. ,
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)

{
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 ,
}
,
}
VirtualMachineScaleSetRollingUpgrades_Cancel (new)
Description :  Cancels the current virtual machine scale set rolling upgrade.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 (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 ,
}
,
}
VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade (new)
Description :  Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 (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 ,
}
,
}
VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade (new)
Description :  Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 (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 ,
}
,
}
VirtualMachineScaleSetRollingUpgrades_GetLatest (new)
Description :  Gets the status of the latest virtual machine scale set rolling upgrade.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 status of the latest virtual machine scale set rolling upgrade. ,
Required: False ,
}
{
policy:
{
Description: The rolling upgrade policies applied for this upgrade. ,
Required: False ,
}
{
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). ,
Required: False ,
}
string ,
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. ,
Required: False ,
}
boolean ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
maxSurge:
{
Description: Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. ,
Required: False ,
}
boolean ,
}
,
runningStatus:
{
Description: Information about the current running state of the overall upgrade. ,
Required: False ,
}
{
code:
{
Description: Code indicating the current status of the upgrade. ,
Enum:
{
RollingForward: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Faulted: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the upgrade. ,
Format: date-time ,
Required: False ,
}
string ,
lastAction:
{
Description: The last action performed on the rolling upgrade. ,
Enum:
{
Start: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
lastActionTime:
{
Description: Last action time of the upgrade. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
progress:
{
Description: Information about the number of virtual machine instances in each upgrade state. ,
Required: False ,
}
{
successfulInstanceCount:
{
Description: The number of instances that have been successfully upgraded. ,
Format: int32 ,
Required: False ,
}
integer ,
failedInstanceCount:
{
Description: The number of instances that have failed to be upgraded successfully. ,
Format: int32 ,
Required: False ,
}
integer ,
inProgressInstanceCount:
{
Description: The number of instances that are currently being upgraded. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingInstanceCount:
{
Description: The number of instances that have not yet begun to be upgraded. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Description: Error details for this upgrade, if there are any. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk (new)
Description :  Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale 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 ,
platformUpdateDomain:
{
Description: The platform update domain for which a manual recovery walk is requested ,
Required: True ,
}
integer ,
zone:
{
Description: The zone in which the manual recovery walk is requested for cross zone virtual machine scale set ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group id for which the manual recovery walk is requested. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
walkPerformed:
{
Description: Whether the recovery walk was performed ,
Required: False ,
}
boolean ,
nextPlatformUpdateDomain:
{
Description: The next update domain that needs to be walked. Null means walk spanning all update domains has been completed ,
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 ,
}
,
}
VirtualMachineScaleSets_ConvertToSinglePlacementGroup (new)
Description :  Converts SinglePlacementGroup property to false for a existing virtual machine scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the virtual machine scale set to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: The input object for ConvertToSinglePlacementGroup API. ,
Required: True ,
}
{
activePlacementGroupId:
{
Description: Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances. ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSets_SetOrchestrationServiceState (new)
Description :  Changes ServiceState property for a given service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the virtual machine scale set to create or update. ,
Required: True ,
}
string ,
parameters:
{
Description: The input object for SetOrchestrationServiceState API. ,
Required: True ,
}
{
serviceName:
{
Description: The name of the service. ,
Enum:
{
AutomaticRepairs: No description available. ,
}
,
Required: True ,
}
enum ,
action:
{
Description: The action to be performed. ,
Enum:
{
Resume: No description available. ,
Suspend: No description available. ,
}
,
Required: True ,
}
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetVMExtensions_CreateOrUpdate (new)
Description :  The operation to create or update the VMSS VM extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}
{
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 ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Virtual Machine Extension operation. ,
Required: True ,
}
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: The location of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: The location of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: The location of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineScaleSetVMExtensions_Update (new)
Description :  The operation to update the VMSS VM extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}
{
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 ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Update Virtual Machine Extension operation. ,
Required: True ,
}
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
}
,
}
,
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)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: The location of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineScaleSetVMExtensions_Delete (new)
Description :  The operation to delete the VMSS VM extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}
{
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 ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
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 ,
}
,
}
VirtualMachineScaleSetVMExtensions_Get (new)
Description :  The operation to get the VMSS VM extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}
{
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 ,
vmExtensionName:
{
Description: The name of the virtual machine extension. ,
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)

{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: The location of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineScaleSetVMExtensions_List (new)
Description :  The operation to get all extensions of an instance in Virtual Machine Scaleset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions
{
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 ,
$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 VMSS VM extensions ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: The location of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_Reimage (new)
Description :  Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage
{
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 ,
vmScaleSetVMReimageInput:
{
Description: Parameters for the Reimaging Virtual machine in ScaleSet. ,
Required: False ,
}
{
forceUpdateOSDiskForEphemeral:
{
Description: Parameter to force update ephemeral OS disk for a virtual machine scale set VM ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetVMs_ReimageAll (new)
Description :  Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall
{
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 ,
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 (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 ,
}
,
}
VirtualMachineScaleSetVMs_ApproveRollingUpgrade (new)
Description :  Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade
{
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 ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_Deallocate (new)
Description :  Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate
{
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 ,
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 (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 ,
}
,
}
VirtualMachineScaleSetVMs_Update (new)
Description :  Updates a virtual machine of a VM scale set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VM scale set where the extension should be create or updated. ,
Required: True ,
}
string ,
instanceId:
{
Description: The instance ID of the virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Virtual Machine Scale Sets VM operation. ,
Required: True ,
}
{
instanceId:
{
Description: The virtual machine instance ID. ,
Required: False ,
}
string ,
sku:
{
Description: The virtual machine SKU. ,
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 ,
}
,
properties:
{
Description: Describes the properties of a virtual machine scale set virtual machine. ,
Required: False ,
}
{
latestModelApplied:
{
Description: Specifies whether the latest model has been applied to the virtual machine. ,
Required: False ,
}
boolean ,
vmId:
{
Description: Azure VM unique ID. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The disks information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
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 ,
}
,
]
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. ,
Required: False ,
}
string ,
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/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
resilientVMDeletionStatus:
{
Description: Specifies the resilient VM deletion status for the virtual machine. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the virtual machine. ,
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 ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
networkProfileConfiguration:
{
Description: Specifies the network profile configuration of the virtual machine. ,
Required: False ,
}
{
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
modelDefinitionApplied:
{
Description: Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. ,
Required: False ,
}
string ,
protectionPolicy:
{
Description: Specifies the protection policy of the virtual machine. ,
Required: False ,
}
{
protectFromScaleIn:
{
Description: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. ,
Required: False ,
}
boolean ,
protectFromScaleSetActions:
{
Description: Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. ,
Required: False ,
}
boolean ,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 ,
Required: False ,
}
string ,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
etag:
{
Description: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. ,
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 ,
If-Match:
{
Description: The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
instanceId:
{
Description: The virtual machine instance ID. ,
Required: False ,
}
string ,
sku:
{
Description: The virtual machine SKU. ,
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 ,
}
,
properties:
{
Description: Describes the properties of a virtual machine scale set virtual machine. ,
Required: False ,
}
{
latestModelApplied:
{
Description: Specifies whether the latest model has been applied to the virtual machine. ,
Required: False ,
}
boolean ,
vmId:
{
Description: Azure VM unique ID. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The disks information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
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 ,
}
,
]
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. ,
Required: False ,
}
string ,
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/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
resilientVMDeletionStatus:
{
Description: Specifies the resilient VM deletion status for the virtual machine. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the virtual machine. ,
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 ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
networkProfileConfiguration:
{
Description: Specifies the network profile configuration of the virtual machine. ,
Required: False ,
}
{
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
modelDefinitionApplied:
{
Description: Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. ,
Required: False ,
}
string ,
protectionPolicy:
{
Description: Specifies the protection policy of the virtual machine. ,
Required: False ,
}
{
protectFromScaleIn:
{
Description: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. ,
Required: False ,
}
boolean ,
protectFromScaleSetActions:
{
Description: Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. ,
Required: False ,
}
boolean ,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 ,
Required: False ,
}
string ,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
etag:
{
Description: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
instanceId:
{
Description: The virtual machine instance ID. ,
Required: False ,
}
string ,
sku:
{
Description: The virtual machine SKU. ,
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 ,
}
,
properties:
{
Description: Describes the properties of a virtual machine scale set virtual machine. ,
Required: False ,
}
{
latestModelApplied:
{
Description: Specifies whether the latest model has been applied to the virtual machine. ,
Required: False ,
}
boolean ,
vmId:
{
Description: Azure VM unique ID. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The disks information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
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 ,
}
,
]
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. ,
Required: False ,
}
string ,
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/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
resilientVMDeletionStatus:
{
Description: Specifies the resilient VM deletion status for the virtual machine. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the virtual machine. ,
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 ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
networkProfileConfiguration:
{
Description: Specifies the network profile configuration of the virtual machine. ,
Required: False ,
}
{
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
modelDefinitionApplied:
{
Description: Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. ,
Required: False ,
}
string ,
protectionPolicy:
{
Description: Specifies the protection policy of the virtual machine. ,
Required: False ,
}
{
protectFromScaleIn:
{
Description: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. ,
Required: False ,
}
boolean ,
protectFromScaleSetActions:
{
Description: Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. ,
Required: False ,
}
boolean ,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 ,
Required: False ,
}
string ,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
etag:
{
Description: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_Delete (new)
Description :  Deletes a virtual machine from a VM scale set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
{
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 ,
forceDeletion:
{
Description: Optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview) ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetVMs_Get (new)
Description :  Gets a virtual machine from a VM scale set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
{
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 ,
$expand:
{
Description: The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine. 'resiliencyView' will retrieve the instance view of the Virtual machine (if applicable) and include 'resilientVMDeletionStatus' as part of it. ,
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)

{
instanceId:
{
Description: The virtual machine instance ID. ,
Required: False ,
}
string ,
sku:
{
Description: The virtual machine SKU. ,
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 ,
}
,
properties:
{
Description: Describes the properties of a virtual machine scale set virtual machine. ,
Required: False ,
}
{
latestModelApplied:
{
Description: Specifies whether the latest model has been applied to the virtual machine. ,
Required: False ,
}
boolean ,
vmId:
{
Description: Azure VM unique ID. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The disks information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
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 ,
}
,
]
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. ,
Required: False ,
}
string ,
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/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
resilientVMDeletionStatus:
{
Description: Specifies the resilient VM deletion status for the virtual machine. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the virtual machine. ,
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 ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
networkProfileConfiguration:
{
Description: Specifies the network profile configuration of the virtual machine. ,
Required: False ,
}
{
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
modelDefinitionApplied:
{
Description: Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. ,
Required: False ,
}
string ,
protectionPolicy:
{
Description: Specifies the protection policy of the virtual machine. ,
Required: False ,
}
{
protectFromScaleIn:
{
Description: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. ,
Required: False ,
}
boolean ,
protectFromScaleSetActions:
{
Description: Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. ,
Required: False ,
}
boolean ,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 ,
Required: False ,
}
string ,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
etag:
{
Description: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_GetInstanceView (new)
Description :  Gets the status of a virtual machine from a VM scale set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView
{
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 ,
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)

{
platformUpdateDomain:
{
Description: The Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The disks information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
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 ,
}
,
]
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. ,
Required: False ,
}
string ,
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/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: No description available. ,
V2: 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 ,
}
,
}
VirtualMachineScaleSetVMs_List (new)
Description :  Gets a list of all virtual machines in a VM scale sets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
virtualMachineScaleSetName:
{
Description: The name of the VM scale set. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'. ,
Required: False ,
}
string ,
$select:
{
Description: The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'. ,
Required: False ,
}
string ,
$expand:
{
Description: The expand expression to apply to the operation. Allowed values are 'instanceView'. ,
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 virtual machine scale sets VMs. ,
Required: True ,
}
[
{
instanceId:
{
Description: The virtual machine instance ID. ,
Required: False ,
}
string ,
sku:
{
Description: The virtual machine SKU. ,
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 ,
}
,
properties:
{
Description: Describes the properties of a virtual machine scale set virtual machine. ,
Required: False ,
}
{
latestModelApplied:
{
Description: Specifies whether the latest model has been applied to the virtual machine. ,
Required: False ,
}
boolean ,
vmId:
{
Description: Azure VM unique ID. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine instance view. ,
Required: False ,
}
{
platformUpdateDomain:
{
Description: The Update Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
platformFaultDomain:
{
Description: The Fault Domain count. ,
Format: int32 ,
Required: False ,
}
integer ,
rdpThumbPrint:
{
Description: The Remote desktop certificate thumbprint. ,
Required: False ,
}
string ,
vmAgent:
{
Description: The VM Agent running on the virtual machine. ,
Required: False ,
}
{
vmAgentVersion:
{
Description: The VM Agent full version. ,
Required: False ,
}
string ,
extensionHandlers:
{
Description: The virtual machine extension handler instance view. ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: The extension handler status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
maintenanceRedeployStatus:
{
Description: The Maintenance Operation status on the virtual machine. ,
Required: False ,
}
{
isCustomerInitiatedMaintenanceAllowed:
{
Description: True, if customer is allowed to perform Maintenance. ,
Required: False ,
}
boolean ,
preMaintenanceWindowStartTime:
{
Description: Start Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
preMaintenanceWindowEndTime:
{
Description: End Time for the Pre Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowStartTime:
{
Description: Start Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceWindowEndTime:
{
Description: End Time for the Maintenance Window. ,
Format: date-time ,
Required: False ,
}
string ,
lastOperationResultCode:
{
Description: The Last Maintenance Operation Result Code. ,
Enum:
{
None: No description available. ,
RetryLater: No description available. ,
MaintenanceAborted: No description available. ,
MaintenanceCompleted: No description available. ,
}
,
Required: False ,
}
enum ,
lastOperationMessage:
{
Description: Message returned for the last Maintenance Operation. ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The disks information. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
extensions:
{
Description: The extensions information. ,
Required: False ,
}
[
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
]
,
vmHealth:
{
Description: The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes. ,
Required: False ,
}
{
status:
{
Description: The health status information for the VM. ,
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 ,
}
,
}
,
bootDiagnostics:
{
Description: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. 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 ,
}
{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. ,
Required: False ,
}
string ,
status:
{
Description: The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. ,
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 ,
}
,
}
,
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 ,
}
,
]
,
assignedHost:
{
Description: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. ,
Required: False ,
}
string ,
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/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine [V1, V2] ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hardwareProfile:
{
Description: Specifies the hardware settings for the virtual machine. ,
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 ,
}
,
}
,
resilientVMDeletionStatus:
{
Description: Specifies the resilient VM deletion status for the virtual machine. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: Specifies the storage settings for the virtual machine disks. ,
Required: False ,
}
{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}
,
additionalCapabilities:
{
Description: Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. ,
Required: False ,
}
{
ultraSSDEnabled:
{
Description: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. ,
Required: False ,
}
boolean ,
hibernationEnabled:
{
Description: The flag that enables or disables hibernation capability on the VM. ,
Required: False ,
}
boolean ,
}
,
osProfile:
{
Description: Specifies the operating system settings for the virtual machine. ,
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 ,
}
,
securityProfile:
{
Description: Specifies the Security related profile settings for the virtual machine. ,
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 ,
}
,
}
,
}
,
networkProfile:
{
Description: Specifies the network interfaces of the virtual machine. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Describes a network interface reference properties. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
networkApiVersion:
{
Description: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations ,
Enum:
{
2020-11-01: No description available. ,
}
,
Required: False ,
}
enum ,
networkInterfaceConfigurations:
{
Description: Specifies the networking configurations that will be used to create the virtual machine networking resources. ,
Required: False ,
}
[
{
name:
{
Description: The network interface configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine network interface IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
deleteOption:
{
Description: Specify what happens to the public IP address when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
publicIPAllocationMethod:
{
Description: Specify the public IP allocation type ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
dscpConfiguration:
{
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
networkProfileConfiguration:
{
Description: Specifies the network profile configuration of the virtual machine. ,
Required: False ,
}
{
networkInterfaceConfigurations:
{
Description: The list of network configurations. ,
Required: False ,
}
[
{
name:
{
Description: The network configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration. ,
Required: False ,
}
{
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
disableTcpStateTracking:
{
Description: Specifies whether the network interface is disabled for tcp state tracking. ,
Required: False ,
}
boolean ,
enableFpga:
{
Description: Specifies whether the network interface is FPGA networking-enabled. ,
Required: False ,
}
boolean ,
networkSecurityGroup:
{
Description: The network security group. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
dnsSettings:
{
Description: The dns settings to be applied on the network interfaces. ,
Required: False ,
}
{
dnsServers:
{
Description: List of DNS servers IP addresses ,
Required: False ,
}
[
string ,
]
,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: The IP configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machine scale set network profile's IP configuration properties. ,
Required: False ,
}
{
subnet:
{
Description: Specifies the identifier of the subnet. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
primary:
{
Description: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ,
Required: False ,
}
boolean ,
publicIPAddressConfiguration:
{
Description: The publicIPAddressConfiguration. ,
Required: False ,
}
{
name:
{
Description: The publicIP address configuration name. ,
Required: True ,
}
string ,
properties:
{
Description: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration ,
Required: False ,
}
{
idleTimeoutInMinutes:
{
Description: The idle timeout of the public IP address. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsSettings:
{
Description: The dns settings to be applied on the publicIP addresses . ,
Required: False ,
}
{
domainNameLabel:
{
Description: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Required: True ,
}
string ,
domainNameLabelScope:
{
Description: The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
ipTags:
{
Description: The list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: False ,
}
string ,
}
,
]
,
publicIPPrefix:
{
Description: The PublicIPPrefix from which to allocate publicIP addresses. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
publicIPAddressVersion:
{
Description: Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specify what happens to the public IP when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. ,
Required: False ,
}
{
name:
{
Description: Specify public IP sku name ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Specify public IP sku tier ,
Enum:
{
Regional: No description available. ,
Global: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateIPAddressVersion:
{
Description: Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
applicationSecurityGroups:
{
Description: Specifies an array of references to application security group. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
enableIPForwarding:
{
Description: Whether IP forwarding enabled on this NIC. ,
Required: False ,
}
boolean ,
deleteOption:
{
Description: Specify what happens to the network interface when the VM is deleted ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliaryMode:
{
Description: Specifies whether the Auxiliary mode is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
AcceleratedConnections: No description available. ,
Floating: No description available. ,
}
,
Required: False ,
}
enum ,
auxiliarySku:
{
Description: Specifies whether the Auxiliary sku is enabled for the Network Interface resource. ,
Enum:
{
None: No description available. ,
A1: No description available. ,
A2: No description available. ,
A4: No description available. ,
A8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
diagnosticsProfile:
{
Description: Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. ,
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 ,
}
,
}
,
availabilitySet:
{
Description: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
licenseType:
{
Description: Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 ,
Required: False ,
}
string ,
modelDefinitionApplied:
{
Description: Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. ,
Required: False ,
}
string ,
protectionPolicy:
{
Description: Specifies the protection policy of the virtual machine. ,
Required: False ,
}
{
protectFromScaleIn:
{
Description: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. ,
Required: False ,
}
boolean ,
protectFromScaleSetActions:
{
Description: Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. ,
Required: False ,
}
boolean ,
}
,
userData:
{
Description: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 ,
Required: False ,
}
string ,
timeCreated:
{
Description: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: The virtual machine child extension resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a Virtual Machine Extension. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The virtual machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The virtual machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
substatuses:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
suppressFailures:
{
Description: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. ,
Required: False ,
}
boolean ,
protectedSettingsFromKeyVault:
{
Description: The extensions protected settings that are passed by reference, and consumed from key vault ,
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 ,
}
,
}
,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
zones:
{
Description: The virtual machine zones. ,
Required: False ,
}
[
string ,
]
,
identity:
{
Description: The identity of the virtual machine, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of virtual machine identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
etag:
{
Description: Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_PowerOff (new)
Description :  Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Additionally, this operation is not allowed on a virtual machine that is being deallocated or already has been deallocated.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff
{
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 ,
skipShutdown:
{
Description: The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified ,
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)

{}

⚐ 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 ,
}
,
}
VirtualMachineScaleSetVMs_Restart (new)
Description :  Restarts a virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart
{
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 ,
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 (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 ,
}
,
}
VirtualMachineScaleSetVMs_Start (new)
Description :  Starts a virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start
{
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 ,
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 (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 ,
}
,
}
VirtualMachineScaleSetVMs_Redeploy (new)
Description :  Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy
{
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 ,
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 (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 ,
}
,
}
VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData (new)
Description :  The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData
{
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 ,
sasUriExpirationTimeInMinutes:
{
Description: Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes. ,
Format: int32 ,
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)

{
consoleScreenshotBlobUri:
{
Description: The console screenshot blob URI ,
Required: False ,
}
string ,
serialConsoleLogBlobUri:
{
Description: The serial console log blob URI. ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_PerformMaintenance (new)
Description :  Performs maintenance on a virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance
{
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 ,
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 (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 ,
}
,
}
VirtualMachineScaleSetVMs_SimulateEviction (new)
Description :  The operation to simulate the eviction of spot virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction
{
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 ,
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 ,
}
,
}
VirtualMachineScaleSetVMs_AttachDetachDataDisks (new)
Description :  Attach and detach data disks to/from a virtual machine in a VM scale set.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks
{
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 attach and detach data disks operation on a Virtual Machine Scale Sets VM. ,
Required: True ,
}
{
dataDisksToAttach:
{
Description: The list of managed data disks to be attached. ,
Required: False ,
}
[
{
diskId:
{
Description: ID of the managed data disk. ,
Required: True ,
}
string ,
lun:
{
Description: 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. If not specified, lun would be auto assigned. ,
Format: int32 ,
Required: False ,
}
integer ,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. ,
Required: False ,
}
string ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
]
,
dataDisksToDetach:
{
Description: The list of managed data disks to be detached. ,
Required: False ,
}
[
{
diskId:
{
Description: ID of the managed data disk. ,
Required: True ,
}
string ,
detachOption:
{
Description: Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
imageReference:
{
Description: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. ,
Required: False ,
}
{
publisher:
{
Description: The image publisher. ,
Required: False ,
}
string ,
offer:
{
Description: Specifies the offer of the platform image or marketplace image used to create the virtual machine. ,
Required: False ,
}
string ,
sku:
{
Description: The image SKU. ,
Required: False ,
}
string ,
version:
{
Description: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. ,
Required: False ,
}
string ,
exactVersion:
{
Description: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
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 user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionSettings:
{
Description: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. ,
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: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
diffDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ,
Required: False ,
}
{
option:
{
Description: Specifies the ephemeral disk settings for operating system disk. ,
Enum:
{
Local: No description available. ,
}
,
Required: False ,
}
enum ,
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. ,
Enum:
{
CacheDisk: No description available. ,
ResourceDisk: No description available. ,
NvmeDisk: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
deleteOption:
{
Description: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
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 ,
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
vhd:
{
Description: The virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
image:
{
Description: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. ,
Required: False ,
}
{
uri:
{
Description: Specifies the virtual hard disk's uri. ,
Required: False ,
}
string ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
createOption:
{
Description: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. ,
Enum:
{
FromImage: No description available. ,
Empty: No description available. ,
Attach: No description available. ,
Copy: No description available. ,
Restore: No description available. ,
}
,
Required: True ,
}
enum ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
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 ,
}
,
}
,
sourceResource:
{
Description: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
toBeDetached:
{
Description: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset ,
Required: False ,
}
boolean ,
diskIOPSReadWrite:
{
Description: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
diskMBpsReadWrite:
{
Description: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. ,
Format: int64 ,
Required: False ,
}
integer ,
detachOption:
{
Description: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. ,
Enum:
{
ForceDetach: No description available. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. ,
Enum:
{
Delete: No description available. ,
Detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
diskControllerType:
{
Description: Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. ,
Enum:
{
SCSI: No description available. ,
NVMe: No description available. ,
}
,
Required: False ,
}
enum ,
alignRegionalDisksToVMZone:
{
Description: Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. ,
Required: False ,
}
boolean ,
}

⚐ 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 ,
}
,
}