你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Machine Scale Sets - Get

服务:: Compute

API 版本:: 2025-04-01

显示有关虚拟机规模集的信息。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
vmScaleSetName	path	True	string	VM 规模集的名称。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
$expand	query		ExpandTypesForGetVMScaleSets	要应用于作的展开表达式。 “UserData”检索用户在 VM 规模集创建/更新作期间提供的 VM 规模集的 UserData 属性

响应

名称	类型	说明
200 OK	VirtualMachineScaleSet	Azure作已成功完成。
Other Status Codes	CloudError	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

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

示例请求

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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/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://free.blessedness.top/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

示例响应

状态代码:: 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.

示例请求

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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/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://free.blessedness.top/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

示例响应

状态代码:: 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

示例请求

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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/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://free.blessedness.top/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

示例响应

状态代码:: 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

示例请求

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/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/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://free.blessedness.top/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

示例响应

状态代码:: 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"
    }
  }
}

定义

名称	说明
AdditionalCapabilities	启用或禁用虚拟机或虚拟机规模集上的功能。
AdditionalUnattendContent	指定 Windows 安装程序使用的 Unattend.xml 文件中可以包含的其他 XML 格式化信息。内容通过设置名称、组件名称和应用内容的传递来定义。
AllInstancesDown	指定在所有实例关闭时是否应自动批准计划事件。
AllocationStrategy	指定将基于其分配 VM 的虚拟机规模集的分配策略。
ApiEntityReference	API 实体引用。
ApiError	API 错误。
ApiErrorBase	Api 错误库。
ApplicationProfile	包含应提供给 VM/VMSS 的库应用程序列表
AutomaticOSUpgradePolicy	用于执行自动 OS 升级的配置参数。
AutomaticRepairsPolicy	指定虚拟机规模集上自动修复的配置参数。
AutomaticZoneRebalancingPolicy	执行自动 AZ 均衡时使用的配置参数。
BillingProfile	指定 Azure 现成 VM 或 VMSS 的计费相关详细信息。最低 API 版本：2019-03-01。
BootDiagnostics	启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。可以轻松查看控制台日志的输出。通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。
CachingTypes	指定缓存要求。可能的值为： None、ReadOnly、ReadWrite。默认值为：标准存储的无。高级存储的只读
CapacityReservationProfile	容量预留配置文件的参数。
CloudError	来自计算服务的错误响应。
ComponentNames
createdByType	创建资源的标识的类型。
DeleteOptions	指定删除 VM 时网络接口发生的情况
DiagnosticsProfile	指定启动诊断设置状态。最低 API 版本：2015-06-15。
DiffDiskOptions	指定作系统磁盘的临时磁盘选项。
DiffDiskPlacement	指定操作系统磁盘的临时磁盘放置。用户可以在请求中使用此属性来选择位置，即缓存磁盘、资源磁盘或 nvme 磁盘空间，以进行临时 OS 磁盘配置。有关临时 OS 磁盘大小要求的详细信息，请参阅上的 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本：2024-03-01。
DiffDiskSettings	描述可为操作系统磁盘指定的临时磁盘设置的参数。注意：临时磁盘设置只能为托管磁盘指定。
DiskControllerTypes	指定为 VM 和 VirtualMachineScaleSet 配置的磁盘控制器类型。只有操作系统磁盘和 VM SKU 支持第 2 代（https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2）的虚拟机才支持此属性，请在响应区域的 Microsoft.Compute SKU API 包含 V2（https://docs.microsoft.com/rest/api/compute/resourceskus/list）时检查作为 VM SKU 功能的一部分返回的 HyperVGenerations 功能。有关支持的磁盘控制器类型的详细信息，请参阅 https://aka.ms/azure-diskcontrollertypes。
DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。空：创建空数据磁盘时使用此值。复制：此值用于从快照或其他磁盘创建数据磁盘。还原：此值用于从磁盘还原点创建数据磁盘。
DiskDeleteOptionTypes	指定删除 VM 时托管磁盘的行为，例如，是删除托管磁盘还是分离托管磁盘。支持的值为：删除。如果使用此值，则在删除 VM 时删除托管磁盘。分离。如果使用此值，则在删除 VM 后将保留托管磁盘。最低 API 版本：2021-03-01。
DiskEncryptionSetParameters	描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。注意：只能为托管磁盘指定磁盘加密集资源 ID。有关详细信息，请参阅 https://aka.ms/mdssewithcmkoverview。
DomainNameLabelScopeTypes	域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签
EncryptionIdentity	指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。
EventGridAndResourceGraph	指定与 eventGridAndResourceGraph 相关的计划事件相关配置。
ExpandTypesForGetVMScaleSets
ExtendedLocation	扩展位置的复杂类型。
ExtendedLocationTypes	扩展位置的类型。
HighSpeedInterconnectPlacement	指定虚拟机规模集的高速互连放置。
HostEndpointSettings	指定特定的主机终结点设置。
ImageReference	指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。注意：只能在创建规模集时设置映像引用发布者和产品/服务。
InnerError	内部错误详细信息。
IPVersion	从 Api-Version 2017-03-30 开始提供，它表示特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。可能的值为：“IPv4”和“IPv6”。
KeyVaultSecretReference	描述对 Key Vault 机密的引用
LinuxConfiguration	指定虚拟机上的 Linux 操作系统设置。有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux。
LinuxPatchAssessmentMode	指定 IaaS 虚拟机的 VM 来宾修补评估模式。可能的值为： ImageDefault - 控制虚拟机上的修补程序评估的时间。 AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。
LinuxPatchSettings	指定与 Linux 上的 VM 来宾修补相关的设置。
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
LinuxVMGuestPatchAutomaticByPlatformSettings	指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。
LinuxVMGuestPatchMode	指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。可能的值为： ImageDefault - 使用虚拟机的默认修补配置。 AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 必须为 true
MaxInstancePercentPerZonePolicy	用于限制虚拟机规模集中每个可用性区域的虚拟机数的配置参数。
Mode	指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视，但不强制对审核模式下主机终结点的请求实施访问控制，而在“强制”模式下，将强制实施访问控制。默认值为“强制”模式。
Modes	指定执行模式。在审核模式下，系统就像强制实施访问控制策略一样，包括在日志中发出访问拒绝条目，但它实际上不会拒绝对主机终结点的任何请求。在“强制”模式下，系统将强制实施访问控制，这是建议的作模式。
NetworkApiVersion	指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本
NetworkInterfaceAuxiliaryMode	指定是否为网络接口资源启用辅助模式。
NetworkInterfaceAuxiliarySku	指定是否为网络接口资源启用辅助 SKU。
OperatingSystemTypes	此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。可能的值包括：Windows、Linux。
OrchestrationMode	指定虚拟机规模集的业务流程模式。
OSImageNotificationProfile
PassNames
PatchSettings	指定与 Windows 上的 VM 来宾修补相关的设置。
Placement	描述资源硬件放置的用户定义约束。
Plan	指定有关用于创建虚拟机的市场映像的信息。此元素仅用于市场映像。必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。在 Azure 门户中，找到要使用的市场映像，然后单击想要以编程方式部署，开始使用 ->。输入任何必需的信息，然后单击“保存。
PriorityMixPolicy	指定具有灵活业务流程模式的规模集中现成和常规优先级 VM 的目标拆分。使用此属性，客户可以指定在 VMSS 弹性实例横向扩展时创建的常规优先级虚拟机的基本数量，以及在达到此基本目标后在现成优先级虚拟机和常规优先级虚拟机之间进行拆分。
ProtocolTypes	指定 WinRM 侦听器的协议。可能的值为：http、https。
ProxyAgentSettings	指定虚拟机或虚拟机规模集的 ProxyAgent 设置。最低 API 版本：2023-09-01。
PublicIPAddressSku	描述公共 IP Sku。只能将 OrchestrationMode 设置为灵活。
PublicIPAddressSkuName	指定公共 IP SKU 名称
PublicIPAddressSkuTier	指定公共 IP SKU 层
RebalanceBehavior	将用于跨可用性区域在规模集中重新创建虚拟机的重新平衡行为的类型。默认且目前仅支持的值为 CreateBeforeDelete。
RebalanceStrategy	用于跨可用性区域在规模集中重新均衡虚拟机的重新平衡策略的类型。默认且目前仅支持的值是“重新创建”。
RepairAction	用于修复规模集中运行不正常的虚拟机的修复作类型（替换、重启、重置映像）。默认值将被替换。
ResiliencyPolicy	描述弹性策略 - AutomaticZoneRebalancingPolicy、ResilientVMCreationPolicy 和/或 ResilientVMDeletionPolicy。
ResilientVMCreationPolicy	执行可复原 VM 创建时使用的配置参数。
ResilientVMDeletionPolicy	执行弹性 VM 删除时使用的配置参数。
ResourceIdentityType	用于虚拟机规模集的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机规模集中删除任何标识。
RollingUpgradePolicy	执行滚动升级时使用的配置参数。
ScaleInPolicy	描述虚拟机规模集的横向缩减策略。
ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy	指定 Redeploy、Reboot 和 ScheduledEventsAdditionalPublishingTargets Scheduled Event 相关配置。
ScheduledEventsProfile
SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。注意：只能为机密 VM 设置它。
SecurityPostureReference	指定要在规模集中使用的安全状况。最低 API 版本：2023-03-01
SecurityProfile	指定虚拟机或虚拟机规模集的安全配置文件设置。
SecurityTypes	指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。默认行为为：除非设置了此属性，否则不会启用 UefiSettings。
ServiceArtifactReference	指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。最低 API 版本：2022-11-01
SettingNames	指定内容应用到的设置的名称。可能的值包括：FirstLogonCommands 和 AutoLogon。
Sku	描述虚拟机规模集 SKU。注意：如果规模集当前在硬件上不支持新的 VM SKU，则需要在修改 SKU 名称之前解除分配规模集中的 VM。
SkuProfile	指定虚拟机规模集的 SKU 配置文件。使用此属性，客户可以指定 VM 大小列表和分配策略。
SkuProfileVMSize	指定虚拟机大小。
SpotRestorePolicy	指定虚拟机规模集的现成Try-Restore 属性。使用此属性，客户可以根据容量可用性和定价限制，机会性地启用或禁用已逐出的现成 VMSS VM 实例的自动还原。
SshConfiguration	Azure 上运行的基于 Linux 的 VM 的 SSH 配置
SshPublicKey	包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。
StorageAccountTypes	指定托管磁盘的存储帐户类型。只能在创建规模集时设置托管 OS 磁盘存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用。它不能与 OS 磁盘一起使用。 Standard_LRS使用标准 HDD。 StandardSSD_LRS使用标准 SSD。 Premium_LRS使用高级 SSD。 UltraSSD_LRS使用超级磁盘。 Premium_ZRS使用高级 SSD 区域冗余存储。 StandardSSD_ZRS使用标准 SSD 区域冗余存储。有关 Windows 虚拟机支持的磁盘的详细信息，请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/disks-types，对于 Linux 虚拟机，请参阅 https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
SubResource
systemData	与创建和上次修改资源相关的元数据。
TerminateNotificationProfile
UefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。最低 api 版本：2020-12-01。
UpgradeMode	指定升级到规模集中虚拟机的模式。可能的值为：手动 - 控制对规模集中虚拟机的更新的应用程序。使用 manualUpgrade作执行此作。自动 - 规模集中的所有虚拟机同时自动更新。
UpgradePolicy	描述升级策略 - 自动、手动或滚动。
UserAssignedIdentitiesValue
UserInitiatedReboot	指定与重新启动相关的计划事件相关配置。
UserInitiatedRedeploy	指定与“重新部署”相关的“计划事件”相关配置。
VaultCertificate	介绍 Key Vault 中的单个证书引用，以及证书应驻留在 VM 上的位置。
VaultSecretGroup	描述一组证书，这些证书都位于同一 Key Vault 中。
VirtualHardDisk	描述磁盘的 URI。
VirtualMachineEvictionPolicyTypes	指定 Azure 现成 VM/VMSS 的逐出策略
VirtualMachinePriorityTypes	指定独立虚拟机或规模集中虚拟机的优先级。 “低”枚举将来将弃用，请使用“现成”作为枚举来部署 Azure 现成 VM/VMSS。
VirtualMachineScaleSet	描述虚拟机规模集。
VirtualMachineScaleSetDataDisk	描述虚拟机规模集数据磁盘。
VirtualMachineScaleSetExtension	描述虚拟机规模集扩展。
VirtualMachineScaleSetExtensionProfile	描述虚拟机规模集扩展配置文件。
VirtualMachineScaleSetHardwareProfile	指定虚拟机规模集的硬件设置。
VirtualMachineScaleSetIdentity	虚拟机规模集的标识。
VirtualMachineScaleSetIPConfiguration	介绍虚拟机规模集网络配置文件的 IP 配置。
VirtualMachineScaleSetIpTag	包含与公共 IP 地址关联的 IP 标记。
VirtualMachineScaleSetManagedDiskParameters	描述 ScaleSet 托管磁盘的参数。
VirtualMachineScaleSetNetworkConfiguration	介绍虚拟机规模集网络配置文件的网络配置。
VirtualMachineScaleSetNetworkConfigurationDnsSettings	描述虚拟机规模集网络配置的 DNS 设置。
VirtualMachineScaleSetNetworkProfile	描述虚拟机规模集网络配置文件。
VirtualMachineScaleSetOSDisk	描述虚拟机规模集操作系统磁盘。
VirtualMachineScaleSetOSProfile	描述虚拟机规模集 OS 配置文件。
VirtualMachineScaleSetPublicIPAddressConfiguration	介绍虚拟机规模集 IP 配置的公共 IPAddress 配置
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	描述虚拟机规模集网络配置的 DNS 设置。
VirtualMachineScaleSetScaleInRules
VirtualMachineScaleSetStorageProfile	描述虚拟机规模集存储配置文件。
VirtualMachineScaleSetVMProfile	介绍虚拟机规模集虚拟机配置文件。
VMDiskSecurityProfile	指定托管磁盘的安全配置文件设置。注意：只能为机密 VM 设置它。
VMGalleryApplication	指定引用计算库应用程序版本所需的信息
VMSizeProperties	指定虚拟机上的 VM 大小属性设置。
WindowsConfiguration	指定虚拟机上的 Windows 操作系统设置。
WindowsPatchAssessmentMode	指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。可能的值为： ImageDefault - 控制虚拟机上的修补程序评估的时间。 AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
WindowsVMGuestPatchAutomaticByPlatformSettings	指定在 Windows 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。
WindowsVMGuestPatchMode	指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。可能的值为：手动 - 可以控制将修补程序应用到虚拟机。为此，请在 VM 中手动应用修补程序。在此模式下，自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false AutomaticByOS - 虚拟机将由 OS 自动更新。属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。 AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true
WinRMConfiguration	介绍 VM 的 Windows 远程管理配置
WinRMListener	介绍 Windows 远程管理侦听器的协议和指纹
ZonalPlatformFaultDomainAlignMode	指定虚拟机规模集计算与存储容错域计数之间的对齐模式。
ZoneAllocationPolicy	虚拟机规模集的区域分配的配置参数。
ZonePlacementPolicyType	指定资源在可用性区域中放置的策略。可能的值为：任意（用于虚拟机）、自动（用于虚拟机规模集）- 作为资源创建的一部分，系统将自动选取可用性区域。

