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

2025/09/15 • 27 updated methods

CapacityReservationGroups_ListBySubscription (updated)
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 ¶

⚶ Changes

{
  "#id": "CapacityReservationGroups_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "sharingProfile",
                "Description": {
                  "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                },
                "$properties": [
                  {
                    "#name": "subscriptionIds",
                    "Description": {
                      "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                      "old": "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."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability 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. ,
Format: 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 ,
}
,
}
VirtualMachineRunCommands_Get (updated)
Description :  Gets specific run command for a subscription in a location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineRunCommands_Get",
  "$parameters": [
    {
      "#name": "commandId",
      "Description": {
        "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
        "old": "The command id."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
commandId:
{
Description: Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
}
,
]
,
}

⚐ 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 (updated)
Description :  Gets all the virtual machines under the specified subscription for the specified location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachines_ListByLocation",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "placement": [
              {
                "#name": "zonePlacementPolicy",
                "Description": {
                  "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
                  "old": "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."
                }
              },
              {
                "#name": "includeZones",
                "Description": {
                  "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
                  "old": "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."
                }
              },
              {
                "#name": "excludeZones",
                "Description": {
                  "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
                  "old": "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."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machines. ,
Required: True ,
}
[
{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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. ,
Format: 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_ListAll (updated)
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 ¶

⚶ Changes

{
  "#id": "VirtualMachines_ListAll",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "placement": [
              {
                "#name": "zonePlacementPolicy",
                "Description": {
                  "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
                  "old": "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."
                }
              },
              {
                "#name": "includeZones",
                "Description": {
                  "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
                  "old": "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."
                }
              },
              {
                "#name": "excludeZones",
                "Description": {
                  "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
                  "old": "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."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
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 ,
}
[
{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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. ,
Format: 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 ,
}
,
}
CapacityReservationGroups_ListByResourceGroup (updated)
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 ¶

⚶ Changes

{
  "#id": "CapacityReservationGroups_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "sharingProfile",
                "Description": {
                  "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                },
                "$properties": [
                  {
                    "#name": "subscriptionIds",
                    "Description": {
                      "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                      "old": "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."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: 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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability 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. ,
Format: 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 ,
}
,
}
CapacityReservationGroups_Get (updated)
Description :  The operation that retrieves information about a capacity reservation group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CapacityReservationGroups_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "sharingProfile",
            "Description": {
              "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
              "old": "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."
            },
            "$properties": [
              {
                "#name": "subscriptionIds",
                "Description": {
                  "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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 ,
}

⚐ 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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability 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_CreateOrUpdate (updated)
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 ¶

⚶ Changes

{
  "#id": "CapacityReservationGroups_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "sharingProfile",
            "Description": {
              "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
              "old": "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."
            },
            "$properties": [
              {
                "#name": "subscriptionIds",
                "Description": {
                  "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "sharingProfile",
            "Description": {
              "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
              "old": "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."
            },
            "$properties": [
              {
                "#name": "subscriptionIds",
                "Description": {
                  "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "sharingProfile",
            "Description": {
              "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
              "old": "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."
            },
            "$properties": [
              {
                "#name": "subscriptionIds",
                "Description": {
                  "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability zones. ,
Required: False ,
}
[
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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability 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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability 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 (updated)
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 ¶

⚶ Changes

{
  "#id": "CapacityReservationGroups_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "sharingProfile",
            "Description": {
              "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
              "old": "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."
            },
            "$properties": [
              {
                "#name": "subscriptionIds",
                "Description": {
                  "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "sharingProfile",
            "Description": {
              "new": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants.  Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
              "old": "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."
            },
            "$properties": [
              {
                "#name": "subscriptionIds",
                "Description": {
                  "new": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.",
                  "old": "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."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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 ,
}
,
]
,
}
,
}
,
}
,
}

⚐ 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. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **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. Block Capacity Reservations does not support sharing across subscriptions. **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: The availability 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 ,
}
,
}
CapacityReservations_ListByCapacityReservationGroup (updated)
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 ¶

⚶ Changes

{
  "#id": "CapacityReservations_ListByCapacityReservationGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "sku",
              "Description": {
                "new": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set.  For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.",
                "old": "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."
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
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. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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: The availability zones. ,
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. ,
Format: 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 ,
}
,
}
CapacityReservations_Get (updated)
Description :  The operation that retrieves information about the capacity reservation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CapacityReservations_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set.  For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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 ,
}

⚐ 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. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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: The availability 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 ,
}
,
}
CapacityReservations_CreateOrUpdate (updated)
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 ¶

⚶ Changes

{
  "#id": "CapacityReservations_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set.  For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.",
            "old": "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."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set.  For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.",
            "old": "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."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set.  For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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: The availability zones. ,
Required: False ,
}
[
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. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Specifies information about the capacity reservation. ,
}
{
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. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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: The availability 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 ,
}
,
}
CapacityReservations_Update (updated)
Description :  The operation to update a capacity reservation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CapacityReservations_Update",
  "$parameters": {
    "parameters": {
      "Description": {
        "new": "Specifies information about the capacity reservation. sku.capacity cannot be updated for Block Capacity Reservation. Tags can be update for all Capacity Reservation Types.",
        "old": "Specifies information about the capacity reservation. Only tags and sku.capacity can be updated."
      },
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "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. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. **Note:** The SKU name and capacity cannot be updated for Block capacity reservations.",
            "old": "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."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set.  For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. **Note:** The SKU name and capacity cannot be updated for Block capacity reservations. ,
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 (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. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
}
CapacityReservations_Delete (updated)
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. Note: Block capacity reservations cannot be deleted after it has been successfully allocated until the schedule end time.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CapacityReservations_Delete",
  "Description": {
    "new": "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. Note: Block capacity reservations cannot be deleted after it has been successfully allocated until the schedule end time.",
    "old": "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."
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
capacityReservationGroupName:
{
Description: The name of the capacity reservation group. ,
Required: True ,
}
string ,
capacityReservationName:
{
Description: The name of the capacity reservation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_RunCommand (updated)
Description :  Run command on a virtual machine in a VM scale set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineScaleSetVMs_RunCommand",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "commandId",
          "Description": {
            "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
            "old": "The run command id."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommand
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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: Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 ,
}
,
]
,
}
,
}

⚐ 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)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
}
VirtualMachineScaleSetVMRunCommands_List (updated)
Description :  The operation to get all run commands of an instance in Virtual Machine Scaleset.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineScaleSetVMRunCommands_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "source": [
                  {
                    "#name": "commandId",
                    "Description": {
                      "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                      "old": "Specifies a commandId of predefined built-in script."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VirtualMachineScaleSet ,
Required: True ,
}
string ,
instanceId:
{
Description: The name of the VirtualMachineScaleSetVM ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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. ,
Format: 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 ,
}
,
}
VirtualMachineScaleSetVMRunCommands_Get (updated)
Description :  The operation to get the VMSS VM run command.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineScaleSetVMRunCommands_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VirtualMachineScaleSet ,
Required: True ,
}
string ,
instanceId:
{
Description: The name of the VirtualMachineScaleSetVM ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the VirtualMachineRunCommand ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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_CreateOrUpdate (updated)
Description :  The operation to create or update the VMSS VM run command.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineScaleSetVMRunCommands_CreateOrUpdate",
  "$parameters": {
    "runCommand": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VirtualMachineScaleSet ,
Required: True ,
}
string ,
instanceId:
{
Description: The name of the VirtualMachineScaleSetVM ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the VirtualMachineRunCommand ,
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 (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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Virtual Machine run command. ,
}
{
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 (updated)
Description :  The operation to update the VMSS VM run command.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineScaleSetVMRunCommands_Update",
  "$parameters": {
    "runCommand": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmScaleSetName:
{
Description: The name of the VirtualMachineScaleSet ,
Required: True ,
}
string ,
instanceId:
{
Description: The name of the VirtualMachineScaleSetVM ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the VirtualMachineRunCommand ,
Required: True ,
}
string ,
runCommand:
{
Description: Resource create parameters. ,
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 (200)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Virtual Machine run command. ,
}
{
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 ,
}
,
}
VirtualMachines_List (updated)
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 ¶

⚶ Changes

{
  "#id": "VirtualMachines_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "placement": [
              {
                "#name": "zonePlacementPolicy",
                "Description": {
                  "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
                  "old": "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."
                }
              },
              {
                "#name": "includeZones",
                "Description": {
                  "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
                  "old": "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."
                }
              },
              {
                "#name": "excludeZones",
                "Description": {
                  "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
                  "old": "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."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$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 ,
}
[
{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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. ,
Format: 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_Get (updated)
Description :  Retrieves information about the model view or the instance view of a virtual machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachines_Get",
  "$responses": {
    "200": {
      "$properties": {
        "placement": [
          {
            "#name": "zonePlacementPolicy",
            "Description": {
              "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
              "old": "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."
            }
          },
          {
            "#name": "includeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          },
          {
            "#name": "excludeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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_CreateOrUpdate (updated)
Description :  The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachines_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "placement": [
          {
            "#name": "zonePlacementPolicy",
            "Description": {
              "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
              "old": "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."
            }
          },
          {
            "#name": "includeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          },
          {
            "#name": "excludeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "placement": [
          {
            "#name": "zonePlacementPolicy",
            "Description": {
              "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
              "old": "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."
            }
          },
          {
            "#name": "includeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          },
          {
            "#name": "excludeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "placement": [
          {
            "#name": "zonePlacementPolicy",
            "Description": {
              "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
              "old": "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."
            }
          },
          {
            "#name": "includeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          },
          {
            "#name": "excludeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 ,
parameters:
{
Description: Parameters supplied to the Create Virtual Machine operation. ,
Required: True ,
}
{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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 (200)

{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Virtual Machine. ,
}
{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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 (updated)
Description :  The operation to update a virtual machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachines_Update",
  "$responses": {
    "200": {
      "$properties": {
        "placement": [
          {
            "#name": "zonePlacementPolicy",
            "Description": {
              "new": "Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.",
              "old": "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."
            }
          },
          {
            "#name": "includeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          },
          {
            "#name": "excludeZones",
            "Description": {
              "new": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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.",
              "old": "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."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
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 ,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
]
,
}
,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Virtual Machine. ,
}
{
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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 ,
}
object ,
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 ,
}
object ,
}
,
}
,
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. **This feature is still in preview**. 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) ,
Format: password ,
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. ,
2022-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 health status for the VM. ,
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 ,
}
,
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 ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
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 availability 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 resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. ,
Enum:
{
Any: No description available. ,
}
,
Required: False ,
}
enum ,
includeZones:
{
Description: This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', 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'/'Auto', 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_RunCommand (updated)
Description :  Run command on the VM.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachines_RunCommand",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "commandId",
          "Description": {
            "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
            "old": "The run command id."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Run command operation. ,
Required: True ,
}
{
commandId:
{
Description: Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 ,
}
,
]
,
}
,
}

⚐ 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)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
}
VirtualMachineRunCommands_ListByVirtualMachine (updated)
Description :  The operation to get all run commands of a Virtual Machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineRunCommands_ListByVirtualMachine",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "source": [
                  {
                    "#name": "commandId",
                    "Description": {
                      "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                      "old": "Specifies a commandId of predefined built-in script."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the VirtualMachine ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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. ,
Format: 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 ,
}
,
}
VirtualMachineRunCommands_GetByVirtualMachine (updated)
Description :  The operation to get the run command.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineRunCommands_GetByVirtualMachine",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the VirtualMachine ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the VirtualMachineRunCommand ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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_CreateOrUpdate (updated)
Description :  The operation to create or update the run command.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineRunCommands_CreateOrUpdate",
  "$parameters": {
    "runCommand": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the VirtualMachine ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the VirtualMachineRunCommand ,
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 (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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Virtual Machine run command. ,
}
{
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 (updated)
Description :  The operation to update the run command.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualMachineRunCommands_Update",
  "$parameters": {
    "runCommand": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "source": [
              {
                "#name": "commandId",
                "Description": {
                  "new": "Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands.",
                  "old": "Specifies a commandId of predefined built-in script."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the VirtualMachine ,
Required: True ,
}
string ,
runCommandName:
{
Description: The name of the VirtualMachineRunCommand ,
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 (200)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Virtual Machine run command. ,
}
{
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. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. ,
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 ,
}
,
}