Virtual Machine Scale Sets - Get

Serviço:: Compute

Versão API:: 2025-04-01

Exibir informações sobre um conjunto de dimensionamento de máquina virtual.

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

Com parâmetros opcionais:

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
vmScaleSetName	path	True	string	O nome do conjunto de escala de VM.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$expand	query		ExpandTypesForGetVMScaleSets	A expressão expand a ser aplicada na operação. 'UserData' recupera a propriedade UserData do conjunto de escala de VM que foi fornecido pelo usuário durante a operação Create/Update do conjunto de escala de VM

Respostas

Nome	Tipo	Descrição
200 OK	VirtualMachineScaleSet	Operação do Azure concluída com êxito.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get a virtual machine scale set

Get a virtual machine scale set placed on a dedicated host group through automatic placement.

Get a virtual machine scale set with UserData

Get VM scale set VM with Disk Controller Type

Get a virtual machine scale set

Pedido de exemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2025-04-01&$expand=userData


/**
 * Samples for VirtualMachineScaleSets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
     */
    /**
     * Sample code: Get a virtual machine scale set.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachineScaleSet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().getByResourceGroupWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", 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

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_get.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_sets.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.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

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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
func ExampleVirtualMachineScaleSetsClient_Get_getAVirtualMachineScaleSet() {
	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.NewVirtualMachineScaleSetsClient().Get(ctx, "myResourceGroup", "myVirtualMachineScaleSet", &armcompute.VirtualMachineScaleSetsClientGetOptions{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.VirtualMachineScaleSet = armcompute.VirtualMachineScaleSet{
	// 	Name: to.Ptr("myVirtualMachineScaleSet"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	Properties: &armcompute.VirtualMachineScaleSetProperties{
	// 		DoNotRunExtensionsOnOverprovisionedVMs: to.Ptr(false),
	// 		HostGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"),
	// 		},
	// 		Overprovision: to.Ptr(false),
	// 		PlatformFaultDomainCount: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SinglePlacementGroup: to.Ptr(false),
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.313Z"); return t}()),
	// 		UpgradePolicy: &armcompute.UpgradePolicy{
	// 			AutomaticOSUpgradePolicy: &armcompute.AutomaticOSUpgradePolicy{
	// 				EnableAutomaticOSUpgrade: to.Ptr(false),
	// 			},
	// 			Mode: to.Ptr(armcompute.UpgradeModeAutomatic),
	// 		},
	// 		VirtualMachineProfile: &armcompute.VirtualMachineScaleSetVMProfile{
	// 			ApplicationProfile: &armcompute.ApplicationProfile{
	// 				GalleryApplications: []*armcompute.VMGalleryApplication{
	// 					{
	// 						ConfigurationReference: to.Ptr("https://mystorageaccount.blob.core.windows.net/configurations/settings.config"),
	// 						Order: to.Ptr[int32](1),
	// 						PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0"),
	// 						Tags: to.Ptr("myTag1"),
	// 					},
	// 					{
	// 						PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"),
	// 				}},
	// 			},
	// 			NetworkProfile: &armcompute.VirtualMachineScaleSetNetworkProfile{
	// 				NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 					{
	// 						Name: to.Ptr("myNic"),
	// 						Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 							IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 								{
	// 									Name: to.Ptr("myIPConfig"),
	// 									Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 										Primary: to.Ptr(true),
	// 										Subnet: &armcompute.APIEntityReference{
	// 											ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"),
	// 										},
	// 									},
	// 							}},
	// 							NetworkSecurityGroup: &armcompute.SubResource{
	// 								ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"),
	// 							},
	// 							Primary: to.Ptr(true),
	// 						},
	// 				}},
	// 			},
	// 			OSProfile: &armcompute.VirtualMachineScaleSetOSProfile{
	// 				AdminUsername: to.Ptr("admin"),
	// 				ComputerNamePrefix: to.Ptr("myVirtualMachineScaleSet"),
	// 				LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 					DisablePasswordAuthentication: to.Ptr(false),
	// 				},
	// 			},
	// 			StorageProfile: &armcompute.VirtualMachineScaleSetStorageProfile{
	// 				DataDisks: []*armcompute.VirtualMachineScaleSetDataDisk{
	// 				},
	// 				ImageReference: &armcompute.ImageReference{
	// 					Offer: to.Ptr("databricks"),
	// 					Publisher: to.Ptr("azuredatabricks"),
	// 					SKU: to.Ptr("databricksworker"),
	// 					Version: to.Ptr("3.15.2"),
	// 				},
	// 				OSDisk: &armcompute.VirtualMachineScaleSetOSDisk{
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					ManagedDisk: &armcompute.VirtualMachineScaleSetManagedDiskParameters{
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 			},
	// 			TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-27T01:03:40.313Z"); return t}()),
	// 			UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		},
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("Standard_D2s_v3"),
	// 		Capacity: to.Ptr[int64](4),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Display information about a virtual machine scale set.
 *
 * @summary Display information about a virtual machine scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
 */
async function getAVirtualMachineScaleSet() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.get(resourceGroupName, vmScaleSetName);
  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

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.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetResource result = await virtualMachineScaleSet.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
VirtualMachineScaleSetData 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

Resposta de exemplo

Código de estado:: 200

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "etag": "\"1\"",
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "applicationProfile": {
        "galleryApplications": [
          {
            "tags": "myTag1",
            "order": 1,
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
            "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
          },
          {
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
          }
        ]
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      },
      "timeCreated": "2023-09-27T01:03:40.3138469+00:00"
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    },
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  }
}

Get a virtual machine scale set placed on a dedicated host group through automatic placement.

Pedido de exemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2025-04-01&$expand=userData


/**
 * Samples for VirtualMachineScaleSets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get a virtual machine scale set placed on a dedicated host group through automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachineScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().getByResourceGroupWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", 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

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_get_auto_placed_on_dedicated_host_group.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_sets.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.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

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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachineScaleSetsClient_Get_getAVirtualMachineScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
	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.NewVirtualMachineScaleSetsClient().Get(ctx, "myResourceGroup", "myVirtualMachineScaleSet", &armcompute.VirtualMachineScaleSetsClientGetOptions{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.VirtualMachineScaleSet = armcompute.VirtualMachineScaleSet{
	// 	Name: to.Ptr("myVirtualMachineScaleSet"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineScaleSetProperties{
	// 		DoNotRunExtensionsOnOverprovisionedVMs: to.Ptr(false),
	// 		HostGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"),
	// 		},
	// 		Overprovision: to.Ptr(false),
	// 		PlatformFaultDomainCount: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SinglePlacementGroup: to.Ptr(false),
	// 		UpgradePolicy: &armcompute.UpgradePolicy{
	// 			AutomaticOSUpgradePolicy: &armcompute.AutomaticOSUpgradePolicy{
	// 				EnableAutomaticOSUpgrade: to.Ptr(false),
	// 			},
	// 			Mode: to.Ptr(armcompute.UpgradeModeAutomatic),
	// 		},
	// 		VirtualMachineProfile: &armcompute.VirtualMachineScaleSetVMProfile{
	// 			NetworkProfile: &armcompute.VirtualMachineScaleSetNetworkProfile{
	// 				NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 					{
	// 						Name: to.Ptr("myNic"),
	// 						Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 							IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 								{
	// 									Name: to.Ptr("myIPConfig"),
	// 									Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 										Primary: to.Ptr(true),
	// 										Subnet: &armcompute.APIEntityReference{
	// 											ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"),
	// 										},
	// 									},
	// 							}},
	// 							NetworkSecurityGroup: &armcompute.SubResource{
	// 								ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"),
	// 							},
	// 							Primary: to.Ptr(true),
	// 						},
	// 				}},
	// 			},
	// 			OSProfile: &armcompute.VirtualMachineScaleSetOSProfile{
	// 				AdminUsername: to.Ptr("admin"),
	// 				ComputerNamePrefix: to.Ptr("myVirtualMachineScaleSet"),
	// 				LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 					DisablePasswordAuthentication: to.Ptr(false),
	// 				},
	// 			},
	// 			StorageProfile: &armcompute.VirtualMachineScaleSetStorageProfile{
	// 				DataDisks: []*armcompute.VirtualMachineScaleSetDataDisk{
	// 				},
	// 				ImageReference: &armcompute.ImageReference{
	// 					Offer: to.Ptr("databricks"),
	// 					Publisher: to.Ptr("azuredatabricks"),
	// 					SKU: to.Ptr("databricksworker"),
	// 					Version: to.Ptr("3.15.2"),
	// 				},
	// 				OSDisk: &armcompute.VirtualMachineScaleSetOSDisk{
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					ManagedDisk: &armcompute.VirtualMachineScaleSetManagedDiskParameters{
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 			},
	// 		},
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("Standard_D2s_v3"),
	// 		Capacity: to.Ptr[int64](4),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Display information about a virtual machine scale set.
 *
 * @summary Display information about a virtual machine scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
 */
async function getAVirtualMachineScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.get(resourceGroupName, vmScaleSetName);
  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

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.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetResource result = await virtualMachineScaleSet.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
VirtualMachineScaleSetData 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

Resposta de exemplo

Código de estado:: 200

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Get a virtual machine scale set with UserData

Pedido de exemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2025-04-01&$expand=userData


import com.azure.resourcemanager.compute.models.ExpandTypesForGetVMScaleSets;

/**
 * Samples for VirtualMachineScaleSets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
     */
    /**
     * Sample code: Get a virtual machine scale set with UserData.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachineScaleSetWithUserData(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().getByResourceGroupWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", ExpandTypesForGetVMScaleSets.USER_DATA,
            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

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_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_sets.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
func ExampleVirtualMachineScaleSetsClient_Get_getAVirtualMachineScaleSetWithUserData() {
	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.NewVirtualMachineScaleSetsClient().Get(ctx, "myResourceGroup", "myVirtualMachineScaleSet", &armcompute.VirtualMachineScaleSetsClientGetOptions{Expand: to.Ptr(armcompute.ExpandTypesForGetVMScaleSetsUserData)})
	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.VirtualMachineScaleSet = armcompute.VirtualMachineScaleSet{
	// 	Name: to.Ptr("myVirtualMachineScaleSet"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineScaleSetProperties{
	// 		DoNotRunExtensionsOnOverprovisionedVMs: to.Ptr(false),
	// 		HostGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"),
	// 		},
	// 		Overprovision: to.Ptr(false),
	// 		PlatformFaultDomainCount: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SinglePlacementGroup: to.Ptr(false),
	// 		UpgradePolicy: &armcompute.UpgradePolicy{
	// 			AutomaticOSUpgradePolicy: &armcompute.AutomaticOSUpgradePolicy{
	// 				EnableAutomaticOSUpgrade: to.Ptr(false),
	// 			},
	// 			Mode: to.Ptr(armcompute.UpgradeModeAutomatic),
	// 		},
	// 		VirtualMachineProfile: &armcompute.VirtualMachineScaleSetVMProfile{
	// 			ApplicationProfile: &armcompute.ApplicationProfile{
	// 				GalleryApplications: []*armcompute.VMGalleryApplication{
	// 					{
	// 						ConfigurationReference: to.Ptr("https://mystorageaccount.blob.core.windows.net/configurations/settings.config"),
	// 						Order: to.Ptr[int32](1),
	// 						PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0"),
	// 						Tags: to.Ptr("myTag1"),
	// 					},
	// 					{
	// 						PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"),
	// 				}},
	// 			},
	// 			NetworkProfile: &armcompute.VirtualMachineScaleSetNetworkProfile{
	// 				NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 					{
	// 						Name: to.Ptr("myNic"),
	// 						Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 							IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 								{
	// 									Name: to.Ptr("myIPConfig"),
	// 									Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 										Primary: to.Ptr(true),
	// 										Subnet: &armcompute.APIEntityReference{
	// 											ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"),
	// 										},
	// 									},
	// 							}},
	// 							NetworkSecurityGroup: &armcompute.SubResource{
	// 								ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"),
	// 							},
	// 							Primary: to.Ptr(true),
	// 						},
	// 				}},
	// 			},
	// 			OSProfile: &armcompute.VirtualMachineScaleSetOSProfile{
	// 				AdminUsername: to.Ptr("admin"),
	// 				ComputerNamePrefix: to.Ptr("myVirtualMachineScaleSet"),
	// 				LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 					DisablePasswordAuthentication: to.Ptr(false),
	// 				},
	// 			},
	// 			StorageProfile: &armcompute.VirtualMachineScaleSetStorageProfile{
	// 				DataDisks: []*armcompute.VirtualMachineScaleSetDataDisk{
	// 				},
	// 				ImageReference: &armcompute.ImageReference{
	// 					Offer: to.Ptr("databricks"),
	// 					Publisher: to.Ptr("azuredatabricks"),
	// 					SKU: to.Ptr("databricksworker"),
	// 					Version: to.Ptr("3.15.2"),
	// 				},
	// 				OSDisk: &armcompute.VirtualMachineScaleSetOSDisk{
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					ManagedDisk: &armcompute.VirtualMachineScaleSetManagedDiskParameters{
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 			},
	// 			UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		},
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("Standard_D2s_v3"),
	// 		Capacity: to.Ptr[int64](4),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Display information about a virtual machine scale set.
 *
 * @summary Display information about a virtual machine scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
 */