AdditionalCapabilities

Object

启用或禁用虚拟机或虚拟机规模集上的功能。

名称	类型	说明
enableFips1403Encryption	boolean	该标志允许在扩展的 protectedSettings 上使用符合 FIPS 140-3 的加密技术。有关详细信息，请访问：https://aka.ms/linuxagentfipssupport。
hibernationEnabled	boolean	在 VM 上启用或禁用休眠功能的标志。
ultraSSDEnabled	boolean	启用或禁用在 VM 或 VMSS 上具有一个或多个具有UltraSSD_LRS存储帐户类型的托管数据磁盘的功能的标志。仅当此属性已启用时，才能将存储帐户类型UltraSSD_LRS的托管磁盘添加到虚拟机或虚拟机规模集。

AdditionalUnattendContent

Object

指定 Windows 安装程序使用的 Unattend.xml 文件中可以包含的其他 XML 格式化信息。内容通过设置名称、组件名称和应用内容的传递来定义。

名称	类型	说明
componentName	ComponentNames	组件名称。目前，唯一允许的值是Microsoft-Windows-Shell-Setup。
content	string	指定为指定路径和组件添加到unattend.xml文件的 XML 格式化内容。 XML 必须小于 4KB，并且必须包含要插入的设置或功能的根元素。
passName	PassNames	传递名称。目前，唯一允许的值是 OobeSystem。
settingName	SettingNames	指定内容应用到的设置的名称。可能的值包括：FirstLogonCommands 和 AutoLogon。

AllInstancesDown

Object

指定在所有实例关闭时是否应自动批准计划事件。

名称	类型	说明
automaticallyApprove	boolean	指定在所有实例关闭时是否应自动批准计划事件。其默认值为 true

AllocationStrategy

枚举

指定将基于其分配 VM 的虚拟机规模集的分配策略。

值	说明
LowestPrice
CapacityOptimized
Prioritized

ApiEntityReference

Object

API 实体引用。

名称	类型	说明
id	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 形式的 ARM 资源 ID

ApiError

Object

API 错误。

名称	类型	说明
code	string	错误代码。
details	ApiErrorBase[]	Api 错误详细信息
innererror	InnerError	Api 内部错误
message	string	错误消息。
target	string	特定错误的目标。

ApiErrorBase

Object

Api 错误库。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。
target	string	特定错误的目标。

ApplicationProfile

Object

包含应提供给 VM/VMSS 的库应用程序列表

名称	类型	说明
galleryApplications	VMGalleryApplication[]	指定应提供给 VM/VMSS 的库应用程序

AutomaticOSUpgradePolicy

Object

用于执行自动 OS 升级的配置参数。

名称	类型	说明
disableAutomaticRollback	boolean	是否应禁用 OS 映像回滚功能。默认值为 false。
enableAutomaticOSUpgrade	boolean	指示当较新版本的 OS 映像可用时，是否应以滚动方式自动将 OS 升级应用于规模集实例。默认值为 false。如果此选项设置为基于 Windows 的规模集，enableAutomaticUpdates 将自动设置为 false，并且不能设置为 true。
osRollingUpgradeDeferral	boolean	指示自动 OS 升级是否应延迟。延迟的 OS 升级将根据每个 VM 发送高级通知，即通过 IMDS 标记“Platform.PendingOSUpgrade”从滚动升级进行 OS 升级。然后，升级会延迟，直到通过 ApprovRollingUpgrade 调用批准升级。
useRollingUpgradePolicy	boolean	指示是否应在自动 OS 升级期间使用滚动升级策略。默认值为 false。如果未在 VMSS 上定义任何策略，则自动 OS 升级将回退到默认策略。

AutomaticRepairsPolicy

Object

指定虚拟机规模集上自动修复的配置参数。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机规模集上启用自动修复。默认值为 false。
gracePeriod	string	由于 VM 上的状态更改，自动修复暂停的时间。状态更改完成后的宽限时间开始。这有助于避免过早或意外修复。持续时间应采用 ISO 8601 格式指定。允许的最小宽限期为 10 分钟（PT10M），这也是默认值。允许的最大宽限期为 90 分钟（PT90M）。
repairAction	RepairAction	用于修复规模集中运行不正常的虚拟机的修复作类型（替换、重启、重置映像）。默认值将被替换。

