Virtual Machine Scale Set VMs - List

Gets a list of all virtual machines in a VM scale sets.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines?api-version=2022-11-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines?$filter={$filter}&$select={$select}&$expand={$expand}&api-version=2022-11-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

virtualMachineScaleSetName
path True
  • string

The name of the VM scale set.

api-version
query True
  • string

Client Api Version.

$expand
query
  • string

The expand expression to apply to the operation. Allowed values are 'instanceView'.

$filter
query
  • string

The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'.

$select
query
  • string

The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

VirtualMachineScaleSetVMs_List_MaximumSet_Gen
VirtualMachineScaleSetVMs_List_MinimumSet_Gen

VirtualMachineScaleSetVMs_List_MaximumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaa/virtualMachines?$filter=aaaaaaaaaaaaaa&$select=aaaaaaaaaaaaaaaaaaaaa&$expand=aaaaaaaaaaaaa&api-version=2022-11-01

Sample Response

{
  "value": [
    {
      "name": "{vmss-vm-name}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
      "type": "Microsoft.Compute/virtualMachines",
      "location": "westus",
      "tags": {},
      "properties": {
        "latestModelApplied": true,
        "modelDefinitionApplied": "VirtualMachineScaleSet",
        "networkProfileConfiguration": {
          "networkInterfaceConfigurations": [
            {
              "name": "vmsstestnetconfig5415",
              "properties": {
                "primary": true,
                "enableAcceleratedNetworking": true,
                "dnsSettings": {
                  "dnsServers": []
                },
                "enableIPForwarding": true,
                "ipConfigurations": [
                  {
                    "name": "vmsstestnetconfig9693",
                    "properties": {
                      "subnet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                      },
                      "privateIPAddressVersion": "IPv4",
                      "primary": true,
                      "publicIPAddressConfiguration": {
                        "name": "aaaaaaaaaaaaaaaaaa",
                        "properties": {
                          "idleTimeoutInMinutes": 18,
                          "dnsSettings": {
                            "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
                          },
                          "ipTags": [
                            {
                              "ipTagType": "aaaaaaa",
                              "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
                            }
                          ],
                          "publicIPPrefix": {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          },
                          "publicIPAddressVersion": "IPv4",
                          "deleteOption": "Delete"
                        },
                        "sku": {
                          "name": "Basic",
                          "tier": "Regional"
                        }
                      },
                      "applicationGatewayBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "applicationSecurityGroups": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "loadBalancerBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "loadBalancerInboundNatPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ]
                    },
                    "id": "aaaaaaaaa"
                  }
                ],
                "enableFpga": true,
                "networkSecurityGroup": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "deleteOption": "Delete"
              },
              "id": "aaaaaaaa"
            }
          ]
        },
        "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
        "hardwareProfile": {
          "vmSize": "Basic_A0",
          "vmSizeProperties": {
            "vCPUsAvailable": 9,
            "vCPUsPerCore": 12
          }
        },
        "storageProfile": {
          "imageReference": {
            "publisher": "MicrosoftWindowsServer",
            "offer": "WindowsServer",
            "sku": "2012-R2-Datacenter",
            "version": "4.127.20180315",
            "exactVersion": "4.127.20180315",
            "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
            "id": "a"
          },
          "osDisk": {
            "osType": "Windows",
            "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
            "createOption": "FromImage",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
              "diskEncryptionSet": {
                "id": "aaaaaaaaaaaa"
              }
            },
            "diskSizeGB": 127,
            "encryptionSettings": {
              "diskEncryptionKey": {
                "secretUrl": "aaaaaaaa",
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                }
              },
              "keyEncryptionKey": {
                "keyUrl": "aaaaaaaaaaaaaa",
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                }
              },
              "enabled": true
            },
            "vhd": {
              "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
            },
            "image": {
              "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
            },
            "writeAcceleratorEnabled": true,
            "diffDiskSettings": {
              "option": "Local",
              "placement": "CacheDisk"
            },
            "deleteOption": "Delete"
          },
          "dataDisks": [
            {
              "lun": 1,
              "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
              "createOption": "Empty",
              "caching": "None",
              "managedDisk": {
                "storageAccountType": "Standard_LRS",
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
                "diskEncryptionSet": {
                  "id": "aaaaaaaaaaaa"
                }
              },
              "diskSizeGB": 128,
              "toBeDetached": true,
              "vhd": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "image": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "writeAcceleratorEnabled": true,
              "diskIOPSReadWrite": 18,
              "diskMBpsReadWrite": 29,
              "detachOption": "ForceDetach",
              "deleteOption": "Delete"
            }
          ]
        },
        "osProfile": {
          "computerName": "test000000",
          "adminUsername": "Foo12",
          "windowsConfiguration": {
            "provisionVMAgent": true,
            "enableAutomaticUpdates": true,
            "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "additionalUnattendContent": [
              {
                "passName": "OobeSystem",
                "componentName": "Microsoft-Windows-Shell-Setup",
                "settingName": "AutoLogon",
                "content": "aaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "patchSettings": {
              "patchMode": "Manual",
              "enableHotpatching": true,
              "assessmentMode": "ImageDefault"
            },
            "winRM": {
              "listeners": [
                {
                  "protocol": "Http",
                  "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
                }
              ]
            }
          },
          "secrets": [],
          "allowExtensionOperations": true,
          "requireGuestProvisionSignal": true,
          "customData": "aaaa",
          "linuxConfiguration": {
            "disablePasswordAuthentication": true,
            "ssh": {
              "publicKeys": [
                {
                  "path": "aaa",
                  "keyData": "aaaaaa"
                }
              ]
            },
            "provisionVMAgent": true,
            "patchSettings": {
              "patchMode": "ImageDefault",
              "assessmentMode": "ImageDefault"
            }
          }
        },
        "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
        "networkProfile": {
          "networkInterfaces": [
            {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
              "properties": {
                "primary": true,
                "deleteOption": "Delete"
              }
            }
          ],
          "networkApiVersion": "2020-11-01",
          "networkInterfaceConfigurations": [
            {
              "name": "aaaaaaaaaaa",
              "properties": {
                "primary": true,
                "deleteOption": "Delete",
                "enableAcceleratedNetworking": true,
                "enableFpga": true,
                "enableIPForwarding": true,
                "networkSecurityGroup": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "dnsSettings": {
                  "dnsServers": [
                    "aaaaaa"
                  ]
                },
                "ipConfigurations": [
                  {
                    "name": "aa",
                    "properties": {
                      "subnet": {
                        "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                      },
                      "primary": true,
                      "publicIPAddressConfiguration": {
                        "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                        "properties": {
                          "idleTimeoutInMinutes": 2,
                          "deleteOption": "Delete",
                          "dnsSettings": {
                            "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                          },
                          "ipTags": [
                            {
                              "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
                              "tag": "aaaaaaaaaaaaaaaaaaaa"
                            }
                          ],
                          "publicIPPrefix": {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          },
                          "publicIPAddressVersion": "IPv4",
                          "publicIPAllocationMethod": "Dynamic"
                        },
                        "sku": {
                          "name": "Basic",
                          "tier": "Regional"
                        }
                      },
                      "privateIPAddressVersion": "IPv4",
                      "applicationSecurityGroups": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "applicationGatewayBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "loadBalancerBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ]
                    }
                  }
                ],
                "dscpConfiguration": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                }
              }
            }
          ]
        },
        "diagnosticsProfile": {
          "bootDiagnostics": {
            "enabled": true,
            "storageUri": "aaaaaaaaaaaaa"
          }
        },
        "provisioningState": "Succeeded",
        "instanceView": {
          "platformUpdateDomain": 23,
          "platformFaultDomain": 14,
          "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "vmAgent": {
            "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
            "extensionHandlers": [
              {
                "type": "aaaaaaaaaaaaa",
                "typeHandlerVersion": "aaaaa",
                "status": {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              }
            ],
            "statuses": [
              {
                "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                "level": "Info",
                "displayStatus": "aaaaaa",
                "message": "a",
                "time": "2021-11-30T12:58:26.522Z"
              }
            ]
          },
          "maintenanceRedeployStatus": {
            "isCustomerInitiatedMaintenanceAllowed": true,
            "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
            "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
            "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
            "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
            "lastOperationResultCode": "None",
            "lastOperationMessage": "aaaaaa"
          },
          "disks": [
            {
              "name": "aaaaaaaaaaa",
              "encryptionSettings": [
                {
                  "diskEncryptionKey": {
                    "secretUrl": "aaaaaaaa",
                    "sourceVault": {
                      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                    }
                  },
                  "keyEncryptionKey": {
                    "keyUrl": "aaaaaaaaaaaaaa",
                    "sourceVault": {
                      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                    }
                  },
                  "enabled": true
                }
              ],
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            }
          ],
          "extensions": [
            {
              "name": "aaaaaaaaaaaaaaaaa",
              "type": "aaaaaaaaa",
              "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
              "substatuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ],
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            }
          ],
          "vmHealth": {
            "status": {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          },
          "bootDiagnostics": {
            "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
            "serialConsoleLogBlobUri": "aaaaaaaa",
            "status": {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          },
          "statuses": [
            {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          ],
          "assignedHost": "aaaaaaa",
          "placementGroupId": "aaa"
        },
        "additionalCapabilities": {
          "ultraSSDEnabled": true,
          "hibernationEnabled": true
        },
        "securityProfile": {
          "uefiSettings": {
            "secureBootEnabled": true,
            "vTpmEnabled": true
          },
          "encryptionAtHost": true,
          "securityType": "TrustedLaunch"
        },
        "availabilitySet": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "licenseType": "aaaaaaaaaa",
        "protectionPolicy": {
          "protectFromScaleIn": true,
          "protectFromScaleSetActions": true
        }
      },
      "resources": [
        {
          "name": "CustomScriptExtension-DSC",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
          "type": "Microsoft.Compute/virtualMachines/extensions",
          "location": "westus",
          "tags": {},
          "properties": {
            "autoUpgradeMinorVersion": true,
            "provisioningState": "Succeeded",
            "publisher": "Microsoft.Compute",
            "type": "CustomScriptExtension",
            "typeHandlerVersion": "1.9",
            "settings": {},
            "forceUpdateTag": "aaaaaaa",
            "enableAutomaticUpgrade": true,
            "protectedSettings": {},
            "instanceView": {
              "name": "aaaaaaaaaaaaaaaaa",
              "type": "aaaaaaaaa",
              "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
              "substatuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ],
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            },
            "suppressFailures": true
          }
        }
      ],
      "instanceId": "aaaaaaaaaaaa",
      "sku": {
        "name": "Classic",
        "tier": "aaaaaaaaaaaaaa",
        "capacity": 29
      },
      "plan": {
        "name": "aaaaaaaaaa",
        "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
        "product": "aaaaaaaaaaaaaaaaaaaa",
        "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
      },
      "zones": [
        "a"
      ]
    }
  ],
  "nextLink": "aaaaaaaaaaaaaa"
}