async function getAVirtualMachineScaleSetWithUserData() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const expand = "userData";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.get(
    resourceGroupName,
    vmScaleSetName,
    options,
  );
  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

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.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetGetExpand? expand = VirtualMachineScaleSetGetExpand.UserData;
VirtualMachineScaleSetResource result = await virtualMachineScaleSet.GetAsync(expand: expand);

// 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
VirtualMachineScaleSetData 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

Resposta de exemplo

Código de estado:: 200

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "applicationProfile": {
        "galleryApplications": [
          {
            "tags": "myTag1",
            "order": 1,
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
            "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
          },
          {
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
          }
        ]
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Get VM scale set VM with Disk Controller Type

Pedido de exemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2025-04-01&$expand=userData


import com.azure.resourcemanager.compute.models.ExpandTypesForGetVMScaleSets;

/**
 * Samples for VirtualMachineScaleSets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
     */
    /**
     * Sample code: Get VM scale set VM with Disk Controller Type.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVMScaleSetVMWithDiskControllerType(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().getByResourceGroupWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", ExpandTypesForGetVMScaleSets.USER_DATA,
            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

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_get_with_disk_controller_type.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_sets.get(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
func ExampleVirtualMachineScaleSetsClient_Get_getVmScaleSetVmWithDiskControllerType() {
	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.NewVirtualMachineScaleSetsClient().Get(ctx, "myResourceGroup", "myVirtualMachineScaleSet", &armcompute.VirtualMachineScaleSetsClientGetOptions{Expand: to.Ptr(armcompute.ExpandTypesForGetVMScaleSetsUserData)})
	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.VirtualMachineScaleSet = armcompute.VirtualMachineScaleSet{
	// 	Name: to.Ptr("myVirtualMachineScaleSet"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachineScaleSets"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineScaleSetProperties{
	// 		DoNotRunExtensionsOnOverprovisionedVMs: to.Ptr(false),
	// 		HostGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"),
	// 		},
	// 		Overprovision: to.Ptr(false),
	// 		PlatformFaultDomainCount: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SinglePlacementGroup: to.Ptr(false),
	// 		UpgradePolicy: &armcompute.UpgradePolicy{
	// 			AutomaticOSUpgradePolicy: &armcompute.AutomaticOSUpgradePolicy{
	// 				EnableAutomaticOSUpgrade: to.Ptr(false),
	// 			},
	// 			Mode: to.Ptr(armcompute.UpgradeModeAutomatic),
	// 		},
	// 		VirtualMachineProfile: &armcompute.VirtualMachineScaleSetVMProfile{
	// 			ApplicationProfile: &armcompute.ApplicationProfile{
	// 				GalleryApplications: []*armcompute.VMGalleryApplication{
	// 					{
	// 						ConfigurationReference: to.Ptr("https://mystorageaccount.blob.core.windows.net/configurations/settings.config"),
	// 						Order: to.Ptr[int32](1),
	// 						PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0"),
	// 						Tags: to.Ptr("myTag1"),
	// 					},
	// 					{
	// 						PackageReferenceID: to.Ptr("/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"),
	// 				}},
	// 			},
	// 			NetworkProfile: &armcompute.VirtualMachineScaleSetNetworkProfile{
	// 				NetworkInterfaceConfigurations: []*armcompute.VirtualMachineScaleSetNetworkConfiguration{
	// 					{
	// 						Name: to.Ptr("myNic"),
	// 						Properties: &armcompute.VirtualMachineScaleSetNetworkConfigurationProperties{
	// 							IPConfigurations: []*armcompute.VirtualMachineScaleSetIPConfiguration{
	// 								{
	// 									Name: to.Ptr("myIPConfig"),
	// 									Properties: &armcompute.VirtualMachineScaleSetIPConfigurationProperties{
	// 										Primary: to.Ptr(true),
	// 										Subnet: &armcompute.APIEntityReference{
	// 											ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"),
	// 										},
	// 									},
	// 							}},
	// 							NetworkSecurityGroup: &armcompute.SubResource{
	// 								ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"),
	// 							},
	// 							Primary: to.Ptr(true),
	// 						},
	// 				}},
	// 			},
	// 			OSProfile: &armcompute.VirtualMachineScaleSetOSProfile{
	// 				AdminUsername: to.Ptr("admin"),
	// 				ComputerNamePrefix: to.Ptr("myVirtualMachineScaleSet"),
	// 				LinuxConfiguration: &armcompute.LinuxConfiguration{
	// 					DisablePasswordAuthentication: to.Ptr(false),
	// 				},
	// 			},
	// 			StorageProfile: &armcompute.VirtualMachineScaleSetStorageProfile{
	// 				DataDisks: []*armcompute.VirtualMachineScaleSetDataDisk{
	// 				},
	// 				DiskControllerType: to.Ptr("NVMe"),
	// 				ImageReference: &armcompute.ImageReference{
	// 					Offer: to.Ptr("databricks"),
	// 					Publisher: to.Ptr("azuredatabricks"),
	// 					SKU: to.Ptr("databricksworker"),
	// 					Version: to.Ptr("3.15.2"),
	// 				},
	// 				OSDisk: &armcompute.VirtualMachineScaleSetOSDisk{
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					ManagedDisk: &armcompute.VirtualMachineScaleSetManagedDiskParameters{
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 			},
	// 			UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		},
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("Standard_D2s_v3"),
	// 		Capacity: to.Ptr[int64](4),
	// 		Tier: to.Ptr("Standard"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Display information about a virtual machine scale set.
 *
 * @summary Display information about a virtual machine scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
 */
async function getVMScaleSetVMWithDiskControllerType() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const expand = "userData";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.get(
    resourceGroupName,
    vmScaleSetName,
    options,
  );
  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

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.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
// this example is just showing the usage of "VirtualMachineScaleSets_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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetGetExpand? expand = VirtualMachineScaleSetGetExpand.UserData;
VirtualMachineScaleSetResource result = await virtualMachineScaleSet.GetAsync(expand: expand);

// 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
VirtualMachineScaleSetData 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

Resposta de exemplo

Código de estado:: 200

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": [],
        "diskControllerType": "NVMe"
      },
      "applicationProfile": {
        "galleryApplications": [
          {
            "tags": "myTag1",
            "order": 1,
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
            "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
          },
          {
            "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
          }
        ]
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Definições

Nome	Descrição
AdditionalCapabilities	Habilita ou desabilita um recurso na máquina virtual ou no conjunto de dimensionamento de máquina virtual.
AdditionalUnattendContent	Especifica informações adicionais formatadas em XML que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows. O conteúdo é definido definindo o nome, o nome do componente e a passagem na qual o conteúdo é aplicado.
AllInstancesDown	Especifica se os Eventos Agendados devem ser aprovados automaticamente quando todas as instâncias estiverem inativas.
AllocationStrategy	Especifica a estratégia de alocação para o conjunto de escala de máquina virtual com base no qual as VMs serão alocadas.
ApiEntityReference	A referência da entidade da API.
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
ApplicationProfile	Contém a lista de aplicativos de galeria que devem ser disponibilizados para a VM/VMSS
AutomaticOSUpgradePolicy	Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.
AutomaticRepairsPolicy	Especifica os parâmetros de configuração para reparos automáticos no conjunto de escala da máquina virtual.
AutomaticZoneRebalancingPolicy	Os parâmetros de configuração usados durante a execução do balanceamento AZ automático.
BillingProfile	Especifica os detalhes relacionados à cobrança de uma VM ou VMSS spot do Azure. Versão api mínima: 2019-03-01.
BootDiagnostics	O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.
CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium
CapacityReservationProfile	Os parâmetros de um Perfil de reserva de capacidade.
CloudError	Uma resposta de erro do serviço de computação.
ComponentNames
createdByType	O tipo de identidade que criou o recurso.
DeleteOptions	Especificar o que acontece com a interface de rede quando a VM é excluída
DiagnosticsProfile	Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.
DiffDiskOptions	Especifica a opção de disco efêmero para o disco do sistema operacional.
DiffDiskPlacement	Especifica o posicionamento efêmero do disco do sistema operacional. Esta propriedade pode ser usada pelo usuário na solicitação para escolher o local, ou seja, disco de cache, disco de recurso ou espaço em disco nvme para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para Windows VM em https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e Linux VM em https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Versão mínima da api para NvmeDisk: 2024-03-01.
DiffDiskSettings	Descreve os parâmetros das configurações de disco efêmero que podem ser especificadas para o disco do sistema operacional. Nota: As configurações de disco efêmero só podem ser especificadas para o disco gerenciado.
DiskControllerTypes	Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Esta propriedade só é suportada para máquinas virtuais cujo disco do sistema operativo e sku de VM suporta a Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique a capacidade HyperVGenerations retornada como parte das capacidades de sku de VM na resposta da API de SKUs Microsoft.Compute para a região contém V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Para obter mais informações sobre os tipos de controlador de disco suportados, consulte https://aka.ms/azure-diskcontrollertypes.
DiskCreateOptionTypes	Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.
DiskDeleteOptionTypes	Especifica o comportamento do disco gerenciado quando a VM é excluída, por exemplo, se o disco gerenciado é excluído ou desanexado. Os valores suportados são: Delete. Se esse valor for usado, o disco gerenciado será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco gerenciado será retido depois que a VM for excluída. Versão mínima da api: 2021-03-01.
DiskEncryptionSetParameters	Descreve o parâmetro de id de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificado para o disco. Nota: O ID do recurso do conjunto de criptografia de disco só pode ser especificado para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.
DomainNameLabelScopeTypes	O escopo do rótulo de nome de domínio. A concatenação do rótulo de nome de domínio com hash gerado de acordo com a política do escopo do rótulo de nome de domínio e do índice vm serão os rótulos de nome de domínio dos recursos de endereço PublicIPAddress que serão criados
EncryptionIdentity	Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.
EventGridAndResourceGraph	Especifica as configurações relacionadas a eventos agendados relacionados a eventGridAndResourceGraph.
ExpandTypesForGetVMScaleSets
ExtendedLocation	O tipo complexo do local estendido.
ExtendedLocationTypes	O tipo de localização ampliada.
HighSpeedInterconnectPlacement	Especifica o posicionamento da interconexão de alta velocidade para o conjunto de escala da máquina virtual.
HostEndpointSettings	Especifica configurações específicas do ponto de extremidade do host.
ImageReference	Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação. NOTA: O editor e a oferta de referência de imagem só podem ser definidos quando cria o conjunto de escalas.
InnerError	Detalhes do erro interno.
IPVersion	Disponível a partir de 30-03-Api-Version 2017, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.
KeyVaultSecretReference	Descreve uma referência ao segredo do Key Vault
LinuxConfiguration	Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.
LinuxPatchAssessmentMode	Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.
LinuxPatchSettings	Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.
LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Linux.
LinuxVMGuestPatchMode	Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível. Os valores possíveis são: ImageDefault - A configuração de patch padrão da máquina virtual é usada. AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true
MaxInstancePercentPerZonePolicy	Os parâmetros de configuração usados para limitar o número de máquinas virtuais por zona de disponibilidade no conjunto de escala de máquina virtual.
Mode	Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.
Modes	Especifica o modo de execução. No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Enforce, o sistema irá impor o controle de acesso e é o modo recomendado de operação.
NetworkApiVersion	especifica a versão da API Microsoft.Network usada ao criar recursos de rede nas Configurações da Interface de Rede
NetworkInterfaceAuxiliaryMode	Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.
NetworkInterfaceAuxiliarySku	Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.
OperatingSystemTypes	Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir da imagem do usuário ou de um VHD especializado. Os valores possíveis são: Windows,Linux.
OrchestrationMode	Especifica o modo de orquestração para o conjunto de escala da máquina virtual.
OSImageNotificationProfile
PassNames
PatchSettings	Especifica as configurações relacionadas ao patch de convidado de VM no Windows.
Placement	Descreve as restrições definidas pelo usuário para o posicionamento de hardware de recursos.
Plan	Especifica informações sobre a imagem do marketplace usada para criar a máquina virtual. Este elemento é usado apenas para imagens do mercado. Antes de poder usar uma imagem de mercado de uma API, você deve habilitar a imagem para uso programático. No portal do Azure, localize a imagem do marketplace que pretende utilizar e, em seguida, clique em Pretende implementar programaticamente, Introdução ->. Introduza todas as informações necessárias e, em seguida, clique em Guardar.
PriorityMixPolicy	Especifica as divisões de destino para VMs de prioridade Spot e Regular dentro de um conjunto de escala com modo de orquestração flexível. Com essa propriedade, o cliente pode especificar o número base de VMs de prioridade regular criadas à medida que a instância flexível do VMSS se expande e a divisão entre VMs de prioridade Spot e Regular após esse destino base ter sido atingido.
ProtocolTypes	Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.
ProxyAgentSettings	Especifica as configurações do ProxyAgent para a máquina virtual ou o conjunto de dimensionamento da máquina virtual. Versão mínima da api: 2023-09-01.
PublicIPAddressSku	Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.
PublicIPAddressSkuName	Especificar nome de sku IP público
PublicIPAddressSkuTier	Especificar camada de sku IP público
RebalanceBehavior	Tipo de comportamento de reequilíbrio que será usado para recriar máquinas virtuais na escala definida em zonas de disponibilidade. O valor padrão e suportado apenas por enquanto é CreateBeforeDelete.
RebalanceStrategy	Tipo de estratégia de reequilíbrio que será usada para reequilibrar máquinas virtuais na escala definida entre zonas de disponibilidade. O valor padrão e suportado apenas por enquanto é Recriar.
RepairAction	Tipo de ação de reparo (substituir, reiniciar, recriar imagem) que será usada para reparar máquinas virtuais não íntegras no conjunto de escala. O valor padrão é substituir.
ResiliencyPolicy	Descreve uma política de resiliência - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy e/ou ResilientVMDeletionPolicy.
ResilientVMCreationPolicy	Os parâmetros de configuração usados durante a execução da criação de VM resiliente.
ResilientVMDeletionPolicy	Os parâmetros de configuração usados ao executar a exclusão de VM resiliente.
ResourceIdentityType	O tipo de identidade usado para o conjunto de dimensionamento de máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do conjunto de escala da máquina virtual.
RollingUpgradePolicy	Os parâmetros de configuração usados durante a execução de uma atualização contínua.
ScaleInPolicy	Descreve uma política de dimensionamento para um conjunto de dimensionamento de máquina virtual.
ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy	Especifica as configurações relacionadas a Redeploy, Reboot e ScheduledEventsAdditionalPublishingTargets Scheduled Event.
ScheduledEventsProfile
SecurityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais.
SecurityPostureReference	Especifica a postura de segurança a ser usada no conjunto de escalas. Versão mínima da api: 2023-03-01
SecurityProfile	Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento da máquina virtual.
SecurityTypes	Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado a menos que essa propriedade esteja definida.
ServiceArtifactReference	Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'. Versão mínima api: 2022-11-01
SettingNames	Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.
Sku	Descreve um sku de conjunto de escala de máquina virtual. NOTA: Se a nova SKU de VM não for suportada no hardware em que o conjunto de escala está atualmente, você precisará desalocar as VMs no conjunto de escala antes de modificar o nome da SKU.
SkuProfile	Especifica o perfil de sku para o conjunto de escala de máquina virtual. Com essa propriedade, o cliente pode especificar uma lista de tamanhos de VM e uma estratégia de alocação.
SkuProfileVMSize	Especifica o tamanho da VM.
SpotRestorePolicy	Especifica as propriedades Spot-Try-Restore para o conjunto de escala da máquina virtual. Com essa propriedade, o cliente pode habilitar ou desabilitar a restauração automática das instâncias de VM spot removidas oportunisticamente com base na disponibilidade de capacidade e na restrição de preços.
SshConfiguration	Configuração SSH para VMs baseadas em Linux em execução no Azure
SshPublicKey	Contém informações sobre a chave pública do certificado SSH e o caminho na VM Linux onde a chave pública é colocada.
StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerenciado. O tipo de conta de armazenamento em disco do sistema operacional gerenciado só pode ser definido quando você cria o conjunto de escala. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados. Ele não pode ser usado com o OS Disk. Standard_LRS usa HDD padrão. StandardSSD_LRS usa SSD padrão. Premium_LRS usa SSD Premium. UltraSSD_LRS usa o disco Ultra. Premium_ZRS usa armazenamento redundante de zona SSD Premium. StandardSSD_ZRS usa armazenamento redundante de zona SSD padrão. Para obter mais informações sobre discos suportados para Máquinas Virtuais do Windows, consulte https://docs.microsoft.com/azure/virtual-machines/windows/disks-types e, para Máquinas Virtuais Linux, consulte https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
SubResource
systemData	Metadados referentes à criação e última modificação do recurso.
TerminateNotificationProfile
UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.
UpgradeMode	Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala. Os valores possíveis são: Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade. automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.
UpgradePolicy	Descreve uma política de atualização - automática, manual ou rolante.
UserAssignedIdentitiesValue
UserInitiatedReboot	Especifica as configurações relacionadas a Eventos Agendados relacionados à Reinicialização.
UserInitiatedRedeploy	Especifica Reimplantar configurações relacionadas a Eventos Agendados relacionados.
VaultCertificate	Descreve uma única referência de certificado em um Cofre de Chaves e onde o certificado deve residir na VM.
VaultSecretGroup	Descreve um conjunto de certificados que estão todos no mesmo Cofre de Chaves.
VirtualHardDisk	Descreve o uri de um disco.
VirtualMachineEvictionPolicyTypes	Especifica a política de remoção para a VM/VMSS do Azure Spot
VirtualMachinePriorityTypes	Especifica a prioridade para uma máquina virtual autônoma ou as máquinas virtuais no conjunto de escala. O enum 'Baixo' será preterido no futuro, use 'Spot' como o enum para implantar o Azure Spot VM/VMSS.
VirtualMachineScaleSet	Descreve um conjunto de dimensionamento de máquina virtual.
VirtualMachineScaleSetDataDisk	Descreve um disco de dados do conjunto de dimensionamento de máquina virtual.
VirtualMachineScaleSetExtension	Descreve uma extensão de conjunto de escala de máquina virtual.
VirtualMachineScaleSetExtensionProfile	Descreve um perfil de extensão de conjunto de escala de máquina virtual.
VirtualMachineScaleSetHardwareProfile	Especifica as configurações de hardware para o conjunto de dimensionamento de máquina virtual.
VirtualMachineScaleSetIdentity	Identidade para o conjunto de escala da máquina virtual.
VirtualMachineScaleSetIPConfiguration	Descreve a configuração IP do perfil de rede de um conjunto de dimensionamento de máquina virtual.
VirtualMachineScaleSetIpTag	Contém a marca IP associada ao endereço IP público.
VirtualMachineScaleSetManagedDiskParameters	Descreve os parâmetros de um disco gerenciado ScaleSet.
VirtualMachineScaleSetNetworkConfiguration	Descreve as configurações de rede de um perfil de rede do conjunto de dimensionamento de máquina virtual.
VirtualMachineScaleSetNetworkConfigurationDnsSettings	Descreve uma escala de máquinas virtuais que define as configurações de DNS da rede.
VirtualMachineScaleSetNetworkProfile	Descreve um perfil de rede de conjunto de escala de máquina virtual.
VirtualMachineScaleSetOSDisk	Descreve um disco do sistema operacional do conjunto de dimensionamento de máquina virtual.
VirtualMachineScaleSetOSProfile	Descreve um perfil de sistema operacional de conjunto de escala de máquina virtual.
VirtualMachineScaleSetPublicIPAddressConfiguration	Descreve um conjunto de dimensionamento de máquinas virtuais Configuração IP da configuração PublicIPAddress
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Descreve uma escala de máquinas virtuais que define as configurações de DNS da rede.
VirtualMachineScaleSetScaleInRules
VirtualMachineScaleSetStorageProfile	Descreve um perfil de armazenamento de conjunto de escala de máquina virtual.
VirtualMachineScaleSetVMProfile	Descreve um perfil de máquina virtual de conjunto de escala de máquina virtual.
VMDiskSecurityProfile	Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais.
VMGalleryApplication	Especifica as informações necessárias para fazer referência a uma versão do aplicativo da galeria de computação
VMSizeProperties	Especifica as configurações da Propriedade de Tamanho da VM na máquina virtual.
WindowsConfiguration	Especifica as configurações do sistema operacional Windows na máquina virtual.
WindowsPatchAssessmentMode	Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.
WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Windows.
WindowsVMGuestPatchMode	Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível. Os valores possíveis são: Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true. AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true
WinRMConfiguration	Descreve a configuração do Gerenciamento Remoto do Windows da VM
WinRMListener	Descreve o protocolo e a impressão digital do ouvinte do Gerenciamento Remoto do Windows
ZonalPlatformFaultDomainAlignMode	Especifica o modo de alinhamento entre a computação do Conjunto de Escala da Máquina Virtual e a contagem de Domínio de Falha de armazenamento.
ZoneAllocationPolicy	Os parâmetros de configuração para alocação de zona de um conjunto de escala de máquina virtual.
ZonePlacementPolicyType	Especifica a política de posicionamento do recurso na zona de disponibilidade. Os valores possíveis são: Qualquer (usado para Máquinas Virtuais), Automático (usado para Conjuntos de Dimensionamento de Máquinas Virtuais) - Uma zona de disponibilidade será escolhida automaticamente pelo sistema como parte da criação de recursos.

AdditionalCapabilities

Objetivo

Habilita ou desabilita um recurso na máquina virtual ou no conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
enableFips1403Encryption	boolean	O sinalizador permite o uso de criptografia compatível com FIPS 140-3 nas configurações protegidas de uma extensão. Saiba mais em: https://aka.ms/linuxagentfipssupport.
hibernationEnabled	boolean	O sinalizador que habilita ou desabilita a capacidade de hibernação na VM.
ultraSSDEnabled	boolean	O sinalizador que habilita ou desabilita um recurso para ter um ou mais discos de dados gerenciados com UltraSSD_LRS tipo de conta de armazenamento na VM ou VMSS. Os discos gerenciados com UltraSSD_LRS tipo de conta de armazenamento podem ser adicionados a uma máquina virtual ou a um conjunto de dimensionamento de máquina virtual somente se essa propriedade estiver habilitada.

AdditionalUnattendContent

Objetivo

Especifica informações adicionais formatadas em XML que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows. O conteúdo é definido definindo o nome, o nome do componente e a passagem na qual o conteúdo é aplicado.

Nome	Tipo	Descrição
componentName	ComponentNames	O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.
content	string	Especifica o conteúdo formatado em XML que é adicionado ao arquivo de unattend.xml para o caminho e o componente especificados. O XML deve ter menos de 4KB e deve incluir o elemento raiz para a configuração ou recurso que está sendo inserido.
passName	PassNames	O nome do passe. Atualmente, o único valor permitido é OobeSystem.
settingName	SettingNames	Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

AllInstancesDown

Objetivo

Especifica se os Eventos Agendados devem ser aprovados automaticamente quando todas as instâncias estiverem inativas.

Nome	Tipo	Descrição
automaticallyApprove	boolean	Especifica se os Eventos Agendados devem ser aprovados automaticamente quando todas as instâncias estiverem inativas. Seu valor padrão é true

AllocationStrategy

Enumeração

Especifica a estratégia de alocação para o conjunto de escala de máquina virtual com base no qual as VMs serão alocadas.

Valor	Descrição
LowestPrice
CapacityOptimized
Prioritized

ApiEntityReference

Objetivo

A referência da entidade da API.

Nome	Tipo	Descrição
id	string	A ID do recurso ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Objetivo

Erro de api.

Nome	Tipo	Descrição
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApiErrorBase

Objetivo

Base de erro da api.

Nome	Tipo	Descrição
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApplicationProfile

Objetivo

Contém a lista de aplicativos de galeria que devem ser disponibilizados para a VM/VMSS

Nome	Tipo	Descrição
galleryApplications	VMGalleryApplication[]	Especifica os aplicativos de galeria que devem ser disponibilizados para a VM/VMSS

AutomaticOSUpgradePolicy

Objetivo

Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

Nome	Tipo	Descrição
disableAutomaticRollback	boolean	Se o recurso de reversão de imagem do sistema operacional deve ser desativado. O valor predefinido é falso.
enableAutomaticOSUpgrade	boolean	Indica se as atualizações do sistema operacional devem ser aplicadas automaticamente para dimensionar instâncias do conjunto de forma contínua quando uma versão mais recente da imagem do sistema operacional estiver disponível. O valor predefinido é falso. Se isso for definido como true para conjuntos de escala baseados no Windows, enableAutomaticUpdates será automaticamente definido como false e não poderá ser definido como true.
osRollingUpgradeDeferral	boolean	Indica se a Atualização Automática do SO deve sofrer adiamento. As atualizações adiadas do sistema operacional enviarão notificações avançadas por VM de que uma atualização do sistema operacional de atualizações contínuas está chegando, por meio da tag IMDS 'Platform.PendingOSUpgrade'. Em seguida, a atualização é adiada até que seja aprovada por meio de uma chamada ApproveRollingUpgrade.
useRollingUpgradePolicy	boolean	Indica se a política de atualização contínua deve ser usada durante a Atualização Automática do SO. O valor predefinido é falso. A Atualização Automática do SO retornará à política padrão se nenhuma política for definida no VMSS.

AutomaticRepairsPolicy

Objetivo

Especifica os parâmetros de configuração para reparos automáticos no conjunto de escala da máquina virtual.

Nome	Tipo	Descrição
enabled	boolean	Especifica se os reparos automáticos devem ser habilitados no conjunto de dimensionamento da máquina virtual. O valor predefinido é false.
gracePeriod	string	A quantidade de tempo durante a qual os reparos automáticos são suspensos devido a uma alteração de estado na VM. O tempo de carência começa após a conclusão da mudança de estado. Isto ajuda a evitar reparações prematuras ou acidentais. A duração do tempo deve ser especificada no formato ISO 8601. O período de carência mínimo permitido é de 10 minutos (PT10M), que também é o valor padrão. O período de carência máximo permitido é de 90 minutos (PT90M).
repairAction	RepairAction	Tipo de ação de reparo (substituir, reiniciar, recriar imagem) que será usada para reparar máquinas virtuais não íntegras no conjunto de escala. O valor padrão é substituir.

AutomaticZoneRebalancingPolicy

Objetivo

Os parâmetros de configuração usados durante a execução do balanceamento AZ automático.

Nome	Tipo	Descrição
enabled	boolean	Especifica se o balanceamento AZ automático deve ser habilitado no conjunto de dimensionamento da máquina virtual. O valor predefinido é false.
rebalanceBehavior	RebalanceBehavior	Tipo de comportamento de reequilíbrio que será usado para recriar máquinas virtuais na escala definida em zonas de disponibilidade. O valor padrão e suportado apenas por enquanto é CreateBeforeDelete.
rebalanceStrategy	RebalanceStrategy	Tipo de estratégia de reequilíbrio que será usada para reequilibrar máquinas virtuais na escala definida entre zonas de disponibilidade. O valor padrão e suportado apenas por enquanto é Recriar.

BillingProfile

Objetivo

Especifica os detalhes relacionados à cobrança de uma VM ou VMSS spot do Azure. Versão api mínima: 2019-03-01.

Nome	Tipo	Descrição
maxPrice	number (double)	Especifica o preço máximo que você está disposto a pagar por uma VM/VMSS spot do Azure. Este preço é em dólares americanos. Esse preço será comparado com o preço spot atual do Azure para o tamanho da VM. Além disso, os preços são comparados no momento da criação/atualização do Azure Spot VM/VMSS e a operação só terá êxito se o maxPrice for maior do que o preço atual do Azure Spot. O maxPrice também será usado para remover uma VM/VMSS spot do Azure se o preço atual do Azure Spot for além do maxPrice após a criação da VM/VMSS. Os valores possíveis são: - Qualquer valor decimal superior a zero. Exemplo: 0,01538 -1 – indica o preço padrão a ser up-to sob demanda. Você pode definir maxPrice como -1 para indicar que a VM/VMSS spot do Azure não deve ser removida por motivos de preço. Além disso, o preço máximo padrão é -1 se não for fornecido por você. Versão api mínima: 2019-03-01.

BootDiagnostics

Objetivo

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

Nome	Tipo	Descrição
enabled	boolean	Se o diagnóstico de inicialização deve ser habilitado na máquina virtual.
storageUri	string	Uri da conta de armazenamento a ser usada para colocar a saída do console e a captura de tela. Se storageUri não for especificado ao habilitar o diagnóstico de inicialização, o armazenamento gerenciado será usado.

CachingTypes

Enumeração

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium

Valor	Descrição
None
ReadOnly
ReadWrite

CapacityReservationProfile

Objetivo

Os parâmetros de um Perfil de reserva de capacidade.

Nome	Tipo	Descrição
capacityReservationGroup	SubResource	Especifica a id de recurso do grupo de reserva de capacidade que deve ser usada para alocar a máquina virtual ou as instâncias vm do conjunto de escalas, desde que a capacidade suficiente tenha sido reservada. Consulte https://aka.ms/CapacityReservation para obter mais detalhes.

CloudError

Objetivo

Uma resposta de erro do serviço de computação.

Nome	Tipo	Descrição
error	ApiError	Erro de api.

ComponentNames

Enumeração

Valor	Descrição
Microsoft-Windows-Shell-Setup

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DeleteOptions

Enumeração

Especificar o que acontece com a interface de rede quando a VM é excluída

Valor	Descrição
Delete
Detach

DiagnosticsProfile

Objetivo

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.

Nome	Tipo	Descrição
bootDiagnostics	BootDiagnostics	O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. NOTA: Se storageUri estiver sendo especificado, verifique se a conta de armazenamento está na mesma região e assinatura que a VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

DiffDiskOptions

Enumeração

Especifica a opção de disco efêmero para o disco do sistema operacional.

Valor	Descrição
Local

DiffDiskPlacement

Enumeração

Especifica o posicionamento efêmero do disco do sistema operacional. Esta propriedade pode ser usada pelo usuário na solicitação para escolher o local, ou seja, disco de cache, disco de recurso ou espaço em disco nvme para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para Windows VM em https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e Linux VM em https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Versão mínima da api para NvmeDisk: 2024-03-01.

Valor	Descrição
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Objetivo

Descreve os parâmetros das configurações de disco efêmero que podem ser especificadas para o disco do sistema operacional. Nota: As configurações de disco efêmero só podem ser especificadas para o disco gerenciado.

Nome	Tipo	Descrição
option	DiffDiskOptions	Especifica as configurações de disco efêmero para o disco do sistema operacional.
placement	DiffDiskPlacement	Especifica o posicionamento efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Versão mínima da api para NvmeDisk: 2024-03-01.

DiskControllerTypes

Enumeração

Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Esta propriedade só é suportada para máquinas virtuais cujo disco do sistema operativo e sku de VM suporta a Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique a capacidade HyperVGenerations retornada como parte das capacidades de sku de VM na resposta da API de SKUs Microsoft.Compute para a região contém V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Para obter mais informações sobre os tipos de controlador de disco suportados, consulte https://aka.ms/azure-diskcontrollertypes.

Valor	Descrição
SCSI
NVMe

DiskCreateOptionTypes

Enumeração

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.

Valor	Descrição
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

Enumeração

Especifica o comportamento do disco gerenciado quando a VM é excluída, por exemplo, se o disco gerenciado é excluído ou desanexado. Os valores suportados são: Delete. Se esse valor for usado, o disco gerenciado será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco gerenciado será retido depois que a VM for excluída. Versão mínima da api: 2021-03-01.

Valor	Descrição
Delete
Detach

DiskEncryptionSetParameters

Objetivo

Descreve o parâmetro de id de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificado para o disco. Nota: O ID do recurso do conjunto de criptografia de disco só pode ser especificado para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.

Nome	Tipo	Descrição
id	string	ID do recurso

DomainNameLabelScopeTypes

Enumeração

O escopo do rótulo de nome de domínio. A concatenação do rótulo de nome de domínio com hash gerado de acordo com a política do escopo do rótulo de nome de domínio e do índice vm serão os rótulos de nome de domínio dos recursos de endereço PublicIPAddress que serão criados

Valor	Descrição
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

EncryptionIdentity

Objetivo

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

Nome	Tipo	Descrição
userAssignedIdentityResourceId	string	Especifica a ID de recurso ARM de uma das identidades de usuário associadas à VM.

EventGridAndResourceGraph

Objetivo

Especifica as configurações relacionadas a eventos agendados relacionados a eventGridAndResourceGraph.

Nome	Tipo	Descrição
enable	boolean	Especifica se a grade de eventos e o gráfico de recursos estão habilitados para configurações relacionadas a eventos agendados.
scheduledEventsApiVersion	string	Especifica a versão da api para determinar qual versão do esquema de configuração de Eventos Agendados será entregue.

ExpandTypesForGetVMScaleSets

Enumeração

Valor	Descrição
userData

ExtendedLocation

Objetivo

O tipo complexo do local estendido.

Nome	Tipo	Descrição
name	string	O nome do local estendido.
type	ExtendedLocationTypes	O tipo de localização ampliada.

ExtendedLocationTypes

Enumeração

O tipo de localização ampliada.

Valor	Descrição
EdgeZone

HighSpeedInterconnectPlacement

Enumeração

Especifica o posicionamento da interconexão de alta velocidade para o conjunto de escala da máquina virtual.

Valor	Descrição
None	Sem colocação de interconexão de alta velocidade
Trunk	Colocação de interconexão de alta velocidade do tronco

HostEndpointSettings

Objetivo

Especifica configurações específicas do ponto de extremidade do host.

Nome	Tipo	Descrição
inVMAccessControlProfileReferenceId	string	Especifica a id do recurso InVMAccessControlProfileVersion no formato /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}
mode	Modes	Especifica o modo de execução. No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Enforce, o sistema irá impor o controle de acesso e é o modo recomendado de operação.