AutomaticZoneRebalancingPolicy

Object

执行自动 AZ 均衡时使用的配置参数。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机规模集上启用自动 AZ 均衡。默认值为 false。
rebalanceBehavior	RebalanceBehavior	将用于跨可用性区域在规模集中重新创建虚拟机的重新平衡行为的类型。默认且目前仅支持的值为 CreateBeforeDelete。
rebalanceStrategy	RebalanceStrategy	用于跨可用性区域在规模集中重新均衡虚拟机的重新平衡策略的类型。默认且目前仅支持的值是“重新创建”。

BillingProfile

Object

指定 Azure 现成 VM 或 VMSS 的计费相关详细信息。最低 API 版本：2019-03-01。

名称	类型	说明
maxPrice	number (double)	指定愿意为 Azure 现成 VM/VMSS 付费的最高价格。这个价格是美元。此价格将与 VM 大小的当前 Azure 现成价格进行比较。此外，价格是在创建/更新 Azure 现成 VM/VMSS 时进行比较的，并且仅当 maxPrice 大于当前 Azure 现成价格时，该操作才会成功。如果当前 Azure 现成价格超出创建 VM/VMSS 后的最大价格，maxPrice 还将用于逐出 Azure 现成 VM/VMSS。可能的值为： - 大于零的任何十进制值。示例：0.01538 -1 – 指示按需 up-to 的默认价格。可以将 maxPrice 设置为 -1，以指示出于价格原因不应逐出 Azure Spot VM/VMSS。此外，如果默认的最大价格不是由你提供，则为 -1。最低 API 版本：2019-03-01。

BootDiagnostics

Object

启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。可以轻松查看控制台日志的输出。通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。

名称	类型	说明
enabled	boolean	是否应在虚拟机上启用启动诊断。
storageUri	string	用于放置控制台输出和屏幕截图的存储帐户的 URI。如果在启用启动诊断时未指定 storageUri，则会使用托管存储。

CachingTypes

枚举

指定缓存要求。可能的值为： None、ReadOnly、ReadWrite。 默认值为： 标准存储的无。高级存储的只读

值	说明
None
ReadOnly
ReadWrite

CapacityReservationProfile

Object

容量预留配置文件的参数。

名称	类型	说明
capacityReservationGroup	SubResource	指定容量预留组资源 ID，该 ID 应用于分配已保留足够容量的虚拟机或规模集 VM 实例。有关详细信息，请参阅 https://aka.ms/CapacityReservation。

CloudError

Object

来自计算服务的错误响应。

名称	类型	说明
error	ApiError	API 错误。

ComponentNames

枚举

值	说明
Microsoft-Windows-Shell-Setup

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DeleteOptions

枚举

指定删除 VM 时网络接口发生的情况

值	说明
Delete
Detach

DiagnosticsProfile

Object

指定启动诊断设置状态。最低 API 版本：2015-06-15。

名称	类型	说明
bootDiagnostics	BootDiagnostics	启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。注意：如果指定 storageUri，请确保存储帐户与 VM 位于同一区域和订阅中。可以轻松查看控制台日志的输出。通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。

DiffDiskOptions

枚举

指定作系统磁盘的临时磁盘选项。

值	说明
Local

DiffDiskPlacement

枚举

指定操作系统磁盘的临时磁盘放置。用户可以在请求中使用此属性来选择位置，即缓存磁盘、资源磁盘或 nvme 磁盘空间，以进行临时 OS 磁盘配置。有关临时 OS 磁盘大小要求的详细信息，请参阅上的 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本：2024-03-01。

值	说明
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Object

描述可为操作系统磁盘指定的临时磁盘设置的参数。 注意： 临时磁盘设置只能为托管磁盘指定。

名称	类型	说明
option	DiffDiskOptions	指定操作系统磁盘的临时磁盘设置。
placement	DiffDiskPlacement	指定操作系统磁盘的临时磁盘放置。可能的值为：CacheDisk、ResourceDisk、NvmeDisk。默认行为为：如果为 VM 大小配置了一个，则 CacheDisk;否则，ResourceDisk 或使用 NvmeDisk。请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/sizes https://docs.microsoft.com/azure/virtual-machines/linux/sizes 上的 Windows VM 和 Linux VM 的 VM 大小文档，以检查哪些 VM 大小公开了缓存磁盘。 NvmeDisk 的最低 API 版本：2024-03-01。

DiskControllerTypes

枚举

指定为 VM 和 VirtualMachineScaleSet 配置的磁盘控制器类型。只有操作系统磁盘和 VM SKU 支持第 2 代（https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2）的虚拟机才支持此属性，请在响应区域的 Microsoft.Compute SKU API 包含 V2（https://docs.microsoft.com/rest/api/compute/resourceskus/list）时检查作为 VM SKU 功能的一部分返回的 HyperVGenerations 功能。有关支持的磁盘控制器类型的详细信息，请参阅 https://aka.ms/azure-diskcontrollertypes。

值	说明
SCSI
NVMe

DiskCreateOptionTypes

枚举

指定应如何创建虚拟机磁盘。可能的值是 附加： 使用专用磁盘创建虚拟机时，将使用此值。 FromImage： 使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。空：创建空数据磁盘时使用此值。 复制： 此值用于从快照或其他磁盘创建数据磁盘。 还原： 此值用于从磁盘还原点创建数据磁盘。

值	说明
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

枚举

指定删除 VM 时托管磁盘的行为，例如，是删除托管磁盘还是分离托管磁盘。支持的值为： 删除。 如果使用此值，则在删除 VM 时删除托管磁盘。 分离。 如果使用此值，则在删除 VM 后将保留托管磁盘。最低 API 版本：2021-03-01。

值	说明
Delete
Detach

DiskEncryptionSetParameters

Object

描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意： 只能为托管磁盘指定磁盘加密集资源 ID。有关详细信息，请参阅 https://aka.ms/mdssewithcmkoverview。

名称	类型	说明
id	string	资源 ID

DomainNameLabelScopeTypes

枚举

域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签

值	说明
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

EncryptionIdentity

Object

指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。

名称	类型	说明
userAssignedIdentityResourceId	string	指定与 VM 关联的用户标识之一的 ARM 资源 ID。

EventGridAndResourceGraph

Object

指定与 eventGridAndResourceGraph 相关的计划事件相关配置。

名称	类型	说明
enable	boolean	指定是否为计划事件相关配置启用了事件网格和资源图。
scheduledEventsApiVersion	string	指定 api-version 以确定将交付的计划事件配置架构版本。

ExpandTypesForGetVMScaleSets

枚举

值	说明
userData

ExtendedLocation

Object

扩展位置的复杂类型。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

枚举

扩展位置的类型。

值	说明
EdgeZone

HighSpeedInterconnectPlacement

枚举

指定虚拟机规模集的高速互连放置。

值	说明
None	无需高速互连放置
Trunk	干线高速互连放置

HostEndpointSettings

Object

指定特定的主机终结点设置。

名称	类型	说明
inVMAccessControlProfileReferenceId	string	以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} 格式指定 InVMAccessControlProfileVersion 资源 ID
mode	Modes	指定执行模式。在审核模式下，系统就像强制实施访问控制策略一样，包括在日志中发出访问拒绝条目，但它实际上不会拒绝对主机终结点的任何请求。在“强制”模式下，系统将强制实施访问控制，这是建议的作模式。

ImageReference

Object

指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。注意：只能在创建规模集时设置映像引用发布者和产品/服务。

名称	类型	说明
communityGalleryImageId	string	为 vm 部署指定社区库映像唯一 ID。这可以从社区库映像 GET 调用中提取。
exactVersion	string	以十进制数指定用于创建虚拟机的平台映像或市场映像的版本。此只读字段与“version”不同，仅当“version”字段中指定的值为“latest”时。
id	string	资源 ID
offer	string	指定用于创建虚拟机的平台映像或市场映像的产品/服务。
publisher	string	映像发布者。
sharedGalleryImageId	string	为 vm 部署指定共享库映像唯一 ID。这可以从共享库映像 GET 调用中提取。
sku	string	映像 SKU。
version	string	指定用于创建虚拟机的平台映像或市场映像的版本。允许的格式为 Major.Minor.Build 或“latest”。主要、次要和生成是十进制数。指定“latest”以在部署时使用可用映像的最新版本。即使使用“最新”，即使新版本可用，VM 映像也不会在部署后自动更新。请不要对库映像部署使用字段“version”，库映像应始终使用“id”字段进行部署，若要使用库映像的“latest”版本，只需在“id”字段中设置“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}”，而不输入版本。

InnerError

Object

内部错误详细信息。

名称	类型	说明
errordetail	string	内部错误消息或异常转储。
exceptiontype	string	异常类型。

IPVersion

枚举

从 Api-Version 2017-03-30 开始提供，它表示特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。可能的值为：“IPv4”和“IPv6”。

值	说明
IPv4
IPv6

KeyVaultSecretReference

Object

描述对 Key Vault 机密的引用

名称	类型	说明
secretUrl	string	引用 Key Vault 中的机密的 URL。
sourceVault	SubResource	包含机密的 Key Vault 的相对 URL。

LinuxConfiguration

Object

指定虚拟机上的 Linux 操作系统设置。有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux。

