Virtual Machine Scale Set VMs - Get

Service:

Compute

API Version:

2024-07-01

Gets a virtual machine from a VM scale set.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}?api-version=2024-07-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}?$expand={$expand}&api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string	The instance ID of the virtual machine.
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.
vmScaleSetName	path	True	string	The name of the VM scale set.
api-version	query	True	string	Client Api Version.
$expand	query		InstanceViewTypes	The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.

Responses

Name	Type	Description
200 OK	VirtualMachineScaleSetVM	OK
Other Status Codes	CloudError	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

Get VM scale set VM with UserData

Get VM scale set VM with VMSizeProperties

Get VM scale set VM with UserData

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0?api-version=2024-07-01

Java

/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
     */
    /**
     * Sample code: Get VM scale set VM with UserData.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithUserData(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "0", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_with_user_data.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithUserData() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "0", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vmsstestnetconfig5415"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(false),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vmsstestnetconfig9693"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"),
	// 									},
	// 								},
	// 						}},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("Foo12"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("test000000"),
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(true),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 					Caching: to.Ptr(armcompute.CachingTypesNone),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](128),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					ToBeDetached: to.Ptr(false),
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("4.127.20180315"),
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2012-R2-Datacenter"),
	// 				Version: to.Ptr("4.127.20180315"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 				Caching: to.Ptr(armcompute.CachingTypesNone),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](127),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("42af9fdf-b906-4ad7-9905-8316209ff619"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
 */
async function getVMScaleSetVMWithUserData() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmResource result = await virtualMachineScaleSetVm.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VirtualMachineScaleSetVmData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "latestModelApplied": true,
    "modelDefinitionApplied": "VirtualMachineScaleSet",
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "name": "vmsstestnetconfig5415",
          "properties": {
            "primary": true,
            "enableAcceleratedNetworking": false,
            "dnsSettings": {
              "dnsServers": []
            },
            "enableIPForwarding": false,
            "ipConfigurations": [
              {
                "name": "vmsstestnetconfig9693",
                "properties": {
                  "subnet": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                  },
                  "privateIPAddressVersion": "IPv4"
                }
              }
            ]
          }
        }
      ]
    },
    "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
    "hardwareProfile": {},
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "4.127.20180315",
        "exactVersion": "4.127.20180315"
      },
      "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"
        },
        "diskSizeGB": 127
      },
      "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"
          },
          "diskSizeGB": 128,
          "toBeDetached": false
        }
      ]
    },
    "osProfile": {
      "computerName": "test000000",
      "adminUsername": "Foo12",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      },
      "secrets": [],
      "allowExtensionOperations": true,
      "requireGuestProvisionSignal": true
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "provisioningState": "Succeeded"
  },
  "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": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get VM scale set VM with VMSizeProperties

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0?api-version=2024-07-01

Java

/**
 * Samples for VirtualMachineScaleSetVMs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
     */
    /**
     * Sample code: Get VM scale set VM with VMSizeProperties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithVMSizeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs()
            .getWithResponse("myResourceGroup", "{vmss-name}", "0", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_with_vm_size_properties.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="{vmss-name}",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
func ExampleVirtualMachineScaleSetVMsClient_Get_getVmScaleSetVmWithVmSizeProperties() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachineScaleSetVMsClient().Get(ctx, "myResourceGroup", "{vmss-name}", "0", &armcompute.VirtualMachineScaleSetVMsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineScaleSetVM = armcompute.VirtualMachineScaleSetVM{
	// 	Name: to.Ptr("{vmss-vm-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetVMProperties{
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		LatestModelApplied: to.Ptr(true),
	// 		ModelDefinitionApplied: to.Ptr("VirtualMachineScaleSet"),
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"),
	// 			}},
	// 		},
	// 		NetworkProfileConfiguration: &armcompute.VirtualMachineScaleSetVMNetworkProfileConfiguration{
	// 			NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 				{
	// 					Name: to.Ptr("vmsstestnetconfig5415"),
	// 					Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 						DNSSettings: &armcompute.VirtualMachineScaleSetNetworkConfigurationDNSSettings{
	// 							DNSServers: []*string{
	// 							},
	// 						},
	// 						EnableAcceleratedNetworking: to.Ptr(false),
	// 						EnableIPForwarding: to.Ptr(false),
	// 						IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 							{
	// 								Name: to.Ptr("vmsstestnetconfig9693"),
	// 								Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 									PrivateIPAddressVersion: to.Ptr(armcompute.IPVersionIPv4),
	// 									Subnet: &armcompute.APIEntityReference{
	// 										ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"),
	// 									},
	// 								},
	// 						}},
	// 						Primary: to.Ptr(true),
	// 					},
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("Foo12"),
	// 			AllowExtensionOperations: to.Ptr(true),
	// 			ComputerName: to.Ptr("test000000"),
	// 			RequireGuestProvisionSignal: to.Ptr(true),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(true),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 					Caching: to.Ptr(armcompute.CachingTypesNone),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](128),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 					},
	// 					ToBeDetached: to.Ptr(false),
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				ExactVersion: to.Ptr("4.127.20180315"),
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2012-R2-Datacenter"),
	// 				Version: to.Ptr("4.127.20180315"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 				Caching: to.Ptr(armcompute.CachingTypesNone),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](127),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesStandardLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("42af9fdf-b906-4ad7-9905-8316209ff619"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a virtual machine from a VM scale set.
 *
 * @summary Gets a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
 */
async function getVMScaleSetVMWithVMSizeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "{vmss-name}";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.get(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "{vmss-name}";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmResource result = await virtualMachineScaleSetVm.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VirtualMachineScaleSetVmData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "latestModelApplied": true,
    "modelDefinitionApplied": "VirtualMachineScaleSet",
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "name": "vmsstestnetconfig5415",
          "properties": {
            "primary": true,
            "enableAcceleratedNetworking": false,
            "dnsSettings": {
              "dnsServers": []
            },
            "enableIPForwarding": false,
            "ipConfigurations": [
              {
                "name": "vmsstestnetconfig9693",
                "properties": {
                  "subnet": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                  },
                  "privateIPAddressVersion": "IPv4"
                }
              }
            ]
          }
        }
      ]
    },
    "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
    "hardwareProfile": {
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "4.127.20180315",
        "exactVersion": "4.127.20180315"
      },
      "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"
        },
        "diskSizeGB": 127
      },
      "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"
          },
          "diskSizeGB": 128,
          "toBeDetached": false
        }
      ]
    },
    "osProfile": {
      "computerName": "test000000",
      "adminUsername": "Foo12",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      },
      "secrets": [],
      "allowExtensionOperations": true,
      "requireGuestProvisionSignal": true
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "provisioningState": "Succeeded"
  },
  "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": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Definitions