ImageReference

Objetivo

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação. NOTA: O editor e a oferta de referência de imagem só podem ser definidos quando cria o conjunto de escalas.

Nome	Tipo	Descrição
communityGalleryImageId	string	Especificada a id exclusiva da imagem da galeria da comunidade para implantação de vm. Isso pode ser obtido na chamada GET da galeria da galeria da comunidade.
exactVersion	string	Especifica em números decimais, a versão da imagem da plataforma ou da imagem do mercado usada para criar a máquina virtual. Este campo só de leitura difere de «versão», apenas se o valor especificado no campo «versão» for «mais recente».
id	string	ID do recurso
offer	string	Especifica a oferta da imagem da plataforma ou imagem do mercado usada para criar a máquina virtual.
publisher	string	A editora de imagens.
sharedGalleryImageId	string	Especificada a id exclusiva da imagem da galeria compartilhada para implantação de vm. Isso pode ser obtido na chamada GET da imagem compartilhada da galeria.
sku	string	A imagem SKU.
version	string	Especifica a versão da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual. Os formatos permitidos são Major.Minor.Build ou 'mais recente'. Major, Minor e Build são números decimais. Especifique 'mais recente' para usar a versão mais recente de uma imagem disponível no momento da implantação. Mesmo se você usar 'mais recente', a imagem da VM não será atualizada automaticamente após o tempo de implantação, mesmo que uma nova versão fique disponível. Por favor, não use o campo 'versão' para a implantação da imagem da galeria, a imagem da galeria deve sempre usar o campo 'id' para implantação, para usar a versão 'mais recente' da imagem da galeria, basta definir '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' no campo 'id' sem entrada de versão.