名称	类型	说明
disablePasswordAuthentication	boolean	指定是否应禁用密码身份验证。
enableVMAgentPlatformUpdates	boolean	指示是否为 Linux 虚拟机启用了 VMAgent 平台更新。默认值为 false。
patchSettings	LinuxPatchSettings	[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。
provisionVMAgent	boolean	指示是否应在虚拟机上预配虚拟机代理。如果未在请求正文中指定此属性，则默认行为是将其设置为 true。这将确保 VM 代理安装在 VM 上，以便以后可以向 VM 添加扩展。
ssh	SshConfiguration	指定 Linux OS 的 ssh 密钥配置。

LinuxPatchAssessmentMode

枚举

指定 IaaS 虚拟机的 VM 来宾修补评估模式。

可能的值为：

ImageDefault - 控制虚拟机上的修补程序评估的时间。

AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。

值	说明
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Object

指定与 Linux 上的 VM 来宾修补相关的设置。

名称	类型	说明
assessmentMode	LinuxPatchAssessmentMode	指定 IaaS 虚拟机的 VM 来宾修补评估模式。可能的值为： ImageDefault - 控制虚拟机上的修补程序评估的时间。 AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	指定 Linux 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。
patchMode	LinuxVMGuestPatchMode	指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。可能的值为： ImageDefault - 使用虚拟机的默认修补配置。 AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 必须为 true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

枚举

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

值	说明
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Object

指定在 Linux 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。

名称	类型	说明
bypassPlatformSafetyChecksOnUserSchedule	boolean	使客户能够在不意外升级的情况下计划修补
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

LinuxVMGuestPatchMode

枚举

指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。

可能的值为：

ImageDefault - 使用虚拟机的默认修补配置。

AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 必须为 true

值	说明
ImageDefault
AutomaticByPlatform

MaxInstancePercentPerZonePolicy

Object

用于限制虚拟机规模集中每个可用性区域的虚拟机数的配置参数。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机规模集上启用 maxInstancePercentPerZonePolicy。
value	integer (int32) maximum: 100	限制每个区域中的实例数占虚拟机规模集总容量的百分比。

Mode

枚举

指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视，但不强制对审核模式下主机终结点的请求实施访问控制，而在“强制”模式下，将强制实施访问控制。默认值为“强制”模式。

值	说明
Audit
Enforce

Modes

枚举

指定执行模式。在审核模式下，系统就像强制实施访问控制策略一样，包括在日志中发出访问拒绝条目，但它实际上不会拒绝对主机终结点的任何请求。在“强制”模式下，系统将强制实施访问控制，这是建议的作模式。

值	说明
Audit
Enforce
Disabled

NetworkApiVersion

枚举

指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本

值	说明
2020-11-01
2022-11-01

NetworkInterfaceAuxiliaryMode

枚举

指定是否为网络接口资源启用辅助模式。

值	说明
None
AcceleratedConnections
Floating

NetworkInterfaceAuxiliarySku

枚举

指定是否为网络接口资源启用辅助 SKU。

值	说明
None
A1
A2
A4
A8

OperatingSystemTypes

枚举

此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。可能的值包括：Windows、Linux。

值	说明
Windows
Linux

OrchestrationMode

枚举

指定虚拟机规模集的业务流程模式。

值	说明
Uniform
Flexible

OSImageNotificationProfile

Object

名称	类型	说明
enable	boolean	指定是启用或禁用 OS 映像计划事件。
notBeforeTimeout	string	虚拟机重新映像或升级其 OS 的时间长度将不得不在事件自动批准（超时）之前批准 OS 映像计划事件。配置以 ISO 8601 格式指定，该值必须为 15 分钟（PT15M）

PassNames

枚举

值	说明
OobeSystem

PatchSettings

Object

指定与 Windows 上的 VM 来宾修补相关的设置。

名称	类型	说明
assessmentMode	WindowsPatchAssessmentMode	指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。可能的值为： ImageDefault - 控制虚拟机上的修补程序评估的时间。 AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	指定 Windows 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。
enableHotpatching	boolean	使客户无需重新启动即可修补其 Azure VM。对于 enableHotpatching，必须将“provisionVMAgent”设置为 true，并且“patchMode”必须设置为“AutomaticByPlatform”。
patchMode	WindowsVMGuestPatchMode	指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。可能的值为：手动 - 可以控制将修补程序应用到虚拟机。为此，请在 VM 中手动应用修补程序。在此模式下，自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false AutomaticByOS - 虚拟机将由 OS 自动更新。属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。 AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

Placement

Object

描述资源硬件放置的用户定义约束。

名称	类型	说明
excludeZones	string[]	此属性补充了“zonePlacementPolicy”属性。如果将“zonePlacementPolicy”设置为“Any”/“Auto”，则系统选择的可用性区域不得存在于与“excludeZones”一起传递的可用性区域列表中。如果未提供“excludeZones”，则会考虑区域中的所有可用性区域以供选择。
includeZones	string[]	此属性补充了“zonePlacementPolicy”属性。如果将“zonePlacementPolicy”设置为“Any”/“Auto”，则系统选择的可用性区域必须存在于与“includeZones”一起传递的可用性区域列表中。如果未提供“includeZones”，则会考虑区域中的所有可用性区域以供选择。
zonePlacementPolicy	ZonePlacementPolicyType	指定资源在可用性区域中放置的策略。可能的值为：任意（用于虚拟机）、自动（用于虚拟机规模集）- 作为资源创建的一部分，系统将自动选取可用性区域。

Plan

Object

指定有关用于创建虚拟机的市场映像的信息。此元素仅用于市场映像。必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。在 Azure 门户中，找到要使用的市场映像，然后单击 想要以编程方式部署，开始使用 ->。输入任何必需的信息，然后单击“保存。

名称	类型	说明
name	string	计划 ID。
product	string	指定来自市场的映像的产品。此值与 imageReference 元素下的 Offer 相同。
promotionCode	string	促销代码。
publisher	string	发布者 ID。

PriorityMixPolicy

Object

指定具有灵活业务流程模式的规模集中现成和常规优先级 VM 的目标拆分。使用此属性，客户可以指定在 VMSS 弹性实例横向扩展时创建的常规优先级虚拟机的基本数量，以及在达到此基本目标后在现成优先级虚拟机和常规优先级虚拟机之间进行拆分。

名称	类型	说明
baseRegularPriorityCount	integer (int32)	将在横向扩展时在此规模集中创建的常规优先级 VM 的基数。
regularPriorityPercentageAboveBase	integer (int32) maximum: 100	达到基本常规优先级计数后，VM 实例的百分比应使用常规优先级。

ProtocolTypes

枚举

指定 WinRM 侦听器的协议。可能的值为：http、https。

值	说明
Http
Https

ProxyAgentSettings

Object

指定虚拟机或虚拟机规模集的 ProxyAgent 设置。最低 API 版本：2023-09-01。

名称	类型	说明
addProxyAgentExtension	boolean	指定是否隐式安装 ProxyAgent 扩展。此选项目前仅适用于 Linux作系统。
enabled	boolean	指定是否应在虚拟机或虚拟机规模集上启用 ProxyAgent 功能。
imds	HostEndpointSettings	在创建虚拟机或虚拟机规模集时指定 IMDS 终结点设置。最低 api 版本：2024-03-01。
keyIncarnationId	integer (int32)	增加此属性的值允许用户重置用于保护来宾和主机之间的通信通道的密钥。
mode	Mode	指定 ProxyAgent 将执行的模式。警告：此属性已弃用，请在特定的 hostendpoint 设置下指定“mode”。
wireServer	HostEndpointSettings	在创建虚拟机或虚拟机规模集时指定 Wire Server 终结点设置。最低 api 版本：2024-03-01。

PublicIPAddressSku

Object

描述公共 IP Sku。只能将 OrchestrationMode 设置为灵活。

名称	类型	说明
name	PublicIPAddressSkuName	指定公共 IP SKU 名称
tier	PublicIPAddressSkuTier	指定公共 IP SKU 层

PublicIPAddressSkuName

枚举

指定公共 IP SKU 名称

值	说明
Basic
Standard

PublicIPAddressSkuTier

枚举

指定公共 IP SKU 层

值	说明
Regional
Global

RebalanceBehavior

枚举

将用于跨可用性区域在规模集中重新创建虚拟机的重新平衡行为的类型。默认且目前仅支持的值为 CreateBeforeDelete。

值	说明
CreateBeforeDelete

RebalanceStrategy

枚举

用于跨可用性区域在规模集中重新均衡虚拟机的重新平衡策略的类型。默认且目前仅支持的值是“重新创建”。

值	说明
Recreate

RepairAction

枚举

用于修复规模集中运行不正常的虚拟机的修复作类型（替换、重启、重置映像）。默认值将被替换。

值	说明
Replace
Restart
Reimage

ResiliencyPolicy

Object

描述弹性策略 - AutomaticZoneRebalancingPolicy、ResilientVMCreationPolicy 和/或 ResilientVMDeletionPolicy。

名称	类型	说明
automaticZoneRebalancingPolicy	AutomaticZoneRebalancingPolicy	执行自动 AZ 均衡时使用的配置参数。
resilientVMCreationPolicy	ResilientVMCreationPolicy	执行可复原 VM 创建时使用的配置参数。
resilientVMDeletionPolicy	ResilientVMDeletionPolicy	执行弹性 VM 删除时使用的配置参数。
zoneAllocationPolicy	ZoneAllocationPolicy	执行区域分配时使用的配置参数。

ResilientVMCreationPolicy

Object

执行可复原 VM 创建时使用的配置参数。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机规模集上启用可复原的 VM 创建。默认值为 false。

ResilientVMDeletionPolicy

Object

执行弹性 VM 删除时使用的配置参数。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机规模集上启用可复原的 VM 删除。默认值为 false。

ResourceIdentityType

枚举

用于虚拟机规模集的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机规模集中删除任何标识。

值	说明
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

RollingUpgradePolicy

Object

执行滚动升级时使用的配置参数。

名称	类型	说明
enableCrossZoneUpgrade	boolean	允许 VMSS 在构造升级批处理时忽略 AZ 边界。考虑 Update 域和 maxBatchInstancePercent 以确定批大小。
maxBatchInstancePercent	integer (int32) minimum: 5 maximum: 100	一批滚动升级同时升级的总虚拟机实例的最大百分比。由于这是一个最大值，因此以前的或将来的批中的不正常实例可能会导致批处理中的实例百分比降低，以确保更高的可靠性。此参数的默认值为 20%。
maxSurge	boolean	创建新的虚拟机来升级规模集，而不是更新现有虚拟机。为每个批创建新虚拟机后，将删除现有虚拟机。
maxUnhealthyInstancePercent	integer (int32) minimum: 5 maximum: 100	规模集中可能同时运行不正常的虚拟机实例的最大百分比，无论是由于升级，还是虚拟机运行状况检查在滚动升级中止之前处于不正常状态。在启动任何批处理之前，将检查此约束。此参数的默认值为 20%。
maxUnhealthyUpgradedInstancePercent	integer (int32) maximum: 100	可发现处于不正常状态的已升级虚拟机实例的最大百分比。升级每个批处理后，将进行此检查。如果超过此百分比，滚动更新将中止。此参数的默认值为 20%。
pauseTimeBetweenBatches	string	完成一批中所有虚拟机的更新和开始下一批之间的等待时间。持续时间应采用 ISO 8601 格式指定。默认值为 0 秒（PT0S）。
prioritizeUnhealthyInstances	boolean	在任何正常运行的实例之前，升级规模集中的所有不正常实例。
rollbackFailedInstancesOnPolicyBreach	boolean	如果违反滚动升级策略，回滚失败实例到以前的模型。

ScaleInPolicy

Object

描述虚拟机规模集的横向缩减策略。

名称	类型	说明
forceDeletion	boolean	此属性允许指定在虚拟机规模集进行缩减时，是否必须强制删除选择删除的虚拟机。（预览版中的功能）
prioritizeUnhealthyVMs	boolean	此属性允许在虚拟机规模集进行缩减时确定删除不正常和非活动 VM 的优先级。（预览版中的功能）
rules	VirtualMachineScaleSetScaleInRules[]	在虚拟机规模集中进行缩放时要遵循的规则。可能的值为：默认当虚拟机规模集进行缩放时，如果规模集是区域性规模集，则规模集将首先跨区域均衡。然后，它将尽可能跨容错域进行均衡。在每个容错域中，选择删除的虚拟机将是不受横向扩展保护的最新虚拟机。 OldestVM 当虚拟机规模集正在缩减时，将选择不从横向扩展保护的最早虚拟机进行删除。对于区域虚拟机规模集，规模集将首先跨区域均衡。在每个区域中，将选择不受保护的最早虚拟机进行删除。 NewestVM 当虚拟机规模集进行缩减时，将选择不受横向缩减保护的最新虚拟机以供删除。对于区域虚拟机规模集，规模集将首先跨区域均衡。在每个区域中，将选择不受保护的最新虚拟机进行删除。

ScheduledEventsAdditionalPublishingTargets

Object

名称	类型	说明
eventGridAndResourceGraph	EventGridAndResourceGraph	创建 eventGridAndResourceGraph Scheduled 事件设置时使用的配置参数。

ScheduledEventsPolicy

Object

指定 Redeploy、Reboot 和 ScheduledEventsAdditionalPublishingTargets Scheduled Event 相关配置。

名称	类型	说明
allInstancesDown	AllInstancesDown	创建 AllInstancesDown 定时事件设置创建时使用的配置参数。
scheduledEventsAdditionalPublishingTargets	ScheduledEventsAdditionalPublishingTargets	发布 scheduledEventsAdditionalPublishingTargets 时使用的配置参数。
userInitiatedReboot	UserInitiatedReboot	创建 userInitiatedReboot 计划事件设置创建时使用的配置参数。
userInitiatedRedeploy	UserInitiatedRedeploy	创建 userInitiatedRedeploy 计划事件设置创建时使用的配置参数。

ScheduledEventsProfile

Object

名称	类型	说明
osImageNotificationProfile	OSImageNotificationProfile	指定 OS 映像计划事件相关配置。
terminateNotificationProfile	TerminateNotificationProfile	指定终止计划事件相关配置。

SecurityEncryptionTypes

枚举

指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意： 只能为机密 VM 设置它。

值	说明
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityPostureReference

Object

指定要在规模集中使用的安全状况。最低 API 版本：2023-03-01

名称	类型	说明
excludeExtensions	string[]	应用安全状况时要排除的虚拟机扩展名称列表。
id	string	/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}\|latest 形式的安全状况引用 ID
isOverridable	boolean	用户是否可以覆盖安全状况。