VirtualMachineScaleSetVMs_List_MinimumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaa/virtualMachines?api-version=2022-11-01

Sample Response

{
  "value": [
    {
      "location": "westus"
    }
  ]
}

Definitions

AdditionalCapabilities

Enables or disables a capability on the virtual machine or virtual machine scale set.

AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

ApiEntityReference

The API entity reference.

ApiError

Api error.

ApiErrorBase

Api error base.

BootDiagnostics

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.

BootDiagnosticsInstanceView

The instance view of a virtual machine boot diagnostics.

CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

CloudError

An error response from the Compute service.

ComponentNames

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

DataDisk

Describes a data disk.

DeleteOptions

Specify what happens to the public IP when the VM is deleted

DiagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

DiffDiskOptions

Specifies the ephemeral disk settings for operating system disk.

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiffDiskSettings

Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk.

DiskControllerTypes

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 as a hyperVGeneration: 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

DiskCreateOptionTypes

Specifies how the virtual machines in the scale set should be created.

The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

DiskDeleteOptionTypes

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

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

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

The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

DiskDetachOptionTypes

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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

DiskEncryptionSetParameters

Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

DiskInstanceView

The instance view of the disk.

HardwareProfile

Specifies the hardware settings for the virtual machine.

ImageReference

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. NOTE: Image reference publisher and offer can only be set when you create the scale set.