Name	Description
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.
AdditionalUnattendContent	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
ApiEntityReference	The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.
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. 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.
BootDiagnosticsInstanceView	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.
CachingTypes	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: 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	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.
DeleteOptions	Specify what happens to the network interface 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. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01.
DiffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
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 with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01.
DiskCreateOptionTypes	Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described.
DiskDeleteOptionTypes	Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk.
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. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.
DiskEncryptionSetParameters	Specifies the customer managed disk encryption set resource id for the managed disk.
DiskEncryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
DiskInstanceView	The disks information.
DomainNameLabelScopeTypes	The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.
EncryptionIdentity	Specifies the Managed Identity used by ADE to get access token for keyvault operations.
HardwareProfile	Specifies the hardware settings for the virtual machine.
HyperVGeneration	The hypervisor generation of the Virtual Machine [V1, V2]
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.
InnerError	Inner error details.
InstanceViewStatus	Instance view status.
InstanceViewTypes	The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.
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	Specifies the location of the key encryption key in Key Vault.
KeyVaultSecretReference	The extensions protected settings that are passed by reference, and consumed from key vault
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	[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
LinuxVMGuestPatchAutomaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
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	The Maintenance Operation status on the virtual machine.
ManagedDiskParameters	The managed disk parameters.
Mode	Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.
NetworkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations
NetworkInterfaceAuxiliaryMode	Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
NetworkInterfaceAuxiliarySku	Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
NetworkInterfaceReference	Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
NetworkProfile	Specifies the network interfaces of the virtual machine.
OperatingSystemTypes	The Operating System type.
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.
PassNames	The pass name. Currently, the only allowable value is OobeSystem.
PatchSettings	[Preview Feature] 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.
ProxyAgentSettings	Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.
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. 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.
securityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.
SecurityProfile	Specifies the Security related profile settings for the virtual machine.
SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
SettingNames	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
Sku	The virtual machine SKU.
SshConfiguration	Specifies the ssh key configuration for a Linux OS.
SshPublicKey	The list of SSH public keys used to authenticate with linux based VMs.
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	The relative URL of the Key Vault containing the secret.
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	The list of key vault references in SourceVault which contain certificates.
VaultSecretGroup	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.
VirtualHardDisk	The virtual hard disk.
VirtualMachineAgentInstanceView	The VM Agent running on the virtual machine.
VirtualMachineExtension	The virtual machine child extension resources.
VirtualMachineExtensionHandlerInstanceView	The virtual machine extension handler instance view.
VirtualMachineExtensionInstanceView	The virtual machine extension instance view.
VirtualMachineHealthStatus	The health status for the VM.
VirtualMachineIdentity	The identity of the virtual machine, if configured.
VirtualMachineIpTag	The list of IP tags associated with the public IP address.
VirtualMachineNetworkInterfaceConfiguration	Specifies the networking configurations that will be used to create the virtual machine networking resources.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	The dns settings to be applied on the network interfaces.
VirtualMachineNetworkInterfaceIPConfiguration	Specifies the IP configurations of the network interface.
VirtualMachinePublicIPAddressConfiguration	The publicIPAddressConfiguration.
VirtualMachinePublicIPAddressDnsSettingsConfiguration	The dns settings to be applied on the publicIP addresses .
VirtualMachineScaleSetIPConfiguration	Specifies the IP configurations of the network interface.
VirtualMachineScaleSetIpTag	The list of IP tags associated with the public IP address.
VirtualMachineScaleSetNetworkConfiguration	The list of network configurations.
VirtualMachineScaleSetNetworkConfigurationDnsSettings	The dns settings to be applied on the network interfaces.
VirtualMachineScaleSetPublicIPAddressConfiguration	The publicIPAddressConfiguration.
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	The dns settings to be applied on the publicIP addresses .
VirtualMachineScaleSetVM	Describes a virtual machine scale set virtual machine.
VirtualMachineScaleSetVMInstanceView	The virtual machine instance view.
VirtualMachineScaleSetVMNetworkProfileConfiguration	Specifies the network profile configuration of the virtual machine.
VirtualMachineScaleSetVMProtectionPolicy	Specifies the protection policy of the virtual machine.
VirtualMachineSizeTypes	Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, 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 for the managed disk.
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.
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 for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
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	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
WinRMListener	The list of Windows Remote Management listeners

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.

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 base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

Name	Type	Description
componentName	ComponentNames	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	PassNames	The pass name. Currently, the only allowable value is OobeSystem.
settingName	SettingNames	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ApiEntityReference

The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.

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	ApiErrorBase[]	The Api error details
innererror	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. 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.

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

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
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	InstanceViewStatus	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. The defaulting behavior is: 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	ApiError	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

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.

Name	Type	Description
caching	CachingTypes	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.
createOption	DiskCreateOptionTypes	Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point.
deleteOption	DiskDeleteOptionTypes	Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the data disk is deleted when VM is deleted. Detach. If this value is used, the data disk is retained after VM is deleted. The default value is set to Detach.
detachOption	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. 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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
image	VirtualHardDisk	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	ManagedDiskParameters	The managed disk parameters.
name	string	The disk name.
sourceResource	ApiEntityReference	The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.
toBeDetached	boolean	Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	The virtual hard disk.
writeAcceleratorEnabled	boolean	Specifies whether writeAccelerator should be enabled or disabled on the disk.

DeleteOptions

Specify what happens to the network interface 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	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. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01.

Name	Type	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

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

Name	Type	Description
option	DiffDiskOptions	Specifies the ephemeral disk settings for operating system disk.
placement	DiffDiskPlacement	Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01.

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 with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01.

Name	Type	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described.

Name	Type	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk.

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. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

Name	Type	Description
ForceDetach	string

DiskEncryptionSetParameters

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

Name	Type	Description
id	string	Resource Id

DiskEncryptionSettings

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	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	KeyVaultKeyReference	Specifies the location of the key encryption key in Key Vault.

DiskInstanceView

The disks information.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
name	string	The disk name.
statuses	InstanceViewStatus[]	The resource status information.

DomainNameLabelScopeTypes

The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.

Name	Type	Description
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

EncryptionIdentity

Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Name	Type	Description
userAssignedIdentityResourceId	string	Specifies ARM Resource ID of one of the user identities associated with the VM.

HardwareProfile

Specifies the hardware settings for the virtual machine.

Name	Type	Description
vmSize	VirtualMachineSizeTypes	Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, 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	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.

HyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]