SecurityProfile

Object

指定虚拟机或虚拟机规模集的安全配置文件设置。

名称	类型	说明
encryptionAtHost	boolean	用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。这将为所有磁盘启用加密，包括主机本身的资源/临时磁盘。默认行为为：除非将此属性设置为 true，否则将禁用主机上的加密。
encryptionIdentity	EncryptionIdentity	指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。
proxyAgentSettings	ProxyAgentSettings	在创建虚拟机时指定 ProxyAgent 设置。最低 API 版本：2023-09-01。
securityType	SecurityTypes	指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。默认行为为：除非设置了此属性，否则不会启用 UefiSettings。
uefiSettings	UefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。最低 api 版本：2020-12-01。

SecurityTypes

枚举

指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。默认行为为：除非设置了此属性，否则不会启用 UefiSettings。

值	说明
TrustedLaunch
ConfidentialVM

ServiceArtifactReference

Object

指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。最低 API 版本：2022-11-01

名称	类型	说明
id	string	以 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} 的形式的服务项目引用 ID

SettingNames

枚举

指定内容应用到的设置的名称。可能的值包括：FirstLogonCommands 和 AutoLogon。

值	说明
AutoLogon
FirstLogonCommands

Sku

Object

描述虚拟机规模集 SKU。注意：如果规模集当前在硬件上不支持新的 VM SKU，则需要在修改 SKU 名称之前解除分配规模集中的 VM。

名称	类型	说明
capacity	integer (int64)	指定规模集中的虚拟机数。
name	string	SKU 名称。
tier	string	指定规模集中的虚拟机层。可能的值： Standard 基本

SkuProfile

Object

指定虚拟机规模集的 SKU 配置文件。使用此属性，客户可以指定 VM 大小列表和分配策略。

名称	类型	说明
allocationStrategy	AllocationStrategy	指定将基于其分配 VM 的虚拟机规模集的分配策略。
vmSizes	SkuProfileVMSize[]	指定虚拟机规模集的 VM 大小。

SkuProfileVMSize

Object

指定虚拟机大小。

名称	类型	说明
name	string	指定 VM 大小的名称。
rank	integer (int32)	指定与 VM 大小关联的排名（a.k.a 优先级）。

SpotRestorePolicy

Object

指定虚拟机规模集的现成Try-Restore 属性。使用此属性，客户可以根据容量可用性和定价限制，机会性地启用或禁用已逐出的现成 VMSS VM 实例的自动还原。

名称	类型	说明
enabled	boolean	启用现成Try-Restore 功能，其中将尝试根据容量可用性和定价约束以机会方式还原逐出的 VMSS SPOT 实例
restoreTimeout	string	超时值表示为 ISO 8601 持续时间，之后平台不会尝试还原 VMSS SPOT 实例

SshConfiguration

Object

Azure 上运行的基于 Linux 的 VM 的 SSH 配置

名称	类型	说明
publicKeys	SshPublicKey[]	用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。

SshPublicKey

Object

包含有关 SSH 证书公钥的信息以及放置公钥的 Linux VM 上的路径。

名称	类型	说明
keyData	string	用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。密钥必须至少为 2048 位且采用 ssh-rsa 格式。有关创建 ssh 密钥，请参阅 [在 Azure 中的 Linux 和 Mac 上为 Linux VM 创建 SSH 密钥]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	指定存储 ssh 公钥的已创建 VM 上的完整路径。如果文件已存在，则指定的键将追加到该文件中。示例：/home/user/.ssh/authorized_keys

StorageAccountTypes

枚举

指定托管磁盘的存储帐户类型。只能在创建规模集时设置托管 OS 磁盘存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用。它不能与 OS 磁盘一起使用。 Standard_LRS使用标准 HDD。 StandardSSD_LRS使用标准 SSD。 Premium_LRS使用高级 SSD。 UltraSSD_LRS使用超级磁盘。 Premium_ZRS使用高级 SSD 区域冗余存储。 StandardSSD_ZRS使用标准 SSD 区域冗余存储。有关 Windows 虚拟机支持的磁盘的详细信息，请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/disks-types，对于 Linux 虚拟机，请参阅 https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

值	说明
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

SubResource

Object

名称	类型	说明
id	string	资源 ID

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TerminateNotificationProfile

Object

名称	类型	说明
enable	boolean	指定是启用或禁用终止计划事件。
notBeforeTimeout	string	删除虚拟机的可配置时间长度可能需要在事件自动批准（超时）之前批准终止计划事件。必须以 ISO 8601 格式指定配置，默认值为 5 分钟（PT5M）

UefiSettings

Object

指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。最低 api 版本：2020-12-01。

名称	类型	说明
secureBootEnabled	boolean	指定是否应在虚拟机上启用安全启动。最低 api 版本：2020-12-01。
vTpmEnabled	boolean	指定是否应在虚拟机上启用 vTPM。最低 api 版本：2020-12-01。

UpgradeMode

枚举

指定升级到规模集中虚拟机的模式。

可能的值为：

手动 - 控制对规模集中虚拟机的更新的应用程序。使用 manualUpgrade作执行此作。

自动 - 规模集中的所有虚拟机同时自动更新。

值	说明
Automatic
Manual
Rolling

UpgradePolicy

Object

描述升级策略 - 自动、手动或滚动。