InnerError

Inner error details.

InstanceViewStatus

Instance view status.

IPVersion

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'.

IPVersions

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'.

KeyVaultKeyReference

Describes a reference to Key Vault Key

KeyVaultSecretReference

Describes a reference to Key Vault Secret

LinuxConfiguration

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

LinuxPatchAssessmentMode

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.

LinuxPatchSettings

Specifies settings related to VM Guest Patching on Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

LinuxVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

LinuxVMGuestPatchMode

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

MaintenanceOperationResultCodeTypes

The Last Maintenance Operation Result Code.

MaintenanceRedeployStatus

Maintenance Operation Status.

ManagedDiskParameters

The parameters of a managed disk.

NetworkApiVersion

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'

NetworkInterfaceReference

Describes a network interface reference.

NetworkProfile

Specifies the network interfaces or the networking configuration of the virtual machine.

OperatingSystemTypes

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

OSDisk

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.

OSProfile

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

PassNames

The pass name. Currently, the only allowable value is OobeSystem.

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

Plan

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.

ProtocolTypes

Specifies the protocol of WinRM listener.

Possible values are:
http

https

PublicIPAddressSku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

PublicIPAddressSkuName

Specify public IP sku name

PublicIPAddressSkuTier

Specify public IP sku tier

PublicIPAllocationMethod

Specify the public IP allocation type

ResourceIdentityType

The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.

securityEncryptionTypes

Specifies the EncryptionType of the managed disk.
It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob.

NOTE: It can be set for only Confidential VMs.

SecurityProfile

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set.

SettingNames

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

Sku

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

SshConfiguration

SSH configuration for Linux based VMs running on Azure

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

StatusLevelTypes

The level code.

StorageAccountTypes

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.

StorageProfile

Specifies the storage settings for the virtual machine disks.

SubResource
UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Minimum api-version: 2020-12-01

UserAssignedIdentities

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}'.

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

VirtualHardDisk

Describes the uri of a disk.

VirtualMachineAgentInstanceView

The instance view of the VM Agent running on the virtual machine.

VirtualMachineExtension

Describes a Virtual Machine Extension.

VirtualMachineExtensionHandlerInstanceView

The instance view of a virtual machine extension handler.

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

VirtualMachineHealthStatus

The health status of the VM.

VirtualMachineIdentity

Identity for the virtual machine.

VirtualMachineIpTag

Contains the IP tag associated with the public IP address.

VirtualMachineNetworkInterfaceConfiguration

Describes a virtual machine network interface configurations.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Describes a virtual machines network configuration's DNS settings.

VirtualMachineNetworkInterfaceIPConfiguration

Describes a virtual machine network profile's IP configuration.

VirtualMachinePublicIPAddressConfiguration

Describes a virtual machines IP Configuration's PublicIPAddress configuration

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Describes a virtual machines network configuration's DNS settings.

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile's IP configuration.

VirtualMachineScaleSetIpTag

Contains the IP tag associated with the public IP address.

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile's network configurations.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Describes a virtual machines scale sets network configuration's DNS settings.

VirtualMachineScaleSetPublicIPAddressConfiguration

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Describes a virtual machines scale sets network configuration's DNS settings.

VirtualMachineScaleSetVM

Describes a virtual machine scale set virtual machine.

VirtualMachineScaleSetVMInstanceView

The instance view of a virtual machine scale set VM.

VirtualMachineScaleSetVMListResult

The List Virtual Machine Scale Set VMs operation response.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Describes a virtual machine scale set VM network profile.

VirtualMachineScaleSetVMProtectionPolicy

The protection policy of a virtual machine scale set VM.

VirtualMachineSizeTypes

Specifies the size of the virtual machine.

The enum data type is currently deprecated and will be removed by December 23rd 2023.

Recommended way to get the list of available sizes is using these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set.

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk.

NOTE: It can only be set for Confidential VMs

VMSizeProperties

Specifies VM Size Property settings on the virtual machine.

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

WindowsPatchAssessmentMode

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.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

WindowsVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

WindowsVMGuestPatchMode

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

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

AdditionalCapabilities

Enables or disables a capability on the virtual machine or virtual machine scale set.

Name Type Description
hibernationEnabled
  • boolean

The flag that enables or disables hibernation capability on the VM.

ultraSSDEnabled
  • boolean

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.

AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Name Type Description
componentName

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

content
  • string

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.

passName

The pass name. Currently, the only allowable value is OobeSystem.

settingName

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ApiEntityReference

The API entity reference.

Name Type Description
id
  • string

The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Api error.

Name Type Description
code
  • string

The error code.

details

The Api error details

innererror

The Api inner error

message
  • string

The error message.

target
  • string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the particular error.

BootDiagnostics

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.

Name Type Description
enabled
  • boolean

Whether boot diagnostics should be enabled on the Virtual Machine.

storageUri
  • string

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.

BootDiagnosticsInstanceView

The instance view of a virtual machine boot diagnostics.

Name Type Description
consoleScreenshotBlobUri
  • string

The console screenshot blob URI.

NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

serialConsoleLogBlobUri
  • string

The serial console log blob Uri.

NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

status

The boot diagnostics status information for the VM.

NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.

CachingTypes

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

Name Type Description
None
  • string
ReadOnly
  • string
ReadWrite
  • string

CloudError

An error response from the Compute service.

Name Type Description
error

Api error.

ComponentNames

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

Name Type Description
Microsoft-Windows-Shell-Setup
  • string

DataDisk

Describes a data disk.

Name Type Description
caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

createOption

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

deleteOption

Specifies whether data disk should be deleted or detached upon VM deletion.

Possible values:

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

detachOption

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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

diskIOPSReadWrite
  • integer

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.

diskMBpsReadWrite
  • integer

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.

diskSizeGB
  • integer

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023

image

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.

lun
  • integer

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.

managedDisk

The managed disk parameters.

name
  • string

The disk name.

toBeDetached
  • boolean

Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

vhd

The virtual hard disk.

writeAcceleratorEnabled
  • boolean

Specifies whether writeAccelerator should be enabled or disabled on the disk.

DeleteOptions

Specify what happens to the public IP when the VM is deleted

Name Type Description
Delete
  • string
Detach
  • string

DiagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

Name Type Description
bootDiagnostics

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.

DiffDiskOptions

Specifies the ephemeral disk settings for operating system disk.

Name Type Description
Local
  • string

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Name Type Description
CacheDisk
  • string
ResourceDisk
  • string

DiffDiskSettings

Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk.

Name Type Description
option

Specifies the ephemeral disk settings for operating system disk.

placement

Specifies the ephemeral disk placement for operating system disk.

Possible values are:

CacheDisk

ResourceDisk

Default: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used.

Refer to 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.

DiskControllerTypes

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 as a hyperVGeneration: 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

Name Type Description
NVMe
  • string
SCSI
  • string

DiskCreateOptionTypes

Specifies how the virtual machines in the scale set should be created.

The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

Name Type Description
Attach
  • string
Empty
  • string
FromImage
  • string

DiskDeleteOptionTypes

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

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

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

The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

Name Type Description
Delete
  • string
Detach
  • string

DiskDetachOptionTypes

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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

Name Type Description
ForceDetach
  • string

DiskEncryptionSetParameters

Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

Name Type Description
id
  • string

Resource Id

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

Name Type Description
diskEncryptionKey

Specifies the location of the disk encryption key, which is a Key Vault Secret.

enabled
  • boolean

Specifies whether disk encryption should be enabled on the virtual machine.

keyEncryptionKey

Specifies the location of the key encryption key in Key Vault.

DiskInstanceView

The instance view of the disk.

Name Type Description
encryptionSettings

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

name
  • string

The disk name.

statuses

The resource status information.

HardwareProfile

Specifies the hardware settings for the virtual machine.

Name Type Description
vmSize

Specifies the size of the virtual machine.

The enum data type is currently deprecated and will be removed by December 23rd 2023.

Recommended way to get the list of available sizes is using these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set.

vmSizeProperties

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 for more details.

ImageReference

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. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Name Type Description
communityGalleryImageId
  • string

Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

exactVersion
  • string

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'.

id
  • string

Resource Id

offer
  • string

Specifies the offer of the platform image or marketplace image used to create the virtual machine.

publisher
  • string

The image publisher.

sharedGalleryImageId
  • string

Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

sku
  • string

The image SKU.

version
  • string

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.

InnerError

Inner error details.

Name Type Description
errordetail
  • string

The internal error message or exception dump.

exceptiontype
  • string

The exception type.

InstanceViewStatus

Instance view status.

Name Type Description
code
  • string

The status code.

displayStatus
  • string

The short localizable label for the status.

level

The level code.

message
  • string

The detailed status message, including for alerts and error messages.

time
  • string

The time of the status.

IPVersion

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'.

Name Type Description
IPv4
  • string
IPv6
  • string

IPVersions

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'.

Name Type Description
IPv4
  • string
IPv6
  • string

KeyVaultKeyReference

Describes a reference to Key Vault Key

Name Type Description
keyUrl
  • string

The URL referencing a key encryption key in Key Vault.

sourceVault

The relative URL of the Key Vault containing the key.

KeyVaultSecretReference

Describes a reference to Key Vault Secret

Name Type Description
secretUrl
  • string

The URL referencing a secret in a Key Vault.

sourceVault

The relative URL of the Key Vault containing the secret.

LinuxConfiguration

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Name Type Description
disablePasswordAuthentication
  • boolean

Specifies whether password authentication should be disabled.

enableVMAgentPlatformUpdates
  • boolean

Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.

patchSettings

[Preview Feature] Specifies settings related to VM Guest Patching on Linux.

provisionVMAgent
  • boolean

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.

ssh

Specifies the ssh key configuration for a Linux OS.

LinuxPatchAssessmentMode

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.

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

LinuxPatchSettings

Specifies settings related to VM Guest Patching on Linux.

Name Type Description
assessmentMode

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.

automaticByPlatformSettings

Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

patchMode

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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Name Type Description
Always
  • string
IfRequired
  • string
Never
  • string
Unknown
  • string

LinuxVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Name Type Description
rebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

LinuxVMGuestPatchMode

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

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

MaintenanceOperationResultCodeTypes

The Last Maintenance Operation Result Code.

Name Type Description
MaintenanceAborted
  • string
MaintenanceCompleted
  • string
None
  • string
RetryLater
  • string

MaintenanceRedeployStatus

Maintenance Operation Status.

Name Type Description
isCustomerInitiatedMaintenanceAllowed
  • boolean

True, if customer is allowed to perform Maintenance.

lastOperationMessage
  • string

Message returned for the last Maintenance Operation.

lastOperationResultCode

The Last Maintenance Operation Result Code.

maintenanceWindowEndTime
  • string

End Time for the Maintenance Window.

maintenanceWindowStartTime
  • string

Start Time for the Maintenance Window.