Name	Type	Description
V1	string
V2	string

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.

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	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string	The time of the status.

InstanceViewTypes

The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.

Name	Type	Description
instanceView	string
userData	string

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

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

Name	Type	Description
keyUrl	string	The URL referencing a key encryption key in Key Vault.
sourceVault	SubResource	The relative URL of the Key Vault containing the key.

KeyVaultSecretReference

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

Name	Type	Description
secretUrl	string	The URL referencing a secret in a Key Vault.
sourceVault	SubResource	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	LinuxPatchSettings	[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	SshConfiguration	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

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

Name	Type	Description
assessmentMode	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.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
patchMode	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

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 for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

Name	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Enables customer to schedule patching without accidental upgrades
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	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

The Maintenance Operation status on the virtual machine.

Name	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, if customer is allowed to perform Maintenance.
lastOperationMessage	string	Message returned for the last Maintenance Operation.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	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 managed disk parameters.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Specifies the customer managed disk encryption set resource id for the managed disk.
id	string	Resource Id
securityProfile	VMDiskSecurityProfile	Specifies the security profile for the managed disk.
storageAccountType	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.

Mode

Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.

Name	Type	Description
Audit	string
Enforce	string

NetworkApiVersion

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

Name	Type	Description
2020-11-01	string

NetworkInterfaceAuxiliaryMode

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.

Name	Type	Description
AcceleratedConnections	string
Floating	string
None	string

NetworkInterfaceAuxiliarySku

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.

Name	Type	Description
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceReference

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

Name	Type	Description
id	string	Resource Id
properties.deleteOption	DeleteOptions	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 of the virtual machine.

Name	Type	Description
networkApiVersion	NetworkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations
networkInterfaceConfigurations	VirtualMachineNetworkInterfaceConfiguration[]	Specifies the networking configurations that will be used to create the virtual machine networking resources.
networkInterfaces	NetworkInterfaceReference[]	Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

OperatingSystemTypes

The Operating System type.

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	CachingTypes	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.
createOption	DiskCreateOptionTypes	Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described.
deleteOption	DiskDeleteOptionTypes	Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk.
diffDiskSettings	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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
encryptionSettings	DiskEncryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
image	VirtualHardDisk	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	ManagedDiskParameters	The managed disk parameters.
name	string	The disk name.
osType	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.
vhd	VirtualHardDisk	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.

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. The property '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	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	VaultSecretGroup[]	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	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

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

Name	Type	Description
assessmentMode	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.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	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	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

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

ProxyAgentSettings

Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Name	Type	Description
enabled	boolean	Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
keyIncarnationId	integer	Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.
mode	Mode	Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.

PublicIPAddressSku

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

Name	Type	Description
name	PublicIPAddressSkuName	Specify public IP sku name
tier	PublicIPAddressSkuTier	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. 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.

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, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.

Name	Type	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

Specifies the Security related profile settings for the virtual machine.

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. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
encryptionIdentity	EncryptionIdentity	Specifies the Managed Identity used by ADE to get access token for keyvault operations.
proxyAgentSettings	ProxyAgentSettings	Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.
securityType	SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
uefiSettings	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. The default behavior is: 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

The virtual machine SKU.

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

Specifies the ssh key configuration for a Linux OS.

Name	Type	Description
publicKeys	SshPublicKey[]	The list of SSH public keys used to authenticate with linux based VMs.

SshPublicKey

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

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	DataDisk[]	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	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 with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01.
imageReference	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	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

The relative URL of the Key Vault containing the secret.

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

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

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

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.

Name	Type	Description
sourceVault	SubResource	The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates	VaultCertificate[]	The list of key vault references in SourceVault which contain certificates.

VirtualHardDisk

The virtual hard disk.

Name	Type	Description
uri	string	Specifies the virtual hard disk's uri.

VirtualMachineAgentInstanceView

The VM Agent running on the virtual machine.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	The virtual machine extension handler instance view.
statuses	InstanceViewStatus[]	The resource status information.
vmAgentVersion	string	The VM Agent full version.

VirtualMachineExtension

The virtual machine child extension resources.

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	VirtualMachineExtensionInstanceView	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	KeyVaultSecretReference	The extensions protected settings that are passed by reference, and consumed from key vault
properties.provisionAfterExtensions	string[]	Collection of extension names after which this extension needs to be provisioned.
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 virtual machine extension handler instance view.

Name	Type	Description
status	InstanceViewStatus	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 virtual machine extension instance view.

Name	Type	Description
name	string	The virtual machine extension name.
statuses	InstanceViewStatus[]	The resource status information.
substatuses	InstanceViewStatus[]	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 for the VM.

Name	Type	Description
status	InstanceViewStatus	The health status information for the VM.

VirtualMachineIdentity

The identity of the virtual machine, if configured.

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	ResourceIdentityType	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	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

The list of IP tags 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

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

Name	Type	Description
name	string	The network interface configuration name.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
properties.deleteOption	DeleteOptions	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	VirtualMachineNetworkInterfaceDnsSettingsConfiguration	The dns settings to be applied on the network interfaces.
properties.dscpConfiguration	SubResource
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	VirtualMachineNetworkInterfaceIPConfiguration[]	Specifies the IP configurations of the network interface.
properties.networkSecurityGroup	SubResource	The network security group.
properties.primary	boolean	Specifies the primary network interface in case the virtual machine has more than 1 network interface.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

The dns settings to be applied on the network interfaces.

Name	Type	Description
dnsServers	string[]	List of DNS servers IP addresses

VirtualMachineNetworkInterfaceIPConfiguration

Specifies the IP configurations of the network interface.

Name	Type	Description
name	string	The IP configuration name.
properties.applicationGatewayBackendAddressPools	SubResource[]	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	SubResource[]	Specifies an array of references to application security group.
properties.loadBalancerBackendAddressPools	SubResource[]	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	IPVersions	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	VirtualMachinePublicIPAddressConfiguration	The publicIPAddressConfiguration.
properties.subnet	SubResource	Specifies the identifier of the subnet.

VirtualMachinePublicIPAddressConfiguration

The publicIPAddressConfiguration.

Name	Type	Description
name	string	The publicIP address configuration name.
properties.deleteOption	DeleteOptions	Specify what happens to the public IP address when the VM is deleted
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	The dns settings to be applied on the publicIP addresses .
properties.idleTimeoutInMinutes	integer	The idle timeout of the public IP address.
properties.ipTags	VirtualMachineIpTag[]	The list of IP tags associated with the public IP address.
properties.publicIPAddressVersion	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'.
properties.publicIPAllocationMethod	PublicIPAllocationMethod	Specify the public IP allocation type
properties.publicIPPrefix	SubResource	The PublicIPPrefix from which to allocate publicIP addresses.
sku	PublicIPAddressSku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

The dns settings to be applied on the publicIP addresses .

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.
domainNameLabelScope	DomainNameLabelScopeTypes	The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.

VirtualMachineScaleSetIPConfiguration

Specifies the IP configurations of the network interface.

Name	Type	Description
name	string	The IP configuration name.
properties.applicationGatewayBackendAddressPools	SubResource[]	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	SubResource[]	Specifies an array of references to application security group.
properties.loadBalancerBackendAddressPools	SubResource[]	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	SubResource[]	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	IPVersion	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	VirtualMachineScaleSetPublicIPAddressConfiguration	The publicIPAddressConfiguration.
properties.subnet	ApiEntityReference	Specifies the identifier of the subnet.

VirtualMachineScaleSetIpTag

The list of IP tags 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

The list of network configurations.

Name	Type	Description
name	string	The network configuration name.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
properties.deleteOption	DeleteOptions	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	VirtualMachineScaleSetNetworkConfigurationDnsSettings	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	VirtualMachineScaleSetIPConfiguration[]	Specifies the IP configurations of the network interface.
properties.networkSecurityGroup	SubResource	The network security group.
properties.primary	boolean	Specifies the primary network interface in case the virtual machine has more than 1 network interface.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

The dns settings to be applied on the network interfaces.

Name	Type	Description
dnsServers	string[]	List of DNS servers IP addresses

VirtualMachineScaleSetPublicIPAddressConfiguration

The publicIPAddressConfiguration.

Name	Type	Description
name	string	The publicIP address configuration name.
properties.deleteOption	DeleteOptions	Specify what happens to the public IP when the VM is deleted
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	The dns settings to be applied on the publicIP addresses .
properties.idleTimeoutInMinutes	integer	The idle timeout of the public IP address.
properties.ipTags	VirtualMachineScaleSetIpTag[]	The list of IP tags associated with the public IP address.
properties.publicIPAddressVersion	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'.
properties.publicIPPrefix	SubResource	The PublicIPPrefix from which to allocate publicIP addresses.
sku	PublicIPAddressSku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

The dns settings to be applied on the publicIP addresses .

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
domainNameLabelScope	DomainNameLabelScopeTypes	The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created

VirtualMachineScaleSetVM

Describes a virtual machine scale set virtual machine.

Name	Type	Description
etag	string	Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
id	string	Resource Id
identity	VirtualMachineIdentity	The identity of the virtual machine, if configured.
instanceId	string	The virtual machine instance ID.
location	string	Resource location
name	string	Resource name
plan	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	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	SubResource	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	DiagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
properties.hardwareProfile	HardwareProfile	Specifies the hardware settings for the virtual machine.
properties.instanceView	VirtualMachineScaleSetVMInstanceView	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	NetworkProfile	Specifies the network interfaces of the virtual machine.
properties.networkProfileConfiguration	VirtualMachineScaleSetVMNetworkProfileConfiguration	Specifies the network profile configuration of the virtual machine.
properties.osProfile	OSProfile	Specifies the operating system settings for the virtual machine.
properties.protectionPolicy	VirtualMachineScaleSetVMProtectionPolicy	Specifies the protection policy of the virtual machine.
properties.provisioningState	string	The provisioning state, which only appears in the response.
properties.securityProfile	SecurityProfile	Specifies the Security related profile settings for the virtual machine.
properties.storageProfile	StorageProfile	Specifies the storage settings for the virtual machine disks.
properties.timeCreated	string	Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
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	VirtualMachineExtension[]	The virtual machine child extension resources.
sku	Sku	The virtual machine SKU.
tags	object	Resource tags
type	string	Resource type
zones	string[]	The virtual machine zones.

VirtualMachineScaleSetVMInstanceView

The virtual machine instance view.

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	BootDiagnosticsInstanceView	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.
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.
disks	DiskInstanceView[]	The disks information.
extensions	VirtualMachineExtensionInstanceView[]	The extensions information.
hyperVGeneration	HyperVGeneration	The hypervisor generation of the Virtual Machine [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	The Maintenance Operation status on the virtual machine.
osName	string	The Operating System running on the hybrid machine.
osVersion	string	The version of Operating System running on the hybrid 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	InstanceViewStatus[]	The resource status information.
vmAgent	VirtualMachineAgentInstanceView	The VM Agent running on the virtual machine.
vmHealth	VirtualMachineHealthStatus	The health status for the VM.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Specifies the network profile configuration of the virtual machine.

Name	Type	Description
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	The list of network configurations.

VirtualMachineScaleSetVMProtectionPolicy

Specifies the protection policy of the virtual machine.

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. The 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 for the managed disk.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	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	securityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.

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.

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	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 are enabled for the Windows Virtual Machine.
patchSettings	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, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
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	WinRMConfiguration	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 for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

Name	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Enables customer to schedule patching without accidental upgrades
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	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

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

Name	Type	Description
listeners	WinRMListener[]	The list of Windows Remote Management listeners

WinRMListener

The list of Windows Remote Management listeners

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 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	ProtocolTypes	Specifies the protocol of WinRM listener. Possible values are: http, https.