名称	类型	说明
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	用于执行自动 OS 升级的配置参数。
mode	UpgradeMode	指定升级到规模集中虚拟机的模式。可能的值为：手动 - 控制对规模集中虚拟机的更新的应用程序。使用 manualUpgrade作执行此作。自动 - 规模集中的所有虚拟机同时自动更新。
rollingUpgradePolicy	RollingUpgradePolicy	执行滚动升级时使用的配置参数。

UserAssignedIdentitiesValue

Object

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。

UserInitiatedReboot

Object

指定与重新启动相关的计划事件相关配置。

名称	类型	说明
automaticallyApprove	boolean	指定重新启动计划事件相关配置。

UserInitiatedRedeploy

Object

指定与“重新部署”相关的“计划事件”相关配置。

名称	类型	说明
automaticallyApprove	boolean	指定重新部署计划事件相关配置。

VaultCertificate

Object

介绍 Key Vault 中的单个证书引用，以及证书应驻留在 VM 上的位置。

名称	类型	说明
certificateStore	string	对于 Windows VM，指定应向其添加证书的虚拟机上的证书存储。指定的证书存储隐式位于 LocalMachine 帐户中。对于 Linux VM，证书文件位于 /var/lib/waagent 目录下，文件名为 X509 证书文件 <大写Thumbprint>.crt，<用于私钥的 uppercaseThumbprint>.prv。这两个文件都是 .pem 格式的。
certificateUrl	string	这是已作为机密上传到 Key Vault 的证书的 URL。若要将机密添加到 Key Vault，请参阅向密钥保管库添加密钥或机密。在这种情况下，证书必须是以下 JSON 对象的 Base64 编码，该对象在 UTF-8 中编码： { } “data”：“<Base64 编码的证书>”， “dataType”：“pfx”， “password”：“<pfx-file-password>” } 若要在虚拟机上安装证书，建议使用适用于 Linux 的 Azure Key Vault 虚拟机扩展或适用于 Windows 的Azure Key Vault 虚拟机扩展。

VaultSecretGroup

Object

描述一组证书，这些证书都位于同一 Key Vault 中。

名称	类型	说明
sourceVault	SubResource	Key Vault 的相对 URL，其中包含 VaultCertificates 中的所有证书。
vaultCertificates	VaultCertificate[]	SourceVault 中包含证书的密钥保管库引用列表。

VirtualHardDisk

Object

描述磁盘的 URI。

名称	类型	说明
uri	string	指定虚拟硬盘的 URI。

VirtualMachineEvictionPolicyTypes

枚举

指定 Azure 现成 VM/VMSS 的逐出策略

值	说明
Deallocate
Delete

VirtualMachinePriorityTypes

枚举

指定独立虚拟机或规模集中虚拟机的优先级。 “低”枚举将来将弃用，请使用“现成”作为枚举来部署 Azure 现成 VM/VMSS。

值	说明
Regular
Low
Spot

VirtualMachineScaleSet

Object

描述虚拟机规模集。

名称	类型	说明
etag	string	Etag 是在 VMSS 的 Create/Update/Get 响应中返回的属性，以便客户可以在标头中提供它以确保乐观更新
extendedLocation	ExtendedLocation	虚拟机规模集的扩展位置。
id	string	资源的完全限定资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	VirtualMachineScaleSetIdentity	虚拟机规模集的标识（如果已配置）。
location	string	资源所在的地理位置
name	string	资源的名称
placement	Placement	“放置”部分指定虚拟机规模集硬件放置的用户定义约束。置备 VMSS 后，无法更改此属性。最低 api 版本：2025-04-01。
plan	Plan	指定有关用于创建虚拟机的市场映像的信息。此元素仅用于市场映像。必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。在 Azure 门户中，找到要使用的市场映像，然后单击想要以编程方式部署，开始使用 ->。输入任何必需的信息，然后单击“保存。
properties.additionalCapabilities	AdditionalCapabilities	指定在虚拟机规模集中的虚拟机上启用或禁用的其他功能。例如：虚拟机是否能够支持使用 UltraSSD_LRS 存储帐户类型附加托管数据磁盘。
properties.automaticRepairsPolicy	AutomaticRepairsPolicy	自动修复的策略。
properties.constrainedMaximumCapacity	boolean	必须设置为 True 或省略的可选属性。
properties.doNotRunExtensionsOnOverprovisionedVMs	boolean	启用过度预配后，仅在请求的 VM 数量上启动扩展，这些 VM 最终会保留。因此，此属性将确保扩展不会在额外的过度预配的 VM 上运行。
properties.highSpeedInterconnectPlacement	HighSpeedInterconnectPlacement	指定虚拟机规模集的高速互连放置。
properties.hostGroup	SubResource	指定虚拟机规模集所在的专用主机组的信息。最低 API 版本：2020-06-01。
properties.orchestrationMode	OrchestrationMode	指定虚拟机规模集的业务流程模式。
properties.overprovision	boolean	指定是否应过度预配虚拟机规模集。
properties.platformFaultDomainCount	integer (int32)	每个放置组的容错域计数。
properties.priorityMixPolicy	PriorityMixPolicy	指定用于在同一 VMSS Flex 实例中混合现成和常规优先级 VM 的所需目标。
properties.provisioningState	string	预配状态，仅出现在响应中。
properties.proximityPlacementGroup	SubResource	指定应向其分配虚拟机规模集的邻近放置组的相关信息。最低 api 版本：2018-04-01。
properties.resiliencyPolicy	ResiliencyPolicy	复原策略
properties.scaleInPolicy	ScaleInPolicy	指定在虚拟机规模集中的虚拟机中缩放时应用的策略。
properties.scheduledEventsPolicy	ScheduledEventsPolicy	ScheduledEventsPolicy。
properties.singlePlacementGroup	boolean	如果为 true，则规模集限制为单个放置组，最大大小为 100 个虚拟机。注意：如果 singlePlacementGroup 为 true，则可能会将其修改为 false。但是，如果 singlePlacementGroup 为 false，则可能不会将其修改为 true。
properties.skuProfile	SkuProfile	指定虚拟机规模集的 SKU 配置文件。
properties.spotRestorePolicy	SpotRestorePolicy	指定虚拟机规模集的现成还原属性。
properties.timeCreated	string (date-time)	指定创建虚拟机规模集资源的时间。最低 api 版本：2021-11-01。
properties.uniqueId	string	指定唯一标识虚拟机规模集的 ID。
properties.upgradePolicy	UpgradePolicy	升级策略。
properties.virtualMachineProfile	VirtualMachineScaleSetVMProfile	虚拟机配置文件。
properties.zonalPlatformFaultDomainAlignMode	ZonalPlatformFaultDomainAlignMode	指定虚拟机规模集计算与存储容错域计数之间的对齐模式。
properties.zoneBalance	boolean	如果发生区域中断，是否强制甚至跨 x 区域进行虚拟机分发。仅当规模集的区域属性包含多个区域时，才能设置 zoneBalance 属性。如果没有区域或仅指定一个区域，则不应设置 zoneBalance 属性。
sku	Sku	虚拟机规模集 SKU。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”
zones	string[]	可用性区域。

VirtualMachineScaleSetDataDisk

Object

描述虚拟机规模集数据磁盘。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认值为：标准存储的 None。高级存储的 ReadOnly。
createOption	DiskCreateOptionTypes	创建选项。
deleteOption	DiskDeleteOptionTypes	指定在 VMSS Flex 删除时是否应删除或分离数据磁盘（此功能仅适用于具有灵活 OrchestrationMode 的 VMSS）。可能的值：删除如果使用此值，则删除 VMSS Flex VM 时删除数据磁盘。分离如果使用此值，则在删除 VMSS Flex VM 后保留数据磁盘。默认值设置为 Delete。
diskIOPSReadWrite	integer (int64)	指定托管磁盘的 Read-Write IOPS。仅当 StorageAccountType UltraSSD_LRS时才应使用。如果未指定，则会根据 diskSizeGB 分配默认值。
diskMBpsReadWrite	integer (int64)	指定托管磁盘的带宽（以 MB/秒为单位）。仅当 StorageAccountType UltraSSD_LRS时才应使用。如果未指定，则会根据 diskSizeGB 分配默认值。
diskSizeGB	integer (int32)	指定空数据磁盘的大小（以 GB 为单位）。此元素可用于覆盖虚拟机映像中的磁盘大小。属性 diskSizeGB 是磁盘的字节数 x 1024^3，该值不能大于 1023。
lun	integer (int32)	指定数据磁盘的逻辑单元号。此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	托管磁盘参数。
name	string	磁盘名称。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

VirtualMachineScaleSetExtension

Object

描述虚拟机规模集扩展。

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties.autoUpgradeMinorVersion	boolean	指示扩展是否应在部署时使用较新的次要版本。但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。
properties.enableAutomaticUpgrade	boolean	指示如果有较新版本的扩展可用，平台是否应自动升级扩展。
properties.forceUpdateTag	string	如果提供值并且与上一个值不同，则即使扩展配置未更改，扩展处理程序也会强制更新。
properties.protectedSettings		该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	由引用传递的扩展保护的设置，并从密钥保管库使用
properties.provisionAfterExtensions	string[]	需要预配此扩展的扩展名称的集合。
properties.provisioningState	string	预配状态，仅出现在响应中。
properties.publisher	string	扩展处理程序发布者的名称。
properties.settings		扩展的 Json 格式公共设置。
properties.suppressFailures	boolean	指示是否取消来自扩展的故障（不连接到 VM 等作故障不会取消，而不管此值如何）。默认值为 false。
properties.type	string	指定扩展的类型;例如“CustomScriptExtension”。
properties.typeHandlerVersion	string	指定脚本处理程序的版本。
type	string	资源类型

VirtualMachineScaleSetExtensionProfile

Object