preMaintenanceWindowEndTime
  • string

End Time for the Pre Maintenance Window.

preMaintenanceWindowStartTime
  • string

Start Time for the Pre Maintenance Window.

ManagedDiskParameters

The parameters of a managed disk.

Name Type Description
diskEncryptionSet

Specifies the customer managed disk encryption set resource id for the managed disk.

id
  • string

Resource Id

securityProfile

Specifies the security profile for the managed disk.

storageAccountType

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.

NetworkApiVersion

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'

Name Type Description
2020-11-01
  • string

NetworkInterfaceReference

Describes a network interface reference.

Name Type Description
id
  • string

Resource Id

properties.deleteOption

Specify what happens to the network interface when the VM is deleted

properties.primary
  • boolean

Specifies the primary network interface in case the virtual machine has more than 1 network interface.

NetworkProfile

Specifies the network interfaces or the networking configuration of the virtual machine.

Name Type Description
networkApiVersion

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations

networkInterfaceConfigurations

Specifies the networking configurations that will be used to create the virtual machine networking resources.

networkInterfaces

Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

OperatingSystemTypes

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

Name Type Description
Linux
  • string
Windows
  • string

OSDisk

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.

Name Type Description
caching

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage.

createOption

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

deleteOption

Specifies whether OS Disk should be deleted or detached upon VM deletion.

Possible values:

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. User cannot change the delete option for ephemeral OS Disk.

diffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

diskSizeGB
  • integer

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023

encryptionSettings

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

image

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.

managedDisk

The managed disk parameters.

name
  • string

The disk name.

osType

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

vhd

The virtual hard disk.

writeAcceleratorEnabled
  • boolean

Specifies whether writeAccelerator should be enabled or disabled on the disk.

OSProfile

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Name Type Description
adminPassword
  • string

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

For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

adminUsername
  • string

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.

allowExtensionOperations
  • boolean

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.

computerName
  • string

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.

customData
  • string

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.

customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs

For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation

linuxConfiguration

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

requireGuestProvisionSignal
  • boolean

Optional property which must either be set to True or omitted.

secrets

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 or the Azure Key Vault virtual machine extension for Windows.

windowsConfiguration

Specifies Windows operating system settings on the virtual machine.

PassNames

The pass name. Currently, the only allowable value is OobeSystem.

Name Type Description
OobeSystem
  • string

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

Name Type Description
assessmentMode

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.

automaticByPlatformSettings

Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

enableHotpatching
  • boolean

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'.

patchMode

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

Plan

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.

Name Type Description
name
  • string

The plan ID.

product
  • string

Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

promotionCode
  • string

The promotion code.

publisher
  • string

The publisher ID.

ProtocolTypes

Specifies the protocol of WinRM listener.

Possible values are:
http

https

Name Type Description
Http
  • string
Https
  • string

PublicIPAddressSku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Name Type Description
name

Specify public IP sku name

tier

Specify public IP sku tier

PublicIPAddressSkuName

Specify public IP sku name

Name Type Description
Basic
  • string
Standard
  • string

PublicIPAddressSkuTier

Specify public IP sku tier

Name Type Description
Global
  • string
Regional
  • string

PublicIPAllocationMethod

Specify the public IP allocation type

Name Type Description
Dynamic
  • string
Static
  • string

ResourceIdentityType

The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

securityEncryptionTypes

Specifies the EncryptionType of the managed disk.
It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob.

NOTE: It can be set for only Confidential VMs.

Name Type Description
DiskWithVMGuestState
  • string
VMGuestStateOnly
  • string

SecurityProfile

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Name Type Description
encryptionAtHost
  • boolean

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.

Default: The Encryption at host will be disabled unless this property is set to true for the resource.

securityType

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set.

uefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Minimum api-version: 2020-12-01

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set.

Name Type Description
ConfidentialVM
  • string
TrustedLaunch
  • string

SettingNames

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

Name Type Description
AutoLogon
  • string
FirstLogonCommands
  • string

Sku

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

Name Type Description
capacity
  • integer

Specifies the number of virtual machines in the scale set.

name
  • string

The sku name.

tier
  • string

Specifies the tier of virtual machines in a scale set.

Possible Values:

Standard

Basic

SshConfiguration

SSH configuration for Linux based VMs running on Azure

Name Type Description
publicKeys

The list of SSH public keys used to authenticate with linux based VMs.

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Name Type Description
keyData
  • string

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

path
  • string

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

StatusLevelTypes

The level code.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

StorageAccountTypes

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.

Name Type Description
PremiumV2_LRS
  • string
Premium_LRS
  • string
Premium_ZRS
  • string
StandardSSD_LRS
  • string
StandardSSD_ZRS
  • string
Standard_LRS
  • string
UltraSSD_LRS
  • string

StorageProfile

Specifies the storage settings for the virtual machine disks.

Name Type Description
dataDisks

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.

diskControllerType

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 as a hyperVGeneration: 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

imageReference

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.

osDisk

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.

SubResource

Name Type Description
id
  • string

Resource Id

UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Minimum api-version: 2020-12-01

Name Type Description
secureBootEnabled
  • boolean

Specifies whether secure boot should be enabled on the virtual machine.

Minimum api-version: 2020-12-01

vTpmEnabled
  • boolean

Specifies whether vTPM should be enabled on the virtual machine.

Minimum api-version: 2020-12-01

UserAssignedIdentities

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}'.

Name Type Description

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Name Type Description
certificateStore
  • string

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.

certificateUrl
  • string

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. 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 or the Azure Key Vault virtual machine extension for Windows.

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

Name Type Description
sourceVault

The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

vaultCertificates

The list of key vault references in SourceVault which contain certificates.

VirtualHardDisk

Describes the uri of a disk.

Name Type Description
uri
  • string

Specifies the virtual hard disk's uri.

VirtualMachineAgentInstanceView