InnerError

Objetivo

Detalhes do erro interno.

Nome	Tipo	Descrição
errordetail	string	A mensagem de erro interna ou despejo de exceção.
exceptiontype	string	O tipo de exceção.

IPVersion

Enumeração

Disponível a partir de 30-03-Api-Version 2017, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

Valor	Descrição
IPv4
IPv6

KeyVaultSecretReference

Objetivo

Descreve uma referência ao segredo do Key Vault

Nome	Tipo	Descrição
secretUrl	string	O URL que faz referência a um segredo em um Cofre de Chaves.
sourceVault	SubResource	O URL relativo do Cofre da Chave que contém o segredo.

LinuxConfiguration

Objetivo

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

Nome	Tipo	Descrição
disablePasswordAuthentication	boolean	Especifica se a autenticação de senha deve ser desabilitada.
enableVMAgentPlatformUpdates	boolean	Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a máquina virtual Linux. O valor predefinido é falso.
patchSettings	LinuxPatchSettings	[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.
provisionVMAgent	boolean	Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la como true. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.
ssh	SshConfiguration	Especifica a configuração da chave ssh para um sistema operacional Linux.

LinuxPatchAssessmentMode

Enumeração

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

Valor	Descrição
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Objetivo

Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

Nome	Tipo	Descrição
assessmentMode	LinuxPatchAssessmentMode	Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Linux.
patchMode	LinuxVMGuestPatchMode	Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível. Os valores possíveis são: ImageDefault - A configuração de patch padrão da máquina virtual é usada. AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Enumeração

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

Valor	Descrição
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Objetivo

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Linux.

Nome	Tipo	Descrição
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite que o cliente agende patches sem atualizações acidentais
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

LinuxVMGuestPatchMode

Enumeração

Valor	Descrição
ImageDefault
AutomaticByPlatform

MaxInstancePercentPerZonePolicy

Objetivo

Os parâmetros de configuração usados para limitar o número de máquinas virtuais por zona de disponibilidade no conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
enabled	boolean	Especifica se maxInstancePercentPerZonePolicy deve ser habilitado no conjunto de dimensionamento da máquina virtual.
value	integer (int32) maximum: 100	Limite o número de instâncias em cada zona como uma porcentagem da capacidade total do conjunto de escala da máquina virtual.

Mode

Enumeração

Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.

Valor	Descrição
Audit
Enforce

Modes

Enumeração

Especifica o modo de execução. No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Enforce, o sistema irá impor o controle de acesso e é o modo recomendado de operação.

Valor	Descrição
Audit
Enforce
Disabled

NetworkApiVersion

Enumeração

especifica a versão da API Microsoft.Network usada ao criar recursos de rede nas Configurações da Interface de Rede

Valor	Descrição
2020-11-01
2022-11-01

NetworkInterfaceAuxiliaryMode

Enumeração

Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.

Valor	Descrição
None
AcceleratedConnections
Floating

NetworkInterfaceAuxiliarySku

Enumeração

Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.

Valor	Descrição
None
A1
A2
A4
A8

OperatingSystemTypes

Enumeração

Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir da imagem do usuário ou de um VHD especializado. Os valores possíveis são: Windows,Linux.

Valor	Descrição
Windows
Linux

OrchestrationMode

Enumeração

Especifica o modo de orquestração para o conjunto de escala da máquina virtual.

Valor	Descrição
Uniform
Flexible

OSImageNotificationProfile

Objetivo

Nome	Tipo	Descrição
enable	boolean	Especifica se o evento Imagem do SO Agendada está ativado ou desativado.
notBeforeTimeout	string	Período de tempo em que uma máquina virtual que está sendo recriada ou que tem seu sistema operacional atualizado terá que aprovar potencialmente o evento agendado de imagem do sistema operacional antes que o evento seja aprovado automaticamente (tempo limite). A configuração é especificada no formato ISO 8601 e o valor deve ser de 15 minutos (PT15M)

PassNames

Enumeração

Valor	Descrição
OobeSystem

PatchSettings

Objetivo

Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

Nome	Tipo	Descrição
assessmentMode	WindowsPatchAssessmentMode	Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS. Os valores possíveis são: ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual. AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Windows.
enableHotpatching	boolean	Permite que os clientes corrijam suas VMs do Azure sem exigir uma reinicialização. Para enableHotpatching, o 'provisionVMAgent' deve ser definido como true e 'patchMode' deve ser definido como 'AutomaticByPlatform'.
patchMode	WindowsVMGuestPatchMode	Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível. Os valores possíveis são: Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true. AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

Placement

Objetivo

Descreve as restrições definidas pelo usuário para o posicionamento de hardware de recursos.

Nome	Tipo	Descrição
excludeZones	string[]	Esta propriedade complementa a propriedade 'zonePlacementPolicy'. Se 'zonePlacementPolicy' estiver definido como 'Any'/'Auto', a zona de disponibilidade selecionada pelo sistema não deve estar presente na lista de zonas de disponibilidade passadas com 'excludeZones'. Se 'excludeZones' não for fornecido, todas as zonas de disponibilidade na região serão consideradas para seleção.
includeZones	string[]	Esta propriedade complementa a propriedade 'zonePlacementPolicy'. Se 'zonePlacementPolicy' estiver definido como 'Any'/'Auto', a zona de disponibilidade selecionada pelo sistema deve estar presente na lista de zonas de disponibilidade passadas com 'includeZones'. Se 'includeZones' não for fornecido, todas as zonas de disponibilidade na região serão consideradas para seleção.
zonePlacementPolicy	ZonePlacementPolicyType	Especifica a política de posicionamento do recurso na zona de disponibilidade. Os valores possíveis são: Qualquer (usado para Máquinas Virtuais), Automático (usado para Conjuntos de Dimensionamento de Máquinas Virtuais) - Uma zona de disponibilidade será escolhida automaticamente pelo sistema como parte da criação de recursos.

Plan

Objetivo

Especifica informações sobre a imagem do marketplace usada para criar a máquina virtual. Este elemento é usado apenas para imagens do mercado. Antes de poder usar uma imagem de mercado de uma API, você deve habilitar a imagem para uso programático. No portal do Azure, localize a imagem do marketplace que pretende utilizar e, em seguida, clique em Pretende implementar programaticamente, Introdução ->. Introduza todas as informações necessárias e, em seguida, clique em Guardar.

Nome	Tipo	Descrição
name	string	O ID do plano.
product	string	Especifica o produto da imagem do mercado. Este é o mesmo valor que Offer sob o elemento imageReference.
promotionCode	string	O código promocional.
publisher	string	O ID do editor.

PriorityMixPolicy

Objetivo

Especifica as divisões de destino para VMs de prioridade Spot e Regular dentro de um conjunto de escala com modo de orquestração flexível. Com essa propriedade, o cliente pode especificar o número base de VMs de prioridade regular criadas à medida que a instância flexível do VMSS se expande e a divisão entre VMs de prioridade Spot e Regular após esse destino base ter sido atingido.

Nome	Tipo	Descrição
baseRegularPriorityCount	integer (int32)	O número base de VMs de prioridade regular que serão criadas nessa escala definida à medida que ela se expande.
regularPriorityPercentageAboveBase	integer (int32) maximum: 100	A porcentagem de instâncias de VM, após a contagem de prioridade regular de base ter sido atingida, que devem usar prioridade regular.

ProtocolTypes

Enumeração

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.

Valor	Descrição
Http
Https

ProxyAgentSettings

Objetivo

Especifica as configurações do ProxyAgent para a máquina virtual ou o conjunto de dimensionamento da máquina virtual. Versão mínima da api: 2023-09-01.

Nome	Tipo	Descrição
addProxyAgentExtension	boolean	Especifique se deseja instalar implicitamente a extensão ProxyAgent. Atualmente, esta opção é aplicável apenas para Linux OS.
enabled	boolean	Especifica se o recurso ProxyAgent deve ser habilitado na máquina virtual ou no conjunto de dimensionamento da máquina virtual.
imds	HostEndpointSettings	Especifica as configurações do ponto de extremidade IMDS ao criar a máquina virtual ou o conjunto de dimensionamento da máquina virtual. Versão api mínima: 2024-03-01.
keyIncarnationId	integer (int32)	Aumentar o valor dessa propriedade permite que os usuários redefina a chave usada para proteger o canal de comunicação entre convidado e host.
mode	Mode	Especifica o modo em que o ProxyAgent será executado. Aviso: esta propriedade foi preterida, especifique 'modo' em particular configuração hostendpoint.
wireServer	HostEndpointSettings	Especifica as configurações do ponto de extremidade do Wire Server durante a criação da máquina virtual ou do conjunto de dimensionamento da máquina virtual. Versão api mínima: 2024-03-01.

PublicIPAddressSku

Objetivo

Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.

Nome	Tipo	Descrição
name	PublicIPAddressSkuName	Especificar nome de sku IP público
tier	PublicIPAddressSkuTier	Especificar camada de sku IP público

PublicIPAddressSkuName

Enumeração

Especificar nome de sku IP público

Valor	Descrição
Basic
Standard

PublicIPAddressSkuTier

Enumeração

Especificar camada de sku IP público

Valor	Descrição
Regional
Global

RebalanceBehavior

Enumeração

Tipo de comportamento de reequilíbrio que será usado para recriar máquinas virtuais na escala definida em zonas de disponibilidade. O valor padrão e suportado apenas por enquanto é CreateBeforeDelete.

Valor	Descrição
CreateBeforeDelete

RebalanceStrategy

Enumeração

Tipo de estratégia de reequilíbrio que será usada para reequilibrar máquinas virtuais na escala definida entre zonas de disponibilidade. O valor padrão e suportado apenas por enquanto é Recriar.

Valor	Descrição
Recreate

RepairAction

Enumeração

Tipo de ação de reparo (substituir, reiniciar, recriar imagem) que será usada para reparar máquinas virtuais não íntegras no conjunto de escala. O valor padrão é substituir.

Valor	Descrição
Replace
Restart
Reimage

ResiliencyPolicy

Objetivo

Descreve uma política de resiliência - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy e/ou ResilientVMDeletionPolicy.

Nome	Tipo	Descrição
automaticZoneRebalancingPolicy	AutomaticZoneRebalancingPolicy	Os parâmetros de configuração usados durante a execução do balanceamento AZ automático.
resilientVMCreationPolicy	ResilientVMCreationPolicy	Os parâmetros de configuração usados durante a execução da criação de VM resiliente.
resilientVMDeletionPolicy	ResilientVMDeletionPolicy	Os parâmetros de configuração usados ao executar a exclusão de VM resiliente.
zoneAllocationPolicy	ZoneAllocationPolicy	Os parâmetros de configuração usados durante a execução da alocação de zona.

ResilientVMCreationPolicy

Objetivo

Os parâmetros de configuração usados durante a execução da criação de VM resiliente.

Nome	Tipo	Descrição
enabled	boolean	Especifica se a criação de VM resiliente deve ser habilitada no conjunto de escala da máquina virtual. O valor predefinido é false.

ResilientVMDeletionPolicy

Objetivo

Os parâmetros de configuração usados ao executar a exclusão de VM resiliente.

Nome	Tipo	Descrição
enabled	boolean	Especifica se a exclusão de VM resiliente deve ser habilitada no conjunto de dimensionamento da máquina virtual. O valor predefinido é false.

ResourceIdentityType

Enumeração

O tipo de identidade usado para o conjunto de dimensionamento de máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do conjunto de escala da máquina virtual.

Valor	Descrição
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

RollingUpgradePolicy

Objetivo

Os parâmetros de configuração usados durante a execução de uma atualização contínua.

Nome	Tipo	Descrição
enableCrossZoneUpgrade	boolean	Permita que o VMSS ignore os limites AZ ao construir lotes de atualização. Leve em consideração o Domínio de Atualização e maxBatchInstancePercent para determinar o tamanho do lote.
maxBatchInstancePercent	integer (int32) minimum: 5 maximum: 100	A porcentagem máxima do total de instâncias de máquina virtual que serão atualizadas simultaneamente pela atualização sem interrupção em um lote. Como isso é máximo, instâncias não íntegras em lotes anteriores ou futuros podem fazer com que a porcentagem de instâncias em um lote diminua para garantir maior confiabilidade. O valor padrão para esse parâmetro é 20%.
maxSurge	boolean	Crie novas máquinas virtuais para atualizar o conjunto de escala, em vez de atualizar as máquinas virtuais existentes. As máquinas virtuais existentes serão excluídas assim que as novas máquinas virtuais forem criadas para cada lote.
maxUnhealthyInstancePercent	integer (int32) minimum: 5 maximum: 100	A porcentagem máxima do total de instâncias de máquina virtual no conjunto de escala que pode estar simultaneamente não íntegra, seja como resultado de ser atualizada ou por ser encontrada em um estado não íntegro pelas verificações de integridade da máquina virtual antes que a atualização contínua seja abortada. Esta restrição será verificada antes de iniciar qualquer lote. O valor padrão para esse parâmetro é 20%.
maxUnhealthyUpgradedInstancePercent	integer (int32) maximum: 100	A porcentagem máxima de instâncias de máquina virtual atualizadas que podem ser encontradas em um estado não íntegro. Essa verificação acontecerá depois que cada lote for atualizado. Se essa porcentagem for excedida, a atualização contínua será anulada. O valor padrão para esse parâmetro é 20%.
pauseTimeBetweenBatches	string	O tempo de espera entre a conclusão da atualização para todas as máquinas virtuais em um lote e o início do próximo lote. A duração do tempo deve ser especificada no formato ISO 8601. O valor padrão é 0 segundos (PT0S).
prioritizeUnhealthyInstances	boolean	Atualize todas as instâncias não íntegras em um conjunto de escala antes de quaisquer instâncias íntegras.
rollbackFailedInstancesOnPolicyBreach	boolean	Reversão de instâncias com falha para o modelo anterior se a política de Atualização Contínua for violada.

ScaleInPolicy

Objetivo

Descreve uma política de dimensionamento para um conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
forceDeletion	boolean	Essa propriedade permite especificar se as máquinas virtuais escolhidas para remoção precisam ser excluídas à força quando um conjunto de dimensionamento de máquina virtual está sendo dimensionado. (Recurso na Pré-visualização)
prioritizeUnhealthyVMs	boolean	Essa propriedade permite priorizar a exclusão de VMs não íntegras e inativas quando um conjunto de dimensionamento de máquina virtual está sendo dimensionado. (Recurso na Pré-visualização)
rules	VirtualMachineScaleSetScaleInRules[]	As regras a serem seguidas ao dimensionar um conjunto de dimensionamento de máquina virtual. Os valores possíveis são: padrão Quando um conjunto de escala de máquina virtual é dimensionado, o conjunto de escala será primeiro balanceado entre zonas se for um conjunto de escala zonal. Em seguida, ele será balanceado entre Domínios de Falha na medida do possível. Dentro de cada Domínio de Falha, as máquinas virtuais escolhidas para remoção serão as mais recentes que não estão protegidas contra scale-in. OldestVM Quando um conjunto de dimensionamento de máquina virtual está sendo dimensionado, as máquinas virtuais mais antigas que não estão protegidas contra expansão serão escolhidas para remoção. Para conjuntos de escala de máquina virtual zonal, o conjunto de escala será primeiro balanceado entre zonas. Dentro de cada zona, as máquinas virtuais mais antigas que não estão protegidas serão escolhidas para remoção. NewestVM Quando um conjunto de dimensionamento de máquina virtual está sendo dimensionado, as máquinas virtuais mais recentes que não estão protegidas contra expansão serão escolhidas para remoção. Para conjuntos de escala de máquina virtual zonal, o conjunto de escala será primeiro balanceado entre zonas. Dentro de cada zona, as máquinas virtuais mais recentes que não estão protegidas serão escolhidas para remoção.

ScheduledEventsAdditionalPublishingTargets

Objetivo

Nome	Tipo	Descrição
eventGridAndResourceGraph	EventGridAndResourceGraph	Os parâmetros de configuração usados durante a criação da configuração de evento agendado eventGridAndResourceGraph.

ScheduledEventsPolicy

Objetivo

Especifica as configurações relacionadas a Redeploy, Reboot e ScheduledEventsAdditionalPublishingTargets Scheduled Event.

Nome	Tipo	Descrição
allInstancesDown	AllInstancesDown	Os parâmetros de configuração usados durante a criação da configuração de evento agendado AllInstancesDown.
scheduledEventsAdditionalPublishingTargets	ScheduledEventsAdditionalPublishingTargets	Os parâmetros de configuração usados durante a publicação scheduledEventsAdditionalPublishingTargets.
userInitiatedReboot	UserInitiatedReboot	Os parâmetros de configuração usados durante a criação da configuração de evento agendado userInitiatedReboot.
userInitiatedRedeploy	UserInitiatedRedeploy	Os parâmetros de configuração usados durante a criação da configuração de evento agendado userInitiatedRedeploy.

ScheduledEventsProfile

Objetivo

Nome	Tipo	Descrição
osImageNotificationProfile	OSImageNotificationProfile	Especifica as configurações relacionadas ao Evento Agendado de Imagem do SO.
terminateNotificationProfile	TerminateNotificationProfile	Especifica as configurações relacionadas a Encerrar Evento Agendado.

SecurityEncryptionTypes

Enumeração

Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais.

Valor	Descrição
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityPostureReference

Objetivo

Especifica a postura de segurança a ser usada no conjunto de escalas. Versão mínima da api: 2023-03-01

Nome	Tipo	Descrição
excludeExtensions	string[]	A lista de nomes de extensão de máquina virtual a serem excluídos ao aplicar a postura de segurança.
id	string	O id de referência da postura de segurança na forma de /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}\|latest
isOverridable	boolean	Se a postura de segurança pode ser substituída pelo usuário.