描述虚拟机规模集扩展配置文件。

名称	类型	说明
extensions	VirtualMachineScaleSetExtension[]	虚拟机规模集子扩展资源。
extensionsTimeBudget	string	指定分配所有扩展开始的时间。持续时间应介于 15 分钟到 120 分钟（含）之间，应采用 ISO 8601 格式指定。默认值为 90 分钟（PT1H30M）。最低 API 版本：2020-06-01。

VirtualMachineScaleSetHardwareProfile

Object

指定虚拟机规模集的硬件设置。

名称	类型	说明
vmSizeProperties	VMSizeProperties	指定用于自定义虚拟机大小的属性。最低 api 版本：2021-11-01。有关详细信息，请按照 VM 自定义中的说明进行操作。

VirtualMachineScaleSetIdentity

Object

虚拟机规模集的标识。

名称	类型	说明
principalId	string	虚拟机规模集标识的主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	与虚拟机规模集关联的租户 ID。此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于虚拟机规模集的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机规模集中删除任何标识。
userAssignedIdentities	<string, UserAssignedIdentitiesValue>	与虚拟机规模集关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

VirtualMachineScaleSetIPConfiguration

Object

介绍虚拟机规模集网络配置文件的 IP 配置。

名称	类型	说明
name	string	IP 配置名称。
properties.applicationGatewayBackendAddressPools	SubResource[]	指定对应用程序网关后端地址池的引用数组。规模集可以引用多个应用程序网关的后端地址池。多个规模集不能使用相同的应用程序网关。
properties.applicationSecurityGroups	SubResource[]	指定对应用程序安全组的引用数组。
properties.loadBalancerBackendAddressPools	SubResource[]	指定对负载均衡器后端地址池的引用数组。规模集可以引用一个公共负载均衡器和一个内部负载均衡器的后端地址池。多个规模集不能使用相同的基本 SKU 负载均衡器。
properties.loadBalancerInboundNatPools	SubResource[]	指定对负载均衡器的入站 Nat 池的引用数组。规模集可以引用一个公共负载均衡器和一个内部负载均衡器的入站 NAT 池。多个规模集不能使用相同的基本 SKU 负载均衡器。
properties.primary	boolean	指定主网络接口，以防虚拟机具有 1 个以上的网络接口。
properties.privateIPAddressVersion	IPVersion	从 Api-Version 2017-03-30 开始提供，它表示特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。可能的值为：“IPv4”和“IPv6”。
properties.publicIPAddressConfiguration	VirtualMachineScaleSetPublicIPAddressConfiguration	publicIPAddressConfiguration。
properties.subnet	ApiEntityReference	指定子网的标识符。

VirtualMachineScaleSetIpTag

Object

包含与公共 IP 地址关联的 IP 标记。

名称	类型	说明
ipTagType	string	IP 标记类型。示例：FirstPartyUsage。
tag	string	与公共 IP 关联的 IP 标记。示例：SQL、存储等。

VirtualMachineScaleSetManagedDiskParameters

Object

描述 ScaleSet 托管磁盘的参数。

名称	类型	说明
diskEncryptionSet	DiskEncryptionSetParameters	指定托管磁盘的客户托管磁盘加密集资源 ID。
securityProfile	VMDiskSecurityProfile	指定托管磁盘的安全配置文件。
storageAccountType	StorageAccountTypes	指定托管磁盘的存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。

VirtualMachineScaleSetNetworkConfiguration

Object

介绍虚拟机规模集网络配置文件的网络配置。

名称	类型	说明
name	string	网络配置名称。
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	指定是否为网络接口资源启用辅助模式。
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	指定是否为网络接口资源启用辅助 SKU。
properties.deleteOption	DeleteOptions	指定删除 VM 时网络接口发生的情况
properties.disableTcpStateTracking	boolean	指定是否为 tcp 状态跟踪禁用网络接口。
properties.dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	要应用于网络接口的 dns 设置。
properties.enableAcceleratedNetworking	boolean	指定网络接口是否已启用加速网络。
properties.enableFpga	boolean	指定网络接口是否已启用 FPGA 网络。
properties.enableIPForwarding	boolean	是否在此 NIC 上启用了 IP 转发。
properties.ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	指定网络接口的 IP 配置。
properties.networkSecurityGroup	SubResource	网络安全组。
properties.primary	boolean	指定主网络接口，以防虚拟机具有 1 个以上的网络接口。
tags	object	应用于此 NetworkInterfaceConfiguration 创建的 networkInterface 地址的资源标记

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Object

描述虚拟机规模集网络配置的 DNS 设置。

名称	类型	说明
dnsServers	string[]	DNS 服务器 IP 地址列表

VirtualMachineScaleSetNetworkProfile

Object

描述虚拟机规模集网络配置文件。

名称	类型	说明
healthProbe	ApiEntityReference	对负载均衡器探测的引用，用于确定虚拟机规模集中实例的运行状况。引用的格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}”。
networkApiVersion	NetworkApiVersion	指定使用业务流程模式“灵活”在虚拟机规模集的网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	网络配置列表。

VirtualMachineScaleSetOSDisk

Object

描述虚拟机规模集操作系统磁盘。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认值为：标准存储的 None。高级存储的 ReadOnly。
createOption	DiskCreateOptionTypes	指定应如何创建规模集中的虚拟机。唯一允许的值是：FromImage。使用映像创建虚拟机时使用此值。如果使用平台映像，则还使用上述 imageReference 元素。如果使用市场映像，则还会使用前面所述的计划元素。
deleteOption	DiskDeleteOptionTypes	指定在 VMSS Flex 删除时是否应删除或分离 OS 磁盘（此功能仅适用于具有灵活 OrchestrationMode 的 VMSS）。可能的值：删除如果使用此值，则删除 VMSS Flex VM 时会删除 OS 磁盘。分离如果使用此值，则会在删除 VMSS Flex VM 后保留 OS 磁盘。默认值设置为 Delete。对于临时 OS 磁盘，默认值设置为删除。用户无法更改临时 OS 磁盘的删除选项。
diffDiskSettings	DiffDiskSettings	指定虚拟机规模集使用的作系统磁盘的临时磁盘设置。
diskSizeGB	integer (int32)	指定空数据磁盘的大小（以 GB 为单位）。此元素可用于覆盖虚拟机映像中的磁盘大小。属性“diskSizeGB”是磁盘的字节数 x 1024^3，该值不能大于 1023。
image	VirtualHardDisk	指定要基于规模集的非托管用户映像的信息。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	托管磁盘参数。
name	string	磁盘名称。
osType	OperatingSystemTypes	此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。可能的值包括：Windows、Linux。
vhdContainers	string[]	指定用于存储规模集作系统磁盘的容器 URL。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

VirtualMachineScaleSetOSProfile

Object

描述虚拟机规模集 OS 配置文件。

名称	类型	说明
adminPassword	string (password)	指定管理员帐户的密码。最小长度（Windows）： 8 个字符最小长度（Linux）： 6 个字符最大长度（Windows）： 123 个字符最大长度（Linux）： 72 个字符复杂性要求：需要满足以下 4 个条件中的 3 个字符数较低具有大写字符包含数字具有特殊字符（正则表达式匹配 [\W_]）不允许的值：“abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password！”、“Password1”、“Password22”、“iloveyou！” 若要重置密码，请参阅如何在 Windows VM 中重置远程桌面服务或其登录密码有关重置根密码，请参阅使用 VMAccess 扩展管理用户、SSH 并检查或修复 Azure Linux VM 上的磁盘
adminUsername	string	指定管理员帐户的名称。仅限 Windows 的限制：不能以“.” 结尾。不允许的值：“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”。最小长度（Linux）： 1 个字符最大长度（Linux）： 64 个字符最大长度（Windows）： 20 个字符
allowExtensionOperations	boolean	指定是否应在虚拟机规模集上允许扩展操作。仅当虚拟机规模集上没有扩展时，此选项才可设置为 False。
computerNamePrefix	string	指定规模集中所有虚拟机的计算机名称前缀。计算机名称前缀长度必须为 1 到 15 个字符。
customData	string	指定自定义数据的 base-64 编码字符串。 base-64 编码字符串将解码为作为虚拟机上的文件保存的二进制数组。二进制数组的最大长度为 65535 字节。有关为 VM 使用 cloud-init，请参阅使用 cloud-init 在创建期间自定义 Linux VM
linuxConfiguration	LinuxConfiguration	指定虚拟机上的 Linux 操作系统设置。有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux。
requireGuestProvisionSignal	boolean	必须设置为 True 或省略的可选属性。
secrets	VaultSecretGroup[]	指定应在规模集中的虚拟机上安装的证书集。若要在虚拟机上安装证书，建议使用适用于 Linux 的 Azure Key Vault 虚拟机扩展或适用于 Windows 的Azure Key Vault 虚拟机扩展。
windowsConfiguration	WindowsConfiguration	指定虚拟机上的 Windows 操作系统设置。

VirtualMachineScaleSetPublicIPAddressConfiguration

Object

介绍虚拟机规模集 IP 配置的公共 IPAddress 配置

名称	类型	说明
name	string	publicIP 地址配置名称。
properties.deleteOption	DeleteOptions	指定删除 VM 时公共 IP 会发生什么情况
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	要应用于 publicIP 地址的 dns 设置。
properties.idleTimeoutInMinutes	integer (int32)	公共 IP 地址的空闲超时。
properties.ipTags	VirtualMachineScaleSetIpTag[]	与公共 IP 地址关联的 IP 标记列表。
properties.publicIPAddressVersion	IPVersion	从 Api-Version 2019-07-01 开始提供，它表示特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。可能的值为：“IPv4”和“IPv6”。
properties.publicIPPrefix	SubResource	要从中分配 publicIP 地址的 PublicIPPrefix。
sku	PublicIPAddressSku	描述公共 IP Sku。只能将 OrchestrationMode 设置为灵活。
tags	object	应用于此 PublicIPAddressConfiguration 创建的 publicIP 地址的资源标记

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Object