The instance view of the VM Agent running on the virtual machine.

Name Type Description
extensionHandlers

The virtual machine extension handler instance view.

statuses

The resource status information.

vmAgentVersion
  • string

The VM Agent full version.

VirtualMachineExtension

Describes a Virtual Machine Extension.

Name Type Description
id
  • string

Resource Id

location
  • string

Resource location

name
  • string

Resource name

properties.autoUpgradeMinorVersion
  • boolean

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.

properties.enableAutomaticUpgrade
  • boolean

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

properties.forceUpdateTag
  • string

How the extension handler should be forced to update even if the extension configuration has not changed.

properties.instanceView

The virtual machine extension instance view.

properties.protectedSettings
  • object

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

properties.protectedSettingsFromKeyVault

The extensions protected settings that are passed by reference, and consumed from key vault

properties.provisioningState
  • string

The provisioning state, which only appears in the response.

properties.publisher
  • string

The name of the extension handler publisher.

properties.settings
  • object

Json formatted public settings for the extension.

properties.suppressFailures
  • boolean

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.

properties.type
  • string

Specifies the type of the extension; an example is "CustomScriptExtension".

properties.typeHandlerVersion
  • string

Specifies the version of the script handler.

tags
  • object

Resource tags

type
  • string

Resource type

VirtualMachineExtensionHandlerInstanceView

The instance view of a virtual machine extension handler.

Name Type Description
status

The extension handler status.

type
  • string

Specifies the type of the extension; an example is "CustomScriptExtension".

typeHandlerVersion
  • string

Specifies the version of the script handler.

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

Name Type Description
name
  • string

The virtual machine extension name.

statuses

The resource status information.

substatuses

The resource status information.

type
  • string

Specifies the type of the extension; an example is "CustomScriptExtension".

typeHandlerVersion
  • string

Specifies the version of the script handler.

VirtualMachineHealthStatus

The health status of the VM.

Name Type Description
status

The health status information for the VM.

VirtualMachineIdentity

Identity for the virtual machine.

Name Type Description
principalId
  • string

The principal id of virtual machine identity. This property will only be provided for a system assigned identity.

tenantId
  • string

The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.

type

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.

userAssignedIdentities

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}'.

VirtualMachineIpTag

Contains the IP tag associated with the public IP address.

Name Type Description
ipTagType
  • string

IP tag type. Example: FirstPartyUsage.

tag
  • string

IP tag associated with the public IP. Example: SQL, Storage etc.

VirtualMachineNetworkInterfaceConfiguration

Describes a virtual machine network interface configurations.

Name Type Description
name
  • string

The network interface configuration name.

properties.deleteOption

Specify what happens to the network interface when the VM is deleted

properties.disableTcpStateTracking
  • boolean

Specifies whether the network interface is disabled for tcp state tracking.

properties.dnsSettings

The dns settings to be applied on the network interfaces.

properties.dscpConfiguration
properties.enableAcceleratedNetworking
  • boolean

Specifies whether the network interface is accelerated networking-enabled.

properties.enableFpga
  • boolean

Specifies whether the network interface is FPGA networking-enabled.

properties.enableIPForwarding
  • boolean

Whether IP forwarding enabled on this NIC.

properties.ipConfigurations

Specifies the IP configurations of the network interface.

properties.networkSecurityGroup

The network security group.

properties.primary
  • boolean

Specifies the primary network interface in case the virtual machine has more than 1 network interface.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Describes a virtual machines network configuration's DNS settings.

Name Type Description
dnsServers
  • string[]

List of DNS servers IP addresses

VirtualMachineNetworkInterfaceIPConfiguration

Describes a virtual machine network profile's IP configuration.

Name Type Description
name
  • string

The IP configuration name.

properties.applicationGatewayBackendAddressPools

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.

properties.applicationSecurityGroups

Specifies an array of references to application security group.

properties.loadBalancerBackendAddressPools

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].

properties.primary
  • boolean

Specifies the primary network interface in case the virtual machine has more than 1 network interface.

properties.privateIPAddressVersion

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'.

properties.publicIPAddressConfiguration

The publicIPAddressConfiguration.

properties.subnet

Specifies the identifier of the subnet.

VirtualMachinePublicIPAddressConfiguration

Describes a virtual machines IP Configuration's PublicIPAddress configuration

Name Type Description
name
  • string

The publicIP address configuration name.

properties.deleteOption

Specify what happens to the public IP address when the VM is deleted

properties.dnsSettings

The dns settings to be applied on the publicIP addresses .

properties.idleTimeoutInMinutes
  • integer

The idle timeout of the public IP address.

properties.ipTags

The list of IP tags associated with the public IP address.

properties.publicIPAddressVersion

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'.

properties.publicIPAllocationMethod

Specify the public IP allocation type

properties.publicIPPrefix

The PublicIPPrefix from which to allocate publicIP addresses.

sku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Describes a virtual machines network configuration's DNS settings.

Name Type Description
domainNameLabel
  • string

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.

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile's IP configuration.

Name Type Description
id
  • string

Resource Id

name
  • string

The IP configuration name.

properties.applicationGatewayBackendAddressPools

Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.

properties.applicationSecurityGroups

Specifies an array of references to application security group.

properties.loadBalancerBackendAddressPools

Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.

properties.loadBalancerInboundNatPools

Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.

properties.primary
  • boolean

Specifies the primary network interface in case the virtual machine has more than 1 network interface.

properties.privateIPAddressVersion

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'.

properties.publicIPAddressConfiguration

The publicIPAddressConfiguration.

properties.subnet

Specifies the identifier of the subnet.

VirtualMachineScaleSetIpTag

Contains the IP tag associated with the public IP address.

Name Type Description
ipTagType
  • string

IP tag type. Example: FirstPartyUsage.

tag
  • string

IP tag associated with the public IP. Example: SQL, Storage etc.

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile's network configurations.