SecurityProfile

Objetivo

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento da máquina virtual.

Nome	Tipo	Descrição
encryptionAtHost	boolean	Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. O comportamento padrão é: A criptografia no host será desabilitada, a menos que essa propriedade seja definida como true para o recurso.
encryptionIdentity	EncryptionIdentity	Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.
proxyAgentSettings	ProxyAgentSettings	Especifica as configurações do ProxyAgent ao criar a máquina virtual. Versão mínima da api: 2023-09-01.
securityType	SecurityTypes	Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado a menos que essa propriedade esteja definida.
uefiSettings	UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

SecurityTypes

Enumeração

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado a menos que essa propriedade esteja definida.

Valor	Descrição
TrustedLaunch
ConfidentialVM

ServiceArtifactReference

Objetivo

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'. Versão mínima api: 2022-11-01

Nome	Tipo	Descrição
id	string	A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

SettingNames

Enumeração

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

Valor	Descrição
AutoLogon
FirstLogonCommands

Sku

Objetivo

Descreve um sku de conjunto de escala de máquina virtual. NOTA: Se a nova SKU de VM não for suportada no hardware em que o conjunto de escala está atualmente, você precisará desalocar as VMs no conjunto de escala antes de modificar o nome da SKU.

Nome	Tipo	Descrição
capacity	integer (int64)	Especifica o número de máquinas virtuais no conjunto de escala.
name	string	O nome do SKU.
tier	string	Especifica a camada de máquinas virtuais em um conjunto de escala. Valores possíveis: Standard Basic