描述虚拟机规模集网络配置的 DNS 设置。

名称	类型	说明
domainNameLabel	string	域名标签。域名标签和 vm 索引的串联将是将创建的 PublicIPAddress 资源的域名标签
domainNameLabelScope	DomainNameLabelScopeTypes	域名标签范围。根据域名标签范围和 vm 索引的策略生成的哈希域名标签的串联将是将创建的 PublicIPAddress 资源的域名标签

VirtualMachineScaleSetScaleInRules

枚举

值	说明
Default
OldestVM
NewestVM

VirtualMachineScaleSetStorageProfile

Object

描述虚拟机规模集存储配置文件。

名称	类型	说明
dataDisks	VirtualMachineScaleSetDataDisk[]	指定用于向规模集中的虚拟机添加数据磁盘的参数。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。
diskControllerType	DiskControllerTypes	指定为规模集中的虚拟机配置的磁盘控制器类型。最低 API 版本：2022-08-01
imageReference	ImageReference	指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。
osDisk	VirtualMachineScaleSetOSDisk	指定有关规模集中虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。

VirtualMachineScaleSetVMProfile

Object

介绍虚拟机规模集虚拟机配置文件。

名称	类型	说明
applicationProfile	ApplicationProfile	指定应提供给 VM/VMSS 的库应用程序
billingProfile	BillingProfile	指定 Azure 现成 VMSS 的计费相关详细信息。最低 API 版本：2019-03-01。
capacityReservation	CapacityReservationProfile	指定规模集的容量预留相关详细信息。最低 API 版本：2021-04-01。
diagnosticsProfile	DiagnosticsProfile	指定启动诊断设置状态。最低 API 版本：2015-06-15。
evictionPolicy	VirtualMachineEvictionPolicyTypes	指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。对于 Azure 现成虚拟机，支持“解除分配”和“删除”，最低 API 版本为 2019-03-01。对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。
extensionProfile	VirtualMachineScaleSetExtensionProfile	指定规模集中虚拟机上安装的扩展的设置集合。
hardwareProfile	VirtualMachineScaleSetHardwareProfile	指定规模集的硬件配置文件相关详细信息。最低 api 版本：2021-11-01。
licenseType	string	指定正在使用的映像或磁盘在本地获得许可。 Windows Server 操作系统的可能值为： Windows_Client Windows_Server Linux Server 操作系统的可能值为： RHEL_BYOS（适用于 RHEL） SLES_BYOS（对于 SUSE）有关详细信息，请参阅 Windows Server 的 Azure 混合使用权益 Linux Server 的 Azure 混合使用权益最低 API 版本：2015-06-15
networkProfile	VirtualMachineScaleSetNetworkProfile	指定规模集中虚拟机网络接口的属性。
osProfile	VirtualMachineScaleSetOSProfile	指定规模集中虚拟机的操作系统设置。
priority	VirtualMachinePriorityTypes	指定规模集中虚拟机的优先级。最低 api 版本：2017-10-30-preview。
scheduledEventsProfile	ScheduledEventsProfile	指定与计划事件相关的配置。
securityPostureReference	SecurityPostureReference	指定要在规模集中使用的安全状况。最低 API 版本：2023-03-01
securityProfile	SecurityProfile	指定规模集中虚拟机的安全相关配置文件设置。
serviceArtifactReference	ServiceArtifactReference	指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。最低 API 版本：2022-11-01
storageProfile	VirtualMachineScaleSetStorageProfile	指定虚拟机磁盘的存储设置。
timeCreated	string (date-time)	指定创建虚拟机规模集的此 VM 配置文件的时间。创建/更新 VMSS 虚拟机配置文件时，此值将添加到 VMSS Flex 虚拟机标记中。此属性的最低 API 版本为 2023-09-01。
userData	string	规模集中虚拟机的 UserData，必须进行 base-64 编码。客户不应在此处传递任何机密。最低 API 版本：2021-03-01。

VMDiskSecurityProfile

Object

指定托管磁盘的安全配置文件设置。 注意： 只能为机密 VM 设置它。

名称	类型	说明
diskEncryptionSet	DiskEncryptionSetParameters	指定用于客户托管密钥加密的 ConfidentialVM OS 磁盘和 VMGuest Blob 的托管磁盘的客户托管磁盘加密集资源 ID。
securityEncryptionType	SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。注意：只能为机密 VM 设置它。

VMGalleryApplication

Object

指定引用计算库应用程序版本所需的信息

名称	类型	说明
configurationReference	string	可选，指定 Azure Blob 的 URI，该 URI 将替换包的默认配置（如果提供）
enableAutomaticUpgrade	boolean	如果设置为 true，当 PIR/SIG 中提供了新的库应用程序版本时，它将自动更新 VM/VMSS
order	integer (int32)	可选，指定包必须安装的顺序
packageReferenceId	string	指定 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{version} 形式的 GalleryApplicationVersion 资源 ID
tags	string	可选，指定更多泛型上下文的传递值。
treatFailureAsDeploymentFailure	boolean	可选，如果为 true，则 VmApplication 中任何操作的任何失败都会使部署失败

VMSizeProperties

Object

指定虚拟机上的 VM 大小属性设置。

名称	类型	说明
vCPUsAvailable	integer (int32)	指定可用于 VM 的 vCPU 数。如果未在请求正文中指定此属性，则默认行为是将其设置为 api 响应中公开的 vCPU 的值，列出区域中所有可用的虚拟机大小。
vCPUsPerCore	integer (int32)	指定 vCPU 与物理核心比率。如果未在请求正文中指定此属性，则默认行为设置为 api 响应中公开的 vm 大小的 vCPUUsPerCore 值，列出区域中的所有可用虚拟机大小。将此属性设置为 1 也意味着禁用了超线程处理。

WindowsConfiguration

Object

指定虚拟机上的 Windows 操作系统设置。

名称	类型	说明
additionalUnattendContent	AdditionalUnattendContent[]	指定其他 base-64 编码的 XML 格式信息，这些信息可以包含在 Windows 安装程序使用的 Unattend.xml 文件中。
enableAutomaticUpdates	boolean	指示是否为 Windows 虚拟机启用自动更新。默认值为 true。对于虚拟机规模集，可以更新此属性，更新将对 OS 重新预配生效。
enableVMAgentPlatformUpdates	boolean	指示是否为 Windows 虚拟机启用了 VMAgent 平台更新。
patchSettings	PatchSettings	[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。
provisionVMAgent	boolean	指示是否应在虚拟机上预配虚拟机代理。如果未在请求正文中指定此属性，则默认情况下此属性设置为 true。这将确保 VM 代理安装在 VM 上，以便以后可以向 VM 添加扩展。
timeZone	string	指定虚拟机的时区。例如“太平洋标准时间”。可能的值可以从 TimeZoneInfo.GetSystemTimeZones返回的时区 TimeZoneInfo.Id 值。
winRM	WinRMConfiguration	指定 Windows 远程管理侦听器。这将启用远程 Windows PowerShell。

WindowsPatchAssessmentMode

枚举

指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。

可能的值为：

ImageDefault - 控制虚拟机上的修补程序评估的时间。

AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。

值	说明
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

枚举

指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

值	说明
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Object

指定在 Windows 修补程序设置中选择修补程序模式 AutomaticByPlatform 时要应用的其他设置。

名称	类型	说明
bypassPlatformSafetyChecksOnUserSchedule	boolean	使客户能够在不意外升级的情况下计划修补
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。

WindowsVMGuestPatchMode

枚举

指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。

可能的值为：

手动 - 可以控制将修补程序应用到虚拟机。为此，请在 VM 中手动应用修补程序。在此模式下，自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false

AutomaticByOS - 虚拟机将由 OS 自动更新。属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。

AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true

值	说明
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Object

介绍 VM 的 Windows 远程管理配置

名称	类型	说明
listeners	WinRMListener[]	Windows 远程管理侦听器列表

WinRMListener

Object

介绍 Windows 远程管理侦听器的协议和指纹

名称	类型	说明
certificateUrl	string	这是已作为机密上传到 Key Vault 的证书的 URL。若要将机密添加到 Key Vault，请参阅向密钥保管库添加密钥或机密。在这种情况下，证书必须是以下 JSON 对象的 Base64 编码，该对象在 UTF-8 中编码： { } “data”：“<Base64 编码的证书>”， “dataType”：“pfx”， “password”：“<pfx-file-password>” } 若要在虚拟机上安装证书，建议使用适用于 Linux 的 Azure Key Vault 虚拟机扩展或适用于 Windows 的Azure Key Vault 虚拟机扩展。
protocol	ProtocolTypes	指定 WinRM 侦听器的协议。可能的值为：http、https。

ZonalPlatformFaultDomainAlignMode

枚举

指定虚拟机规模集计算与存储容错域计数之间的对齐模式。

值	说明
Aligned
Unaligned

ZoneAllocationPolicy

Object

虚拟机规模集的区域分配的配置参数。

名称	类型	说明
maxInstancePercentPerZonePolicy	MaxInstancePercentPerZonePolicy	用于限制虚拟机规模集中每个可用性区域的虚拟机数的配置参数。
maxZoneCount	integer (int32)	如果 ZonePlacementPolicy 为“自动”，则要使用的最大可用性区域数。如果未指定，将使用所有可用性区域。

ZonePlacementPolicyType

枚举

指定资源在可用性区域中放置的策略。可能的值为：任意（用于虚拟机）、自动（用于虚拟机规模集）- 作为资源创建的一部分，系统将自动选取可用性区域。

值	说明
Any
Auto	虚拟机规模集中的自动区域放置。