Name Type Description
id
  • string

Resource Id

name
  • string

The network configuration name.

properties.deleteOption

Specify what happens to the network interface when the VM is deleted

properties.disableTcpStateTracking
  • boolean

Specifies whether the network interface is disabled for tcp state tracking.

properties.dnsSettings

The dns settings to be applied on the network interfaces.

properties.enableAcceleratedNetworking
  • boolean

Specifies whether the network interface is accelerated networking-enabled.

properties.enableFpga
  • boolean

Specifies whether the network interface is FPGA networking-enabled.

properties.enableIPForwarding
  • boolean

Whether IP forwarding enabled on this NIC.

properties.ipConfigurations

Specifies the IP configurations of the network interface.

properties.networkSecurityGroup

The network security group.

properties.primary
  • boolean

Specifies the primary network interface in case the virtual machine has more than 1 network interface.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Describes a virtual machines scale sets network configuration's DNS settings.

Name Type Description
dnsServers
  • string[]

List of DNS servers IP addresses

VirtualMachineScaleSetPublicIPAddressConfiguration

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Name Type Description
name
  • string

The publicIP address configuration name.

properties.deleteOption

Specify what happens to the public IP when the VM is deleted

properties.dnsSettings

The dns settings to be applied on the publicIP addresses .

properties.idleTimeoutInMinutes
  • integer

The idle timeout of the public IP address.

properties.ipTags

The list of IP tags associated with the public IP address.

properties.publicIPAddressVersion

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'.

properties.publicIPPrefix

The PublicIPPrefix from which to allocate publicIP addresses.

sku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Describes a virtual machines scale sets network configuration's DNS settings.

Name Type Description
domainNameLabel
  • string

The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created

VirtualMachineScaleSetVM

Describes a virtual machine scale set virtual machine.

Name Type Description
id
  • string

Resource Id

identity

The identity of the virtual machine, if configured.

instanceId
  • string

The virtual machine instance ID.

location
  • string

Resource location

name
  • string

Resource name

plan

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.

properties.additionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

properties.availabilitySet

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.

For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

properties.diagnosticsProfile

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

properties.hardwareProfile

Specifies the hardware settings for the virtual machine.

properties.instanceView

The virtual machine instance view.

properties.latestModelApplied
  • boolean

Specifies whether the latest model has been applied to the virtual machine.

properties.licenseType
  • string

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

Azure Hybrid Use Benefit for Linux Server

Minimum api-version: 2015-06-15

properties.modelDefinitionApplied
  • string

Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.

properties.networkProfile

Specifies the network interfaces of the virtual machine.

properties.networkProfileConfiguration

Specifies the network profile configuration of the virtual machine.

properties.osProfile

Specifies the operating system settings for the virtual machine.

properties.protectionPolicy

Specifies the protection policy of the virtual machine.

properties.provisioningState
  • string

The provisioning state, which only appears in the response.

properties.securityProfile

Specifies the Security related profile settings for the virtual machine.

properties.storageProfile

Specifies the storage settings for the virtual machine disks.

properties.userData
  • string

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01

properties.vmId
  • string

Azure VM unique ID.

resources

The virtual machine child extension resources.

sku

The virtual machine SKU.

tags
  • object

Resource tags

type
  • string

Resource type

zones
  • string[]

The virtual machine zones.

VirtualMachineScaleSetVMInstanceView

The instance view of a virtual machine scale set VM.

Name Type Description
assignedHost
  • string

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.

bootDiagnostics

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.

disks

The disks information.

extensions

The extensions information.

maintenanceRedeployStatus

The Maintenance Operation status on the virtual machine.

placementGroupId
  • string

The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.

platformFaultDomain
  • integer

The Fault Domain count.

platformUpdateDomain
  • integer

The Update Domain count.

rdpThumbPrint
  • string

The Remote desktop certificate thumbprint.

statuses

The resource status information.

vmAgent

The VM Agent running on the virtual machine.

vmHealth

The health status for the VM.

VirtualMachineScaleSetVMListResult

The List Virtual Machine Scale Set VMs operation response.

Name Type Description
nextLink
  • string

The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs

value

The list of virtual machine scale sets VMs.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Describes a virtual machine scale set VM network profile.

Name Type Description
networkInterfaceConfigurations

The list of network configurations.

VirtualMachineScaleSetVMProtectionPolicy

The protection policy of a virtual machine scale set VM.

Name Type Description
protectFromScaleIn
  • boolean

Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation.

protectFromScaleSetActions
  • boolean

Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.

VirtualMachineSizeTypes

Specifies the size of the virtual machine.

The enum data type is currently deprecated and will be removed by December 23rd 2023.

Recommended way to get the list of available sizes is using these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set.

Name Type Description
Basic_A0
  • string
Basic_A1
  • string
Basic_A2
  • string
Basic_A3
  • string
Basic_A4
  • string
Standard_A0
  • string
Standard_A1
  • string
Standard_A10
  • string
Standard_A11
  • string
Standard_A1_v2
  • string
Standard_A2
  • string
Standard_A2_v2
  • string
Standard_A2m_v2
  • string
Standard_A3
  • string
Standard_A4
  • string
Standard_A4_v2
  • string
Standard_A4m_v2
  • string
Standard_A5
  • string
Standard_A6
  • string
Standard_A7
  • string
Standard_A8
  • string
Standard_A8_v2
  • string
Standard_A8m_v2
  • string
Standard_A9
  • string
Standard_B1ms
  • string
Standard_B1s
  • string
Standard_B2ms
  • string
Standard_B2s
  • string
Standard_B4ms
  • string
Standard_B8ms
  • string
Standard_D1
  • string
Standard_D11
  • string
Standard_D11_v2
  • string
Standard_D12
  • string
Standard_D12_v2
  • string
Standard_D13
  • string
Standard_D13_v2
  • string