SkuProfile

Objetivo

Especifica o perfil de sku para o conjunto de escala de máquina virtual. Com essa propriedade, o cliente pode especificar uma lista de tamanhos de VM e uma estratégia de alocação.

Nome	Tipo	Descrição
allocationStrategy	AllocationStrategy	Especifica a estratégia de alocação para o conjunto de escala de máquina virtual com base no qual as VMs serão alocadas.
vmSizes	SkuProfileVMSize[]	Especifica os tamanhos de VM para o conjunto de escala de máquina virtual.

SkuProfileVMSize

Objetivo

Especifica o tamanho da VM.

Nome	Tipo	Descrição
name	string	Especifica o nome do Tamanho da VM.
rank	integer (int32)	Especifica a classificação (também conhecida como prioridade) associada ao Tamanho da VM.

SpotRestorePolicy

Objetivo

Especifica as propriedades Spot-Try-Restore para o conjunto de escala da máquina virtual. Com essa propriedade, o cliente pode habilitar ou desabilitar a restauração automática das instâncias de VM spot removidas oportunisticamente com base na disponibilidade de capacidade e na restrição de preços.

Nome	Tipo	Descrição
enabled	boolean	Habilita o recurso Spot-Try-Restore em que instâncias VMSS SPOT removidas serão tentadas para serem restauradas oportunisticamente com base na disponibilidade de capacidade e restrições de preços
restoreTimeout	string	Valor de tempo limite expresso como uma duração de tempo ISO 8601 após o qual a plataforma não tentará restaurar as instâncias SPOT do VMSS

SshConfiguration

Objetivo

Configuração SSH para VMs baseadas em Linux em execução no Azure

Nome	Tipo	Descrição
publicKeys	SshPublicKey[]	A lista de chaves públicas SSH usadas para autenticar com VMs baseadas em linux.

SshPublicKey

Objetivo

Contém informações sobre a chave pública do certificado SSH e o caminho na VM Linux onde a chave pública é colocada.