Standard_D14
  • string
Standard_D14_v2
  • string
Standard_D15_v2
  • string
Standard_D16_v3
  • string
Standard_D16s_v3
  • string
Standard_D1_v2
  • string
Standard_D2
  • string
Standard_D2_v2
  • string
Standard_D2_v3
  • string
Standard_D2s_v3
  • string
Standard_D3
  • string
Standard_D32_v3
  • string
Standard_D32s_v3
  • string
Standard_D3_v2
  • string
Standard_D4
  • string
Standard_D4_v2
  • string
Standard_D4_v3
  • string
Standard_D4s_v3
  • string
Standard_D5_v2
  • string
Standard_D64_v3
  • string
Standard_D64s_v3
  • string
Standard_D8_v3
  • string
Standard_D8s_v3
  • string
Standard_DS1
  • string
Standard_DS11
  • string
Standard_DS11_v2
  • string
Standard_DS12
  • string
Standard_DS12_v2
  • string
Standard_DS13
  • string
Standard_DS13-2_v2
  • string
Standard_DS13-4_v2
  • string
Standard_DS13_v2
  • string
Standard_DS14
  • string
Standard_DS14-4_v2
  • string
Standard_DS14-8_v2
  • string
Standard_DS14_v2
  • string
Standard_DS15_v2
  • string
Standard_DS1_v2
  • string
Standard_DS2
  • string
Standard_DS2_v2
  • string
Standard_DS3
  • string
Standard_DS3_v2
  • string
Standard_DS4
  • string
Standard_DS4_v2
  • string
Standard_DS5_v2
  • string
Standard_E16_v3
  • string
Standard_E16s_v3
  • string
Standard_E2_v3
  • string
Standard_E2s_v3
  • string
Standard_E32-16_v3
  • string
Standard_E32-8s_v3
  • string
Standard_E32_v3
  • string
Standard_E32s_v3
  • string
Standard_E4_v3
  • string
Standard_E4s_v3
  • string
Standard_E64-16s_v3
  • string
Standard_E64-32s_v3
  • string
Standard_E64_v3
  • string
Standard_E64s_v3
  • string
Standard_E8_v3
  • string
Standard_E8s_v3
  • string
Standard_F1
  • string
Standard_F16
  • string
Standard_F16s
  • string
Standard_F16s_v2
  • string
Standard_F1s
  • string
Standard_F2
  • string
Standard_F2s
  • string
Standard_F2s_v2
  • string
Standard_F32s_v2
  • string
Standard_F4
  • string
Standard_F4s
  • string
Standard_F4s_v2
  • string
Standard_F64s_v2
  • string
Standard_F72s_v2
  • string
Standard_F8
  • string
Standard_F8s
  • string
Standard_F8s_v2
  • string
Standard_G1
  • string
Standard_G2
  • string
Standard_G3
  • string
Standard_G4
  • string
Standard_G5
  • string
Standard_GS1
  • string
Standard_GS2
  • string
Standard_GS3
  • string
Standard_GS4
  • string
Standard_GS4-4
  • string
Standard_GS4-8
  • string
Standard_GS5
  • string
Standard_GS5-16
  • string
Standard_GS5-8
  • string
Standard_H16
  • string
Standard_H16m
  • string
Standard_H16mr
  • string
Standard_H16r
  • string
Standard_H8
  • string
Standard_H8m
  • string
Standard_L16s
  • string
Standard_L32s
  • string
Standard_L4s
  • string
Standard_L8s
  • string
Standard_M128-32ms
  • string
Standard_M128-64ms
  • string
Standard_M128ms
  • string
Standard_M128s
  • string
Standard_M64-16ms
  • string
Standard_M64-32ms
  • string
Standard_M64ms
  • string
Standard_M64s
  • string
Standard_NC12
  • string
Standard_NC12s_v2
  • string
Standard_NC12s_v3
  • string
Standard_NC24
  • string
Standard_NC24r
  • string
Standard_NC24rs_v2
  • string
Standard_NC24rs_v3
  • string
Standard_NC24s_v2
  • string
Standard_NC24s_v3
  • string
Standard_NC6
  • string
Standard_NC6s_v2
  • string
Standard_NC6s_v3
  • string
Standard_ND12s
  • string
Standard_ND24rs
  • string
Standard_ND24s
  • string
Standard_ND6s
  • string
Standard_NV12
  • string
Standard_NV24
  • string
Standard_NV6
  • string

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk.

NOTE: It can only be set for Confidential VMs

Name Type Description
diskEncryptionSet

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.

securityEncryptionType

Specifies the EncryptionType of the managed disk.
It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob.

NOTE: It can be set for only Confidential VMs.

VMSizeProperties

Specifies VM Size Property settings on the virtual machine.

Name Type Description
vCPUsAvailable
  • integer

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 .

vCPUsPerCore
  • integer

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

Setting this property to 1 also means that hyper-threading is disabled.

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

Name Type Description
additionalUnattendContent

Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

enableAutomaticUpdates
  • boolean

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.

enableVMAgentPlatformUpdates
  • boolean

Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.

patchSettings

[Preview Feature] Specifies settings related to VM Guest Patching on Windows.

provisionVMAgent
  • boolean

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.

timeZone
  • string

Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.

winRM

Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

WindowsPatchAssessmentMode

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.

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Name Type Description
Always
  • string
IfRequired
  • string
Never
  • string
Unknown
  • string

WindowsVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

Name Type Description
rebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

WindowsVMGuestPatchMode

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

Name Type Description
AutomaticByOS
  • string
AutomaticByPlatform
  • string
Manual
  • string

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

Name Type Description
listeners

The list of Windows Remote Management listeners

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

Name Type Description
certificateUrl
  • string

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. 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 or the Azure Key Vault virtual machine extension for Windows.

protocol

Specifies the protocol of WinRM listener.

Possible values are:
http

https