Nome	Tipo	Descrição
keyData	string	Certificado de chave pública SSH usado para autenticar com a VM através do ssh. A chave precisa ser de pelo menos 2048 bits e no formato ssh-rsa. Para criar chaves ssh, consulte [Criar chaves SSH no Linux e Mac para VMs Linux no Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Especifica o caminho completo na VM criada onde a chave pública ssh é armazenada. Se o arquivo já existir, a chave especificada será anexada ao arquivo. Exemplo: /home/user/.ssh/authorized_keys

StorageAccountTypes

Enumeração

Especifica o tipo de conta de armazenamento para o disco gerenciado. O tipo de conta de armazenamento em disco do sistema operacional gerenciado só pode ser definido quando você cria o conjunto de escala. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados. Ele não pode ser usado com o OS Disk. Standard_LRS usa HDD padrão. StandardSSD_LRS usa SSD padrão. Premium_LRS usa SSD Premium. UltraSSD_LRS usa o disco Ultra. Premium_ZRS usa armazenamento redundante de zona SSD Premium. StandardSSD_ZRS usa armazenamento redundante de zona SSD padrão. Para obter mais informações sobre discos suportados para Máquinas Virtuais do Windows, consulte https://docs.microsoft.com/azure/virtual-machines/windows/disks-types e, para Máquinas Virtuais Linux, consulte https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Valor	Descrição
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

SubResource

Objetivo

Nome	Tipo	Descrição
id	string	ID do recurso

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TerminateNotificationProfile

Objetivo

Nome	Tipo	Descrição
enable	boolean	Especifica se o evento Encerrar agendado está habilitado ou desabilitado.
notBeforeTimeout	string	O período de tempo configurável que uma Máquina Virtual que está sendo excluída terá que aprovar potencialmente o Evento Agendado de Término antes que o evento seja aprovado automaticamente (tempo limite). A configuração deve ser especificada no formato ISO 8601, o valor padrão é 5 minutos (PT5M)

UefiSettings

Objetivo

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

Nome	Tipo	Descrição
secureBootEnabled	boolean	Especifica se a inicialização segura deve ser habilitada na máquina virtual. Versão api mínima: 2020-12-01.
vTpmEnabled	boolean	Especifica se o vTPM deve ser habilitado na máquina virtual. Versão api mínima: 2020-12-01.

UpgradeMode

Enumeração

Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala.

Os valores possíveis são:

Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade.

automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.

Valor	Descrição
Automatic
Manual
Rolling

UpgradePolicy

Objetivo

Descreve uma política de atualização - automática, manual ou rolante.

Nome	Tipo	Descrição
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	Parâmetros de configuração usados para executar a atualização automática do sistema operacional.
mode	UpgradeMode	Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala. Os valores possíveis são: Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade. automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.
rollingUpgradePolicy	RollingUpgradePolicy	Os parâmetros de configuração usados durante a execução de uma atualização contínua.

UserAssignedIdentitiesValue

Objetivo

Nome	Tipo	Descrição
clientId	string	O ID do cliente da identidade atribuída ao usuário.
principalId	string	O id principal da identidade atribuída ao usuário.

UserInitiatedReboot

Objetivo

Especifica as configurações relacionadas a Eventos Agendados relacionados à Reinicialização.

Nome	Tipo	Descrição
automaticallyApprove	boolean	Especifica as configurações relacionadas ao Evento Agendado de Reinicialização.

UserInitiatedRedeploy

Objetivo

Especifica Reimplantar configurações relacionadas a Eventos Agendados relacionados.

Nome	Tipo	Descrição
automaticallyApprove	boolean	Especifica as configurações relacionadas a Reimplantar Evento Agendado.

VaultCertificate

Objetivo

Descreve uma única referência de certificado em um Cofre de Chaves e onde o certificado deve residir na VM.

Nome	Tipo	Descrição
certificateStore	string	Para VMs do Windows, especifica o armazenamento de certificados na Máquina Virtual ao qual o certificado deve ser adicionado. O armazenamento de certificados especificado está implicitamente na conta LocalMachine. Para VMs Linux, o arquivo de certificado é colocado no diretório /var/lib/waagent, com o nome do arquivo <UppercaseThumbprint>.crt para o arquivo de certificado X509 e <UppercaseThumbprint>.prv para chave privada. Ambos os arquivos são .pem formatado.
certificateUrl	string	Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo. Para adicionar um segredo ao Cofre de Chaves, consulte Adicionar uma chave ou segredo ao Cofre de Chaves. Nesse caso, seu certificado precisa ser É a codificação Base64 do seguinte objeto JSON que é codificado em UTF-8: { "data":"<certificado codificado em Base64>", "dataType":"pfx", "senha":"<pfx-file-password>" } Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

VaultSecretGroup

Objetivo

Descreve um conjunto de certificados que estão todos no mesmo Cofre de Chaves.

Nome	Tipo	Descrição
sourceVault	SubResource	A URL relativa do Cofre da Chave que contém todos os certificados em VaultCertificates.
vaultCertificates	VaultCertificate[]	A lista de referências do cofre de chaves no SourceVault que contêm certificados.

VirtualHardDisk

Objetivo

Descreve o uri de um disco.

Nome	Tipo	Descrição
uri	string	Especifica o uri do disco rígido virtual.

VirtualMachineEvictionPolicyTypes

Enumeração

Especifica a política de remoção para a VM/VMSS do Azure Spot

Valor	Descrição
Deallocate
Delete

VirtualMachinePriorityTypes

Enumeração

Especifica a prioridade para uma máquina virtual autônoma ou as máquinas virtuais no conjunto de escala. O enum 'Baixo' será preterido no futuro, use 'Spot' como o enum para implantar o Azure Spot VM/VMSS.

Valor	Descrição
Regular
Low
Spot

VirtualMachineScaleSet

Objetivo

Descreve um conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
etag	string	Etag é a propriedade retornada em Create/Update/Get response do VMSS, para que o cliente possa fornecê-la no cabeçalho para garantir atualizações otimistas
extendedLocation	ExtendedLocation	O local estendido do Conjunto de Dimensionamento de Máquina Virtual.
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	VirtualMachineScaleSetIdentity	A identidade do conjunto de dimensionamento da máquina virtual, se configurado.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
placement	Placement	A seção Posicionamento especifica as restrições definidas pelo usuário para o posicionamento de hardware do conjunto de dimensionamento de máquinas virtuais. Essa propriedade não pode ser alterada depois que o VMSS é provisionado. Versão mínima api: 2025-04-01.
plan	Plan	Especifica informações sobre a imagem do marketplace usada para criar a máquina virtual. Este elemento é usado apenas para imagens do mercado. Antes de poder usar uma imagem de mercado de uma API, você deve habilitar a imagem para uso programático. No portal do Azure, localize a imagem do marketplace que pretende utilizar e, em seguida, clique em Pretende implementar programaticamente, Introdução ->. Introduza todas as informações necessárias e, em seguida, clique em Guardar.
properties.additionalCapabilities	AdditionalCapabilities	Especifica recursos adicionais habilitados ou desabilitados nas Máquinas Virtuais no Conjunto de Dimensionamento de Máquinas Virtuais. Por exemplo: se as Máquinas Virtuais têm a capacidade de suportar a anexação de discos de dados gerenciados com UltraSSD_LRS tipo de conta de armazenamento.
properties.automaticRepairsPolicy	AutomaticRepairsPolicy	Política para reparações automáticas.
properties.constrainedMaximumCapacity	boolean	Propriedade opcional que deve ser definida como True ou omitida.
properties.doNotRunExtensionsOnOverprovisionedVMs	boolean	Quando o Overprovision está habilitado, as extensões são iniciadas somente no número solicitado de VMs que são finalmente mantidas. Portanto, essa propriedade garantirá que as extensões não sejam executadas nas VMs extras superprovisionadas.
properties.highSpeedInterconnectPlacement	HighSpeedInterconnectPlacement	Especifica o posicionamento da interconexão de alta velocidade para o conjunto de escala da máquina virtual.
properties.hostGroup	SubResource	Especifica informações sobre o grupo de hosts dedicados no qual o conjunto de dimensionamento de máquina virtual reside. Versão api mínima: 2020-06-01.
properties.orchestrationMode	OrchestrationMode	Especifica o modo de orquestração para o conjunto de escala da máquina virtual.
properties.overprovision	boolean	Especifica se o Conjunto de Dimensionamento de Máquina Virtual deve ser provisionado em excesso.
properties.platformFaultDomainCount	integer (int32)	Contagem de domínio de falha para cada grupo de posicionamento.
properties.priorityMixPolicy	PriorityMixPolicy	Especifica os destinos desejados para misturar VMs de prioridade Spot e Regular na mesma instância do VMSS Flex.
properties.provisioningState	string	O estado de provisionamento, que só aparece na resposta.
properties.proximityPlacementGroup	SubResource	Especifica informações sobre o grupo de posicionamento de proximidade ao qual o conjunto de dimensionamento de máquina virtual deve ser atribuído. Versão api mínima: 2018-04-01.
properties.resiliencyPolicy	ResiliencyPolicy	Política de Resiliência
properties.scaleInPolicy	ScaleInPolicy	Especifica as políticas aplicadas ao dimensionar em Máquinas Virtuais no Conjunto de Dimensionamento de Máquinas Virtuais.
properties.scheduledEventsPolicy	ScheduledEventsPolicy	O ScheduledEventsPolicy.
properties.singlePlacementGroup	boolean	Quando verdadeiro, isso limita a escala definida a um único grupo de posicionamento, de tamanho máximo de 100 máquinas virtuais. Observação : se singlePlacementGroup for true, ele pode ser modificado para false. No entanto, se singlePlacementGroup for false, ele não pode ser modificado para true.
properties.skuProfile	SkuProfile	Especifica o perfil de sku para o conjunto de escala de máquina virtual.
properties.spotRestorePolicy	SpotRestorePolicy	Especifica as propriedades de Restauração Local para o conjunto de escala da máquina virtual.
properties.timeCreated	string (date-time)	Especifica a hora em que o recurso Conjunto de Escala de Máquina Virtual foi criado. Versão mínima api: 2021-11-01.
properties.uniqueId	string	Especifica a ID que identifica exclusivamente um Conjunto de Escala de Máquina Virtual.
properties.upgradePolicy	UpgradePolicy	A política de atualização.
properties.virtualMachineProfile	VirtualMachineScaleSetVMProfile	O perfil da máquina virtual.
properties.zonalPlatformFaultDomainAlignMode	ZonalPlatformFaultDomainAlignMode	Especifica o modo de alinhamento entre a computação do Conjunto de Escala da Máquina Virtual e a contagem de Domínio de Falha de armazenamento.
properties.zoneBalance	boolean	Se deve forçar estritamente mesmo a distribuição da Máquina Virtual entre zonas x no caso de haver interrupção de zona. A propriedade zoneBalance só pode ser definida se a propriedade zones do conjunto de escala contiver mais de uma zona. Se não houver zonas ou apenas uma zona especificada, a propriedade zoneBalance não deverá ser definida.
sku	Sku	O sku do conjunto de escala da máquina virtual.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
zones	string[]	As zonas de disponibilidade.

VirtualMachineScaleSetDataDisk

Objetivo

Descreve um disco de dados do conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.
createOption	DiskCreateOptionTypes	A opção criar.
deleteOption	DiskDeleteOptionTypes	Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão do VMSS Flex (esse recurso está disponível apenas para VMSS com Flexible OrchestrationMode). Valores possíveis: Excluir Se esse valor for usado, o disco de dados será excluído quando a VM VMSS Flex for excluída. Desanexar Se esse valor for usado, o disco de dados será retido depois que o VMSS Flex VM for excluído. O valor padrão é definido como Excluir.
diskIOPSReadWrite	integer (int64)	Especifica o IOPS Read-Write para o disco gerenciado. Deve ser usado somente quando StorageAccountType é UltraSSD_LRS. Se não for especificado, um valor padrão será atribuído com base em diskSizeGB.
diskMBpsReadWrite	integer (int64)	Especifica a largura de banda em MB por segundo para o disco gerenciado. Deve ser usado somente quando StorageAccountType é UltraSSD_LRS. Se não for especificado, um valor padrão será atribuído com base em diskSizeGB.
diskSizeGB	integer (int32)	Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade diskSizeGB é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.
lun	integer (int32)	Especifica o número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados conectado a uma VM.
managedDisk	VirtualMachineScaleSetManagedDiskParameters	Os parâmetros do disco gerenciado.
name	string	O nome do disco.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

VirtualMachineScaleSetExtension

Objetivo

Descreve uma extensão de conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
id	string	ID do recurso
name	string	Nome do recurso
properties.autoUpgradeMinorVersion	boolean	Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.
properties.enableAutomaticUpgrade	boolean	Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.
properties.forceUpdateTag	string	Se um valor for fornecido e for diferente do valor anterior, o manipulador de extensão será forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.
properties.protectedSettings		A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves
properties.provisionAfterExtensions	string[]	Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada.
properties.provisioningState	string	O estado de provisionamento, que só aparece na resposta.
properties.publisher	string	O nome do editor do manipulador de extensão.
properties.settings		Json formatou configurações públicas para a extensão.
properties.suppressFailures	boolean	Indica se as falhas decorrentes da extensão serão suprimidas (Falhas operacionais, como não se conectar à VM, não serão suprimidas, independentemente desse valor). O padrão é "false".
properties.type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
properties.typeHandlerVersion	string	Especifica a versão do manipulador de script.
type	string	Tipo de recurso

VirtualMachineScaleSetExtensionProfile

Objetivo

Descreve um perfil de extensão de conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
extensions	VirtualMachineScaleSetExtension[]	A escala da máquina virtual define recursos de extensão filho.
extensionsTimeBudget	string	Especifica o tempo alocado para o início de todas as extensões. A duração do tempo deve ser entre 15 minutos e 120 minutos (inclusive) e deve ser especificada no formato ISO 8601. O valor padrão é 90 minutos (PT1H30M). Versão api mínima: 2020-06-01.

VirtualMachineScaleSetHardwareProfile

Objetivo

Especifica as configurações de hardware para o conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
vmSizeProperties	VMSizeProperties	Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima api: 2021-11-01. Siga as instruções em de personalização de VM para obter mais detalhes.

VirtualMachineScaleSetIdentity

Objetivo

Identidade para o conjunto de escala da máquina virtual.

Nome	Tipo	Descrição
principalId	string	A id principal da identidade do conjunto de escala da máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	A id do locatário associada ao conjunto de dimensionamento da máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ResourceIdentityType	O tipo de identidade usado para o conjunto de dimensionamento de máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do conjunto de escala da máquina virtual.
userAssignedIdentities	<string, UserAssignedIdentitiesValue>	A lista de identidades de usuário associadas ao conjunto de dimensionamento de máquina virtual. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualMachineScaleSetIPConfiguration

Objetivo

Descreve a configuração IP do perfil de rede de um conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
name	string	O nome da configuração IP.
properties.applicationGatewayBackendAddressPools	SubResource[]	Especifica uma matriz de referências a pools de endereços de back-end de gateways de aplicativos. Um conjunto de dimensionamento pode fazer referência a pools de endereços de back-end de vários gateways de aplicativos. Vários conjuntos de escala não podem usar o mesmo gateway de aplicativo.
properties.applicationSecurityGroups	SubResource[]	Especifica uma matriz de referências ao grupo de segurança do aplicativo.
properties.loadBalancerBackendAddressPools	SubResource[]	Especifica uma matriz de referências a pools de endereços de back-end de balanceadores de carga. Um conjunto de dimensionamento pode fazer referência a pools de endereços de back-end de um balanceador de carga público e interno. Vários conjuntos de escala não podem usar o mesmo balanceador de carga de sku básico.
properties.loadBalancerInboundNatPools	SubResource[]	Especifica uma matriz de referências a pools Nat de entrada dos balanceadores de carga. Um conjunto de escalas pode fazer referência a pools de nat de entrada de um balanceador de carga público e interno. Vários conjuntos de escala não podem usar o mesmo balanceador de carga de sku básico.
properties.primary	boolean	Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.
properties.privateIPAddressVersion	IPVersion	Disponível a partir de 30-03-Api-Version 2017, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.
properties.publicIPAddressConfiguration	VirtualMachineScaleSetPublicIPAddressConfiguration	O publicIPAddressConfiguration.
properties.subnet	ApiEntityReference	Especifica o identificador da sub-rede.

VirtualMachineScaleSetIpTag

Objetivo

Contém a marca IP associada ao endereço IP público.

Nome	Tipo	Descrição
ipTagType	string	Tipo de tag IP. Exemplo: FirstPartyUsage.
tag	string	IP associada ao IP público. Exemplo: SQL, Storage etc.

VirtualMachineScaleSetManagedDiskParameters

Objetivo

Descreve os parâmetros de um disco gerenciado ScaleSet.

Nome	Tipo	Descrição
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a id do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.
securityProfile	VMDiskSecurityProfile	Especifica o perfil de segurança para o disco gerenciado.
storageAccountType	StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerenciado. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

VirtualMachineScaleSetNetworkConfiguration

Objetivo

Descreve as configurações de rede de um perfil de rede do conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
name	string	O nome da configuração de rede.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.
properties.deleteOption	DeleteOptions	Especificar o que acontece com a interface de rede quando a VM é excluída
properties.disableTcpStateTracking	boolean	Especifica se a interface de rede está desabilitada para rastreamento de estado tcp.
properties.dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	As configurações de dns a serem aplicadas nas interfaces de rede.
properties.enableAcceleratedNetworking	boolean	Especifica se a interface de rede é habilitada para rede acelerada.
properties.enableFpga	boolean	Especifica se a interface de rede é habilitada para rede FPGA.
properties.enableIPForwarding	boolean	Se o encaminhamento IP está habilitado nesta NIC.
properties.ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	Especifica as configurações IP da interface de rede.
properties.networkSecurityGroup	SubResource	O grupo de segurança de rede.
properties.primary	boolean	Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.
tags	object	Tags de recurso aplicadas ao endereço networkInterface criado por este NetworkInterfaceConfiguration

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Objetivo

Descreve uma escala de máquinas virtuais que define as configurações de DNS da rede.

Nome	Tipo	Descrição
dnsServers	string[]	Lista de endereços IP de servidores DNS

VirtualMachineScaleSetNetworkProfile

Objetivo

Descreve um perfil de rede de conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
healthProbe	ApiEntityReference	Uma referência a uma sonda de balanceador de carga usada para determinar a integridade de uma instância no conjunto de escala de máquina virtual. A referência será no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
networkApiVersion	NetworkApiVersion	especifica a versão da API Microsoft.Network usada ao criar recursos de rede nas Configurações de Interface de Rede para Conjunto de Dimensionamento de Máquina Virtual com modo de orquestração 'Flexível'
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	A lista de configurações de rede.

VirtualMachineScaleSetOSDisk

Objetivo

Descreve um disco do sistema operacional do conjunto de dimensionamento de máquina virtual.

Nome	Tipo	Descrição
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.
createOption	DiskCreateOptionTypes	Especifica como as máquinas virtuais no conjunto de escala devem ser criadas. O único valor permitido é: FromImage. Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também usará o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também usará o elemento de plano descrito anteriormente.
deleteOption	DiskDeleteOptionTypes	Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão do VMSS Flex (esse recurso está disponível apenas para VMSS com Flexible OrchestrationMode). Valores possíveis: Excluir Se esse valor for usado, o disco do sistema operacional será excluído quando o VMSS Flex VM for excluído. Desanexar Se esse valor for usado, o disco do sistema operacional será retido depois que o VMSS Flex VM for excluído. O valor padrão é definido como Excluir. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para Ephemeral OS Disk.
diffDiskSettings	DiffDiskSettings	Especifica as configurações de disco efêmero para o disco do sistema operacional usado pelo conjunto de escala da máquina virtual.
diskSizeGB	integer (int32)	Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.
image	VirtualHardDisk	Especifica informações sobre a imagem do usuário não gerenciado para basear a escala definida.
managedDisk	VirtualMachineScaleSetManagedDiskParameters	Os parâmetros do disco gerenciado.
name	string	O nome do disco.
osType	OperatingSystemTypes	Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir da imagem do usuário ou de um VHD especializado. Os valores possíveis são: Windows,Linux.
vhdContainers	string[]	Especifica as urls de contêiner que são usadas para armazenar discos do sistema operacional para o conjunto de escala.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

VirtualMachineScaleSetOSProfile

Objetivo

Descreve um perfil de sistema operacional de conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
adminPassword	string (password)	Especifica a senha da conta de administrador. Comprimento mínimo (Windows): 8 caracteres Comprimento mínimo (Linux): 6 caracteres Max-length (Windows): 123 caracteres Max-length (Linux): 72 caracteres Requisitos de complexidade: 3 das 4 condições abaixo precisam ser cumpridas Tem caracteres mais baixos Tem caracteres superiores Tem um dígito Tem um caractere especial (Regex match [\W_]) Valores não permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" Para redefinir a senha, consulte Como redefinir o serviço de Área de Trabalho Remota ou sua senha de login em uma VM do Windows Para redefinir a senha de root, consulte Gerenciar usuários, SSH e verificar ou reparar discos em VMs Linux do Azure usando a Extensão VMAccess
adminUsername	string	Especifica o nome da conta de administrador. Restrição somente para Windows: Não pode terminar em "." Valores não permitidos: "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". Comprimento mínimo (Linux): 1 caractere Max-length (Linux): 64 caracteres Max-length (Windows): 20 caracteres
allowExtensionOperations	boolean	Especifica se as operações de extensão devem ser permitidas no conjunto de escala da máquina virtual. Isso só pode ser definido como Falso quando nenhuma extensão estiver presente no conjunto de escala da máquina virtual.
computerNamePrefix	string	Especifica o prefixo do nome do computador para todas as máquinas virtuais no conjunto de escala. Os prefixos de nome de computador devem ter de 1 a 15 caracteres.
customData	string	Especifica uma cadeia de caracteres codificada em base 64 de dados personalizados. A cadeia de caracteres codificada em base 64 é decodificada para uma matriz binária que é salva como um arquivo na máquina virtual. O comprimento máximo da matriz binária é de 65535 bytes. Para usar o cloud-init para sua VM, consulte Usando cloud-init para personalizar uma VM Linux durante a criação
linuxConfiguration	LinuxConfiguration	Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal	boolean	Propriedade opcional que deve ser definida como True ou omitida.
secrets	VaultSecretGroup[]	Especifica o conjunto de certificados que devem ser instalados nas máquinas virtuais no conjunto de escala. Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.
windowsConfiguration	WindowsConfiguration	Especifica as configurações do sistema operacional Windows na máquina virtual.

VirtualMachineScaleSetPublicIPAddressConfiguration

Objetivo

Descreve um conjunto de dimensionamento de máquinas virtuais Configuração IP da configuração PublicIPAddress

Nome	Tipo	Descrição
name	string	O nome de configuração do endereço IP público.
properties.deleteOption	DeleteOptions	Especificar o que acontece com o IP público quando a VM é excluída
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	As configurações de dns a serem aplicadas nos endereços IP públicos.
properties.idleTimeoutInMinutes	integer (int32)	O tempo limite ocioso do endereço IP público.
properties.ipTags	VirtualMachineScaleSetIpTag[]	A lista de tags IP associadas ao endereço IP público.
properties.publicIPAddressVersion	IPVersion	Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.
properties.publicIPPrefix	SubResource	O PublicIPPrefix a partir do qual alocar endereços IP públicos.
sku	PublicIPAddressSku	Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.
tags	object	Tags de recurso aplicadas ao endereço IPP público criado por este PublicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Objetivo

Descreve uma escala de máquinas virtuais que define as configurações de DNS da rede.

Nome	Tipo	Descrição
domainNameLabel	string	O rótulo do nome de domínio. A concatenação do rótulo de nome de domínio e do índice vm serão os rótulos de nome de domínio dos recursos PublicIPAddress que serão criados
domainNameLabelScope	DomainNameLabelScopeTypes	O escopo do rótulo de nome de domínio. A concatenação do rótulo de nome de domínio com hash gerado de acordo com a política do escopo do rótulo de nome de domínio e do índice vm serão os rótulos de nome de domínio dos recursos de endereço PublicIPAddress que serão criados

VirtualMachineScaleSetScaleInRules

Enumeração

Valor	Descrição
Default
OldestVM
NewestVM

VirtualMachineScaleSetStorageProfile

Objetivo

Descreve um perfil de armazenamento de conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
dataDisks	VirtualMachineScaleSetDataDisk[]	Especifica os parâmetros que são usados para adicionar discos de dados às máquinas virtuais no conjunto de escala. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.
diskControllerType	DiskControllerTypes	Especifica o tipo de controlador de disco configurado para as máquinas virtuais no conjunto de escala. Versão mínima da api: 2022-08-01
imageReference	ImageReference	Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação.
osDisk	VirtualMachineScaleSetOSDisk	Especifica informações sobre o disco do sistema operacional usado pelas máquinas virtuais no conjunto de escala. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

VirtualMachineScaleSetVMProfile

Objetivo

Descreve um perfil de máquina virtual de conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
applicationProfile	ApplicationProfile	Especifica os aplicativos de galeria que devem ser disponibilizados para a VM/VMSS
billingProfile	BillingProfile	Especifica os detalhes relacionados à cobrança de um VMSS spot do Azure. Versão api mínima: 2019-03-01.
capacityReservation	CapacityReservationProfile	Especifica os detalhes relacionados à reserva de capacidade de um conjunto de escalas. Versão mínima api: 2021-04-01.
diagnosticsProfile	DiagnosticsProfile	Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.
evictionPolicy	VirtualMachineEvictionPolicyTypes	Especifica a política de remoção para a máquina virtual do Azure Spot e o conjunto de escala do Azure Spot. Para máquinas virtuais do Azure Spot, há suporte para 'Deslocalizar' e 'Excluir' e a versão mínima da api é 2019-03-01. Para conjuntos de escala do Azure Spot, há suporte para 'Deslocalizar' e 'Excluir' e a versão mínima da api é 2017-10-30-preview.
extensionProfile	VirtualMachineScaleSetExtensionProfile	Especifica uma coleção de configurações para extensões instaladas em máquinas virtuais no conjunto de escala.
hardwareProfile	VirtualMachineScaleSetHardwareProfile	Especifica os detalhes relacionados ao perfil de hardware de um conjunto de escala. Versão mínima api: 2021-11-01.
licenseType	string	Especifica que a imagem ou o disco que está sendo usado foi licenciado localmente. Os valores possíveis para o sistema operacional Windows Server são: Windows_Client Windows_Server Os valores possíveis para o sistema operacional Linux Server são: RHEL_BYOS (para RHEL) SLES_BYOS (para SUSE) Para obter mais informações, consulte Benefício de Uso Híbrido do Azure para Windows Server Benefício de Uso Híbrido do Azure para Linux Server Versão mínima da api: 2015-06-15
networkProfile	VirtualMachineScaleSetNetworkProfile	Especifica as propriedades das interfaces de rede das máquinas virtuais no conjunto de escala.
osProfile	VirtualMachineScaleSetOSProfile	Especifica as configurações do sistema operacional para as máquinas virtuais no conjunto de escala.
priority	VirtualMachinePriorityTypes	Especifica a prioridade para as máquinas virtuais no conjunto de escala. Versão mínima da api: 2017-10-30-preview.
scheduledEventsProfile	ScheduledEventsProfile	Especifica as configurações relacionadas a Eventos Agendados.
securityPostureReference	SecurityPostureReference	Especifica a postura de segurança a ser usada no conjunto de escalas. Versão mínima da api: 2023-03-01
securityProfile	SecurityProfile	Especifica as configurações de perfil relacionadas à segurança para as máquinas virtuais no conjunto de escala.
serviceArtifactReference	ServiceArtifactReference	Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'. Versão mínima api: 2022-11-01
storageProfile	VirtualMachineScaleSetStorageProfile	Especifica as configurações de armazenamento para os discos da máquina virtual.
timeCreated	string (date-time)	Especifica a hora em que esse perfil de VM para o Conjunto de Dimensionamento de Máquina Virtual foi criado. Esse valor será adicionado às tags VM Flex do VMSS ao criar/atualizar o Perfil da VM do VMSS. A versão mínima da API para esta propriedade é 2023-09-01.
userData	string	UserData para as máquinas virtuais no conjunto de escala, que deve ser codificado em base-64. O cliente não deve passar nenhum segredo aqui. Versão mínima da api: 2021-03-01.

VMDiskSecurityProfile

Objetivo

Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais.

Nome	Tipo	Descrição
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado usado para a Chave Gerenciada do Cliente criptografada, o Disco do SO ConfidentialVM e o blob VMGuest.
securityEncryptionType	SecurityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais.

VMGalleryApplication

Objetivo

Especifica as informações necessárias para fazer referência a uma versão do aplicativo da galeria de computação

Nome	Tipo	Descrição
configurationReference	string	Opcional, Especifica o uri para um blob azure que substituirá a configuração padrão para o pacote, se fornecido
enableAutomaticUpgrade	boolean	Se definido como true, quando uma nova versão do Aplicativo Gallery estiver disponível no PIR/SIG, ela será atualizada automaticamente para a VM/VMSS
order	integer (int32)	Opcional, Especifica a ordem em que os pacotes devem ser instalados
packageReferenceId	string	Especifica a id do recurso GalleryApplicationVersion no formato /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}
tags	string	Opcional, Especifica um valor de passagem para contexto mais genérico.
treatFailureAsDeploymentFailure	boolean	Opcional, se verdadeiro, qualquer falha para qualquer operação no VmApplication falhará na implantação

VMSizeProperties

Objetivo

Especifica as configurações da Propriedade de Tamanho da VM na máquina virtual.

Nome	Tipo	Descrição
vCPUsAvailable	integer (int32)	Especifica o número de vCPUs disponíveis para a VM. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la com o valor de vCPUs disponíveis para esse tamanho de VM exposto na resposta da api de Listar todos os tamanhos de máquina virtual disponíveis em uma região.
vCPUsPerCore	integer (int32)	Especifica a relação vCPU para núcleo físico. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é definido como o valor de vCPUsPerCore para o Tamanho da VM exposto na resposta da api de Listar todos os tamanhos de máquina virtual disponíveis em uma região. Definir essa propriedade como 1 também significa que o hyper-threading está desabilitado.

WindowsConfiguration

Objetivo

Especifica as configurações do sistema operacional Windows na máquina virtual.

Nome	Tipo	Descrição
additionalUnattendContent	AdditionalUnattendContent[]	Especifica informações adicionais formatadas em XML codificadas em base 64 que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows.
enableAutomaticUpdates	boolean	Indica se as Atualizações Automáticas estão habilitadas para a máquina virtual do Windows. O valor predefinido é verdadeiro. Para conjuntos de dimensionamento de máquina virtual, essa propriedade pode ser atualizada e as atualizações entrarão em vigor no reprovisionamento do sistema operacional.
enableVMAgentPlatformUpdates	boolean	Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a Máquina Virtual do Windows.
patchSettings	PatchSettings	[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao patch de convidado de VM no Windows.
provisionVMAgent	boolean	Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, ela é definida como true por padrão. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.
timeZone	string	Especifica o fuso horário da máquina virtual. por exemplo, "Hora Padrão do Pacífico". Os valores possíveis podem ser TimeZoneInfo.Id valor de fusos horários retornados por TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Especifica os ouvintes do Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

WindowsPatchAssessmentMode

Enumeração

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

Valor	Descrição
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Enumeração

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

Valor	Descrição
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Objetivo

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Windows.

Nome	Tipo	Descrição
bypassPlatformSafetyChecksOnUserSchedule	boolean	Permite que o cliente agende patches sem atualizações acidentais
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

WindowsVMGuestPatchMode

Enumeração

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

Valor	Descrição
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Objetivo

Descreve a configuração do Gerenciamento Remoto do Windows da VM

Nome	Tipo	Descrição
listeners	WinRMListener[]	A lista de ouvintes do Gerenciamento Remoto do Windows

WinRMListener

Objetivo

Descreve o protocolo e a impressão digital do ouvinte do Gerenciamento Remoto do Windows

Nome	Tipo	Descrição
certificateUrl	string	Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo. Para adicionar um segredo ao Cofre de Chaves, consulte Adicionar uma chave ou segredo ao Cofre de Chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON que é codificado em UTF-8: { "data":"<certificado codificado em Base64>", "dataType":"pfx", "senha":"<pfx-file-password>" } Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.
protocol	ProtocolTypes	Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.

ZonalPlatformFaultDomainAlignMode

Enumeração

Especifica o modo de alinhamento entre a computação do Conjunto de Escala da Máquina Virtual e a contagem de Domínio de Falha de armazenamento.

Valor	Descrição
Aligned
Unaligned

ZoneAllocationPolicy

Objetivo

Os parâmetros de configuração para alocação de zona de um conjunto de escala de máquina virtual.

Nome	Tipo	Descrição
maxInstancePercentPerZonePolicy	MaxInstancePercentPerZonePolicy	Os parâmetros de configuração usados para limitar o número de máquinas virtuais por zona de disponibilidade no conjunto de escala de máquina virtual.
maxZoneCount	integer (int32)	O número máximo de zonas de disponibilidade a serem usadas se ZonePlacementPolicy for 'Auto'. Se não for especificado, todas as zonas de disponibilidade serão usadas.

ZonePlacementPolicyType

Enumeração

Especifica a política de posicionamento do recurso na zona de disponibilidade. Os valores possíveis são: Qualquer (usado para Máquinas Virtuais), Automático (usado para Conjuntos de Dimensionamento de Máquinas Virtuais) - Uma zona de disponibilidade será escolhida automaticamente pelo sistema como parte da criação de recursos.

Valor	Descrição
Any
Auto	Posicionamento automático da zona em um Conjunto de Dimensionamento de Máquina Virtual.

Partilhar via

Virtual Machine Scale Sets - Get

Parâmetros URI

Respostas

Segurança

azure_auth

Alcances

Exemplos

Get a virtual machine scale set

Pedido de exemplo

Resposta de exemplo

Get a virtual machine scale set placed on a dedicated host group through automatic placement.

Pedido de exemplo

Resposta de exemplo

Get a virtual machine scale set with UserData

Pedido de exemplo

Resposta de exemplo

Get VM scale set VM with Disk Controller Type

Pedido de exemplo

Resposta de exemplo

Definições

AdditionalCapabilities

AdditionalUnattendContent

AllInstancesDown

AllocationStrategy

ApiEntityReference

ApiError

ApiErrorBase

ApplicationProfile

AutomaticOSUpgradePolicy

AutomaticRepairsPolicy

AutomaticZoneRebalancingPolicy

BillingProfile

BootDiagnostics

CachingTypes

CapacityReservationProfile

CloudError

ComponentNames

createdByType

DeleteOptions

DiagnosticsProfile

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskEncryptionSetParameters

DomainNameLabelScopeTypes

EncryptionIdentity

EventGridAndResourceGraph

ExpandTypesForGetVMScaleSets

ExtendedLocation

ExtendedLocationTypes

HighSpeedInterconnectPlacement

HostEndpointSettings

ImageReference

InnerError

IPVersion

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

MaxInstancePercentPerZonePolicy

Mode

Modes

NetworkApiVersion

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku

OperatingSystemTypes

OrchestrationMode

OSImageNotificationProfile

PassNames

PatchSettings

Placement

Plan

PriorityMixPolicy