Virtual Machine Scale Sets - Get

參考

服務:: Compute

API 版本:: 2024-07-01

顯示虛擬機擴展集的相關信息。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
vmScaleSetName	path	True	string	VM 擴展集的名稱。
api-version	query	True	string	用戶端 API 版本。
$expand	query		ExpandTypesForGetVMScaleSets	要套用至作業的展開表達式。 'UserData' 會擷取 VM 擴展集在 VM 擴展集建立/更新作業期間提供給使用者的 UserData 屬性

回應

名稱	類型	Description
200 OK	VirtualMachineScaleSet	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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=2024-07-01&$expand=userData


/**
 * Samples for VirtualMachineScaleSets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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/2024-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/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");

/**
 * 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/2024-07-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/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
// this example is just showing the usage of "VirtualMachineScaleSets_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetResource result = await virtualMachineScaleSet.GetAsync();

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

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

範例回覆

狀態碼:: 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=2024-07-01&$expand=userData


/**
 * Samples for VirtualMachineScaleSets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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/2024-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/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");

/**
 * 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/2024-07-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/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSets_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

// invoke the operation
VirtualMachineScaleSetResource result = await virtualMachineScaleSet.GetAsync();

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

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

範例回覆

狀態碼:: 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=2024-07-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/2024-07-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/2024-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/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");

/**
 * 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/2024-07-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/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
// this example is just showing the usage of "VirtualMachineScaleSets_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

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

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

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

範例回覆

狀態碼:: 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=2024-07-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/2024-07-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/2024-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/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");

/**
 * 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/2024-07-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/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
// this example is just showing the usage of "VirtualMachineScaleSets_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);

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

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

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

範例回覆

狀態碼:: 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"
    }
  }
}

定義

名稱	Description
AdditionalCapabilities	啟用或停用虛擬機或虛擬機擴展集上的功能。
AdditionalUnattendContent	指定 Windows 安裝程式所使用的 Unattend.xml 檔案中可包含的其他 XML 格式化資訊。內容是透過設定名稱、元件名稱和套用內容的傳遞來定義。
AllocationStrategy	指定虛擬機擴展集的配置策略，根據虛擬機的配置策略進行配置。
ApiEntityReference	API 實體參考。
ApiError	Api 錯誤。
ApiErrorBase	API 錯誤基底。
ApplicationProfile	包含應該提供給 VM/VMSS 的資源庫應用程式清單
AutomaticOSUpgradePolicy	用於執行自動OS升級的組態參數。
AutomaticRepairsPolicy	指定虛擬機擴展集上自動修復的組態參數。
BillingProfile	指定 Azure Spot VM 或 VMSS 的計費相關詳細數據。 API 版本下限：2019-03-01。
BootDiagnostics	開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。
CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設值為：標準記憶體的 None。進階記憶體的 ReadOnly。
CapacityReservationProfile	容量保留配置文件的參數。
CloudError	來自計算服務的錯誤回應。
ComponentNames	元件名稱。目前，唯一允許的值是 Microsoft-Windows-Shell-Setup。
DeleteOptions	指定刪除 VM 時，公用 IP 會發生什麼事
DiagnosticsProfile	指定開機診斷設定狀態。 API 版本下限：2015-06-15。
DiffDiskOptions	指定作業系統磁碟的暫時磁碟設定。
DiffDiskPlacement	指定作業系統磁碟的暫時磁碟位置。用戶可以在要求中使用這個屬性來選擇位置，例如快取磁碟、資源磁碟或 nvme 磁碟空間以進行暫時 OS 磁碟布建。如需暫時 OS 磁碟大小需求的詳細資訊，請參閱 windows VM 的暫時 OS 磁碟大小需求，https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements。 NvmeDisk 的最低 API 版本：2024-03-01。
DiffDiskSettings	描述可針對操作系統磁碟指定之暫時磁碟設定的參數。注意：暫時磁碟設定只能指定給受控磁碟。
DiskControllerTypes
DiskCreateOptionTypes	指定應該如何建立擴展集中的虛擬機。唯一允許的值是：FromImage。當您使用映像來建立虛擬機時，會使用此值。如果您使用平臺映像，則也會使用上述的 imageReference 元素。如果您使用市集映像，則也會使用先前所述的 plan 元素。
DiskDeleteOptionTypes	指定 VMSS Flex 刪除時是否應該刪除或中斷連結 OS 磁碟（此功能僅適用於具有彈性 OrchestrationMode 的 VMSS）。可能的值：刪除如果使用此值，刪除 VMSS Flex VM 時會刪除 OS 磁碟。卸離如果使用此值，則會在刪除 VMSS Flex VM 之後保留 OS 磁碟。預設值設定為 Delete。針對暫時 OS 磁碟，預設值會設定為 [刪除]。使用者無法變更暫時 OS 磁碟的刪除選項。
DiskEncryptionSetParameters	描述可針對磁碟指定之客戶受控磁碟加密集資源標識符的參數。注意：只能為受控磁碟指定磁碟加密集資源標識符。如需詳細資訊，請參閱 https://aka.ms/mdssewithcmkoverview。
DomainNameLabelScopeTypes	功能變數名稱標籤範圍。根據功能變數名稱卷標範圍的原則所產生的哈希功能變數名稱卷標串連，VM 索引將是將要建立之 PublicIPAddress 資源的功能變數名稱卷標
EncryptionIdentity	指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。
EventGridAndResourceGraph	指定 eventGridAndResourceGraph 相關的排程事件相關組態。
ExpandTypesForGetVMScaleSets	要套用至作業的展開表達式。 'UserData' 會擷取 VM 擴展集在 VM 擴展集建立/更新作業期間提供給使用者的 UserData 屬性
ExtendedLocation	擴充位置的複雜類型。
ExtendedLocationTypes	擴充位置的類型。
ImageReference	指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。注意：映像參考發行者和供應專案只能在您建立擴展集時設定。
InnerError	內部錯誤詳細數據。
IPVersion	從 Api-Version 2019-07-01 起提供，它代表特定 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修補程式設定中選取 Patch 模式 AutomaticByPlatform 時要套用的其他設定。
LinuxVMGuestPatchMode	將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。可能的值為： ImageDefault - 會使用虛擬機的預設修補組態。 AutomaticByPlatform - 虛擬機將由平台自動更新。屬性 provisionVMAgent 必須為 true
Mode	指定如果啟用此功能，ProxyAgent 將會在上執行的模式。 ProxyAgent 會開始稽核或監視，但不會在稽核模式中對主機端點的要求強制執行訪問控制，而在 [強制執行模式] 中，則會強制執行訪問控制。默認值為 [強制] 模式。
NetworkApiVersion	會指定在具有協調流程模式「彈性」的虛擬機擴展集網路介面組態中建立網路資源時所使用的Microsoft.Network API 版本
NetworkInterfaceAuxiliaryMode	指定是否為網路介面資源啟用輔助模式。
NetworkInterfaceAuxiliarySku	指定是否為網路介面資源啟用輔助 SKU。
OperatingSystemTypes	此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。可能的值為：Windows、Linux。
OrchestrationMode	指定虛擬機擴展集的協調流程模式。
OSImageNotificationProfile
PassNames	傳遞名稱。目前唯一允許的值是 OobeSystem。
PatchSettings	指定與 Windows 上的 VM 客體修補相關的設定。
Plan	指定用來建立虛擬機之 Marketplace 映像的相關信息。此元素僅用於市集映像。您必須先啟用映像以程序設計方式使用，才能從 API 使用市集映射。在 Azure 入口網站中，尋找您想要使用的市集映像，然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。輸入任何必要資訊，然後按下 [儲存]。
PriorityMixPolicy	指定具有彈性協調流程模式之擴展集內 Spot 和一般優先順序 VM 的目標分割。有了這個屬性，客戶就能夠指定建立為 VMSS flex 實例的一般優先順序 VM 基數，以及達到此基底目標之後，Spot 和 Regular 優先順序 VM 之間的分割。
ProtocolTypes	指定 WinRM 接聽程式的通訊協定。可能的值為：HTTP、https。
ProxyAgentSettings	在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限：2023-09-01。
PublicIPAddressSku	描述公用IP Sku。它只能將 OrchestrationMode 設定為彈性。
PublicIPAddressSkuName	指定公用IP SKU 名稱
PublicIPAddressSkuTier	指定公用IP SKU層
RepairAction	將用於修復擴展集中狀況不良虛擬機的修復動作類型（取代、重新啟動、重新安裝映像）。預設值為 replace。
ResiliencyPolicy	描述復原原則 - resiliencVMCreationPolicy 和/或 resiliencVMDeletionPolicy。
ResilientVMCreationPolicy	執行復原 VM 建立時所使用的組態參數。
ResilientVMDeletionPolicy	執行復原 VM 刪除時所使用的組態參數。
ResourceIdentityType	用於虛擬機擴展集的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機擴展集移除任何身分識別。
RollingUpgradePolicy	執行滾動升級時所使用的組態參數。
ScaleInPolicy	描述虛擬機擴展集的相應縮小原則。
ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy	指定重新部署、重新啟動和 ScheduledEventsAdditionalPublishingTargets Scheduled 事件相關組態。
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' 映射版本時，用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。 API 版本下限：2022-11-01
SettingNames	指定套用內容之設定的名稱。可能的值為：FirstLogonCommands 和 AutoLogon。
Sku	描述虛擬機擴展集 SKU。注意：如果擴展集目前所在的硬體上不支援新的 VM SKU，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。
SkuProfile	指定虛擬機擴展集的 SKU 配置檔。有了此屬性，客戶就能夠指定 VM 大小清單和配置策略。
SkuProfileVMSize	指定 VM 大小。
SpotRestorePolicy	指定虛擬機擴展集的Spot-Try-Restore 屬性。透過此屬性，客戶可以根據容量可用性和定價限制，以機會方式啟用或停用收回的Spot VMSS VM 實例的自動還原。
SshConfiguration	在 Azure 上執行的 Linux 型 VM 的 SSH 設定
SshPublicKey	包含 SSH 憑證公鑰的相關信息，以及放置公鑰之 Linux VM 上的路徑。
StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。
SubResource
TerminateNotificationProfile
UefiSettings	指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限：2020-12-01。
UpgradeMode	指定升級至擴展集中虛擬機的模式。可能的值為：手動 - 您可以控制擴充集中虛擬機的更新應用程式。您可以使用 manualUpgrade 動作來執行此動作。自動 - 擴展集中的所有虛擬機都會同時自動更新。
UpgradePolicy	描述升級原則 - 自動、手動或滾動。
UserAssignedIdentities	與虛擬機相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
UserInitiatedReboot	指定重新啟動相關的排程事件相關組態。
UserInitiatedRedeploy	指定重新部署相關的排程事件相關組態。
VaultCertificate	描述 Key Vault 中的單一憑證參考，以及憑證應該位於 VM 上的位置。
VaultSecretGroup	描述一組憑證，這些憑證全都位於相同的Key Vault 中。
VirtualHardDisk	描述磁碟的 URI。
VirtualMachineEvictionPolicyTypes	指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。針對 Azure Spot 虛擬機，支援「解除分配」和「刪除」，且最低 API 版本為 2019-03-01。針對 Azure Spot 擴展集，支援「解除分配」和「刪除」，且最低 API 版本為 2017-10-30-preview。
VirtualMachinePriorityTypes	指定擴展集中虛擬機的優先順序。 API 版本下限：2017-10-30-preview。
VirtualMachineScaleSet	描述虛擬機擴展集。
VirtualMachineScaleSetDataDisk	描述虛擬機擴展集數據磁碟。
VirtualMachineScaleSetExtension	描述虛擬機擴展集擴充功能。
VirtualMachineScaleSetExtensionProfile	描述虛擬機擴展集擴充功能配置檔。
VirtualMachineScaleSetHardwareProfile	指定虛擬機擴展集的硬體設定。
VirtualMachineScaleSetIdentity	虛擬機擴展集的身分識別。
VirtualMachineScaleSetIPConfiguration	描述虛擬機擴展集網路配置檔的IP組態。
VirtualMachineScaleSetIpTag	包含與公用IP位址相關聯的IP標籤。
VirtualMachineScaleSetManagedDiskParameters	描述 ScaleSet 受控磁碟的參數。
VirtualMachineScaleSetNetworkConfiguration	描述虛擬機擴展集網路配置檔的網路組態。
VirtualMachineScaleSetNetworkConfigurationDnsSettings	描述虛擬機擴展集網路組態的 DNS 設定。
VirtualMachineScaleSetNetworkProfile	描述虛擬機擴展集網路配置檔。
VirtualMachineScaleSetOSDisk	描述虛擬機擴展集作業系統磁碟。
VirtualMachineScaleSetOSProfile	描述虛擬機擴展集 OS 配置檔。
VirtualMachineScaleSetPublicIPAddressConfiguration	描述虛擬機擴展集IP組態的PublicIPAddress組態
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	描述虛擬機擴展集網路組態的 DNS 設定。
VirtualMachineScaleSetScaleInRules	調整虛擬機擴展集時要遵循的規則。可能的值為：預設當虛擬機擴展集相應縮小時，如果擴展集是區域性擴展集，則擴展集會先跨區域平衡。然後，它會盡可能跨容錯網域進行平衡。在每個容錯網域內，選擇移除的虛擬機將會是不受相應縮小保護的最新虛擬機。 OldestVM 當虛擬機擴展集相應縮小時，將會選擇未受相應縮小保護的最舊虛擬機進行移除。針對區域性虛擬機擴展集，擴展集會先跨區域進行平衡。在每個區域內，將會選擇未受保護的最舊虛擬機來移除。 NewestVM 當虛擬機擴展集相應縮小時，將會選擇未受相應縮小保護的最新虛擬機來移除。針對區域性虛擬機擴展集，擴展集會先跨區域進行平衡。在每個區域內，將會選擇未受保護的最新虛擬機來移除。
VirtualMachineScaleSetStorageProfile	描述虛擬機擴展集記憶體配置檔。
VirtualMachineScaleSetVMProfile	描述虛擬機擴展集虛擬機配置檔。
VMDiskSecurityProfile	指定受控磁碟的安全性配置檔設定。注意：只能針對機密 VM 設定。
VMGalleryApplication	指定參考計算資源庫應用程式版本的必要資訊
VMSizeProperties	指定虛擬機上的 VM 大小屬性設定。
WindowsConfiguration	指定虛擬機上的 Windows 作業系統設定。
WindowsPatchAssessmentMode	指定 IaaS 虛擬機的 VM 客體修補評估模式。可能的值為： ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。 AutomaticByPlatform - 平台將觸發定期修補程序評估。屬性 provisionVMAgent 必須為 true。
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。
WindowsVMGuestPatchAutomaticByPlatformSettings	指定在 Windows 修補程式設定中選取 Patch 模式 AutomaticByPlatform 時要套用的其他設定。
WindowsVMGuestPatchMode	將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。可能的值為：手動 - 您可以控制將修補程式的應用程式套用至虛擬機。您可以手動在 VM 內套用修補程式來執行此動作。在此模式中，會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false AutomaticByOS - 作業系統會自動更新虛擬機。屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。 AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true
WinRMConfiguration	描述 VM 的 Windows 遠端管理設定
WinRMListener	描述 Windows 遠端管理接聽程式的通訊協議和指紋
ZonalPlatformFaultDomainAlignMode	指定虛擬機擴展集計算與記憶體容錯網域計數之間的對齊模式。

AdditionalCapabilities

啟用或停用虛擬機或虛擬機擴展集上的功能。

名稱	類型	Description
hibernationEnabled	boolean	啟用或停用 VM 上休眠功能的旗標。
ultraSSDEnabled	boolean	旗標，可讓或停用在 VM 或 VMSS 上具有一或多個具有 UltraSSD_LRS記憶體帳戶類型的受控數據磁碟。只有啟用此屬性，才能將具有記憶體帳戶類型的受控磁碟UltraSSD_LRS新增至虛擬機或虛擬機擴展集。

AdditionalUnattendContent

指定 Windows 安裝程式所使用的 Unattend.xml 檔案中可包含的其他 XML 格式化資訊。內容是透過設定名稱、元件名稱和套用內容的傳遞來定義。

名稱	類型	Description
componentName	ComponentNames	元件名稱。目前，唯一允許的值是 Microsoft-Windows-Shell-Setup。
content	string	指定新增至指定路徑和元件之 unattend.xml 檔案的 XML 格式化內容。 XML 必須小於 4KB，而且必須包含要插入之設定或功能的根元素。
passName	PassNames	傳遞名稱。目前唯一允許的值是 OobeSystem。
settingName	SettingNames	指定套用內容之設定的名稱。可能的值為：FirstLogonCommands 和 AutoLogon。

AllocationStrategy

指定虛擬機擴展集的配置策略，根據虛擬機的配置策略進行配置。

名稱	類型	Description
CapacityOptimized	string
LowestPrice	string

ApiEntityReference

API 實體參考。

名稱	類型	Description
id	string	以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符

ApiError

Api 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	Api 錯誤詳細數據
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApplicationProfile

包含應該提供給 VM/VMSS 的資源庫應用程式清單

名稱	類型	Description
galleryApplications	VMGalleryApplication[]	指定應該提供給 VM/VMSS 的資源庫應用程式

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

名稱	類型	Description
disableAutomaticRollback	boolean	是否應停用OS映像復原功能。默認值為 false。
enableAutomaticOSUpgrade	boolean	指出當較新版本的OS映像可用時，是否應該以滾動方式自動套用作業系統升級至擴展集實例。默認值為 false。如果 Windows 擴展集設為 true，enableAutomaticUpdates 會自動設定為 false，且無法設定為 true。
osRollingUpgradeDeferral	boolean	指出自動OS升級是否應該延遲。延遲的OS升級會透過IMDS標籤 'Platform.PendingOSUpgrade' 傳送每個 VM 的進階通知，指出從滾動升級進行OS升級的傳入。然後升級會延遲，直到透過ApprovRollingUpgrade呼叫核准升級為止。
useRollingUpgradePolicy	boolean	指出是否應在自動OS升級期間使用滾動升級原則。默認值為 false。如果未在 VMSS 上定義任何原則，自動 OS 升級將會回復為默認原則。

AutomaticRepairsPolicy

指定虛擬機擴展集上自動修復的組態參數。

名稱	類型	Description
enabled	boolean	指定是否應在虛擬機擴展集上啟用自動修復。默認值為 false。
gracePeriod	string	由於 VM 上的狀態變更，自動修復暫停的時間量。寬限時間會在狀態變更完成之後開始。這有助於避免過早或意外修復。持續時間應以 ISO 8601 格式指定。允許的最小寬限期為 10 分鐘（PT10M），這也是預設值。允許的寬限期上限為 90 分鐘（PT90M）。
repairAction	RepairAction	將用於修復擴展集中狀況不良虛擬機的修復動作類型（取代、重新啟動、重新安裝映像）。預設值為 replace。

BillingProfile

指定 Azure Spot VM 或 VMSS 的計費相關詳細數據。 API 版本下限：2019-03-01。

名稱	類型	Description
maxPrice	number	指定您願意為 Azure Spot VM/VMSS 付費的最高價格。這個價格以美元為單位。此價格會與 VM 大小的目前 Azure Spot 價格進行比較。此外，價格會在建立/更新 Azure Spot VM/VMSS 時進行比較，只有在 maxPrice 大於目前的 Azure Spot 價格時，作業才會成功。如果目前的 Azure Spot 價格超出建立 VM/VMSS 之後的 maxPrice，maxPrice 也會用於收回 Azure Spot VM/VMSS。可能的值為： - 任何大於零的十進位值。範例：0.01538 -1 – 表示預設價格 up-to 隨選。您可以將 maxPrice 設定為 -1，表示基於價格原因，不應收回 Azure Spot VM/VMSS。此外，如果未提供默認價格上限，則會 -1。 API 版本下限：2019-03-01。

BootDiagnostics

開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。

名稱	類型	Description
enabled	boolean	是否應在虛擬機上啟用開機診斷。
storageUri	string	用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。如果在啟用開機診斷時未指定 storageUri，則會使用受控記憶體。

CachingTypes

指定快取需求。可能的值為：None、ReadOnly、ReadWrite。 預設值為：標準記憶體的 None。進階記憶體的 ReadOnly。

名稱	類型	Description
None	string
ReadOnly	string
ReadWrite	string

CapacityReservationProfile

容量保留配置文件的參數。

名稱	類型	Description
capacityReservationGroup	SubResource	指定容量保留群組資源標識符，該標識元應該用於配置已保留足夠容量的虛擬機或擴展集 VM 實例。如需詳細資訊，請參閱 https://aka.ms/CapacityReservation。

CloudError

來自計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	Api 錯誤。

ComponentNames

元件名稱。目前，唯一允許的值是 Microsoft-Windows-Shell-Setup。

名稱	類型	Description
Microsoft-Windows-Shell-Setup	string

DeleteOptions

指定刪除 VM 時，公用 IP 會發生什麼事

名稱	類型	Description
Delete	string
Detach	string

DiagnosticsProfile

指定開機診斷設定狀態。 API 版本下限：2015-06-15。

名稱	類型	Description
bootDiagnostics	BootDiagnostics	開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 NOTE：如果指定 storageUri，請確定記憶體帳戶位於與 VM 相同的區域和訂用帳戶中。您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。

DiffDiskOptions

指定作業系統磁碟的暫時磁碟設定。

名稱	類型	Description
Local	string

DiffDiskPlacement

指定作業系統磁碟的暫時磁碟位置。用戶可以在要求中使用這個屬性來選擇位置，例如快取磁碟、資源磁碟或 nvme 磁碟空間以進行暫時 OS 磁碟布建。如需暫時 OS 磁碟大小需求的詳細資訊，請參閱 windows VM 的暫時 OS 磁碟大小需求，https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements。 NvmeDisk 的最低 API 版本：2024-03-01。

名稱	類型	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

描述可針對操作系統磁碟指定之暫時磁碟設定的參數。 注意： 暫時磁碟設定只能指定給受控磁碟。

名稱	類型	Description
option	DiffDiskOptions	指定作業系統磁碟的暫時磁碟設定。
placement	DiffDiskPlacement	指定作業系統磁碟的暫時磁碟位置。可能的值為：CacheDisk、ResourceDisk、NvmeDisk。預設行為為：如果已針對 VM 大小設定，CacheDisk，否則會使用 ResourceDisk 或 NvmeDisk。請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔，以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本：2024-03-01。

DiskControllerTypes

名稱	類型	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

指定應該如何建立擴展集中的虛擬機。唯一允許的值是：FromImage。 當您使用映像來建立虛擬機時，會使用此值。如果您使用平臺映像，則也會使用上述的 imageReference 元素。如果您使用市集映像，則也會使用先前所述的 plan 元素。

名稱	類型	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

指定 VMSS Flex 刪除時是否應該刪除或中斷連結 OS 磁碟（此功能僅適用於具有彈性 OrchestrationMode 的 VMSS）。

可能的值：

刪除如果使用此值，刪除 VMSS Flex VM 時會刪除 OS 磁碟。

卸離如果使用此值，則會在刪除 VMSS Flex VM 之後保留 OS 磁碟。

預設值設定為 Delete。針對暫時 OS 磁碟，預設值會設定為 [刪除]。使用者無法變更暫時 OS 磁碟的刪除選項。

名稱	類型	Description
Delete	string
Detach	string

DiskEncryptionSetParameters

描述可針對磁碟指定之客戶受控磁碟加密集資源標識符的參數。 注意： 只能為受控磁碟指定磁碟加密集資源標識符。如需詳細資訊，請參閱 https://aka.ms/mdssewithcmkoverview。

名稱	類型	Description
id	string	資源標識碼

DomainNameLabelScopeTypes

功能變數名稱標籤範圍。根據功能變數名稱卷標範圍的原則所產生的哈希功能變數名稱卷標串連，VM 索引將是將要建立之 PublicIPAddress 資源的功能變數名稱卷標

名稱	類型	Description
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

EncryptionIdentity

指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。

名稱	類型	Description
userAssignedIdentityResourceId	string	指定與 VM 相關聯的其中一個使用者身分識別的 ARM 資源識別碼。

EventGridAndResourceGraph

指定 eventGridAndResourceGraph 相關的排程事件相關組態。

名稱	類型	Description
enable	boolean	指定已排程事件相關組態的事件方格和資源圖表是否已啟用。

ExpandTypesForGetVMScaleSets

要套用至作業的展開表達式。 'UserData' 會擷取 VM 擴展集在 VM 擴展集建立/更新作業期間提供給使用者的 UserData 屬性

名稱	類型	Description
userData	string

ExtendedLocation

擴充位置的複雜類型。

名稱	類型	Description
name	string	擴充位置的名稱。
type	ExtendedLocationTypes	擴充位置的類型。

ExtendedLocationTypes

擴充位置的類型。

名稱	類型	Description
EdgeZone	string

ImageReference

指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。注意：映像參考發行者和供應專案只能在您建立擴展集時設定。

名稱	類型	Description
communityGalleryImageId	string	指定 vm 部署的社群資源庫映像唯一標識碼。這可以從社群資源庫映像 GET 呼叫擷取。
exactVersion	string	以十進位數指定用來建立虛擬機的平臺映像或市集映像版本。這個只讀欄位與 'version' 不同，只有在 'version' 字段中指定的值為 'latest' 時。
id	string	資源標識碼
offer	string	指定用來建立虛擬機的平臺映像或市集映像供應專案。
publisher	string	映像發行者。
sharedGalleryImageId	string	指定 vm 部署的共享資源庫映像唯一標識碼。這可以從共用資源庫映像 GET 呼叫擷取。
sku	string	映像 SKU。
version	string	指定用來建立虛擬機的平臺映像或市集映像版本。允許的格式為 Major.Minor.Build 或 'latest'。主要、次要和組建是十進位數。指定 'latest' 以在部署時間使用可用映像的最新版本。即使您使用「最新」，即使有新版本可用，VM 映像也不會在部署時間之後自動更新。請勿使用欄位 'version' 進行資源庫映射部署，資源庫映射應一律使用 'id' 字段進行部署，若要使用資源庫映射的 'latest' 版本，只要設定 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}' 字段，即可不使用版本輸入。

InnerError

內部錯誤詳細數據。

名稱	類型	Description
errordetail	string	內部錯誤訊息或例外狀況傾印。
exceptiontype	string	例外狀況類型。

IPVersion

從 Api-Version 2019-07-01 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。預設值會視為 IPv4。可能的值為：'IPv4' 和 'IPv6'。

名稱	類型	Description
IPv4	string
IPv6	string

KeyVaultSecretReference

描述 Key Vault 秘密的參考

名稱	類型	Description
secretUrl	string	參考 Key Vault 中秘密的 URL。
sourceVault	SubResource	包含秘密之 Key Vault 的相對 URL。

LinuxConfiguration

指定虛擬機上的Linux作業系統設定。如需支援的 Linux 發行版清單，請參閱 Azure-Endorsed 發行版上的 Linux。

名稱	類型	Description
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。

名稱	類型	Description
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

指定與Linux上的VM客體修補相關的設定。

名稱	類型	Description
assessmentMode	LinuxPatchAssessmentMode	指定 IaaS 虛擬機的 VM 客體修補評估模式。可能的值為： ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。 AutomaticByPlatform - 平台將觸發定期修補程序評估。屬性 provisionVMAgent 必須為 true。
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	在 Linux 上的 VM 客體修補中，指定修補程式模式 AutomaticByPlatform 的其他設定。
patchMode	LinuxVMGuestPatchMode	將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。可能的值為： ImageDefault - 會使用虛擬機的預設修補組態。 AutomaticByPlatform - 虛擬機將由平台自動更新。屬性 provisionVMAgent 必須為 true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。

名稱	類型	Description
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

指定在Linux修補程式設定中選取 Patch 模式 AutomaticByPlatform 時要套用的其他設定。

名稱	類型	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	讓客戶在不意外升級的情況下排程修補
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。

LinuxVMGuestPatchMode

將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。

可能的值為：

ImageDefault - 會使用虛擬機的預設修補組態。

AutomaticByPlatform - 虛擬機將由平台自動更新。屬性 provisionVMAgent 必須為 true

名稱	類型	Description
AutomaticByPlatform	string
ImageDefault	string

Mode

指定如果啟用此功能，ProxyAgent 將會在上執行的模式。 ProxyAgent 會開始稽核或監視，但不會在稽核模式中對主機端點的要求強制執行訪問控制，而在 [強制執行模式] 中，則會強制執行訪問控制。默認值為 [強制] 模式。

名稱	類型	Description
Audit	string
Enforce	string

NetworkApiVersion

會指定在具有協調流程模式「彈性」的虛擬機擴展集網路介面組態中建立網路資源時所使用的Microsoft.Network API 版本

名稱	類型	Description
2020-11-01	string

NetworkInterfaceAuxiliaryMode

指定是否為網路介面資源啟用輔助模式。

名稱	類型	Description
AcceleratedConnections	string
Floating	string
None	string

NetworkInterfaceAuxiliarySku

指定是否為網路介面資源啟用輔助 SKU。

名稱	類型	Description
A1	string
A2	string
A4	string
A8	string
None	string

OperatingSystemTypes

此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。可能的值為：Windows、Linux。

名稱	類型	Description
Linux	string
Windows	string

OrchestrationMode

指定虛擬機擴展集的協調流程模式。

名稱	類型	Description
Flexible	string
Uniform	string

OSImageNotificationProfile

名稱	類型	Description
enable	boolean	指定是否啟用或停用OS映像排程事件。
notBeforeTimeout	string	虛擬機重新映像或升級其操作系統的時間長度，在事件自動核准之前，必須核准OS映射排程事件（逾時）。設定是以 ISO 8601 格式指定，且值必須是 15 分鐘（PT15M）

PassNames

傳遞名稱。目前唯一允許的值是 OobeSystem。

名稱	類型	Description
OobeSystem	string

PatchSettings

指定與 Windows 上的 VM 客體修補相關的設定。

名稱	類型	Description
assessmentMode	WindowsPatchAssessmentMode	指定 IaaS 虛擬機的 VM 客體修補評估模式。可能的值為： ImageDefault - 您可以在虛擬機上控制修補程式評估的時間。 AutomaticByPlatform - 平台將觸發定期修補程序評估。屬性 provisionVMAgent 必須為 true。
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	指定 Windows 上 VM 客體修補中的 Patch 模式 AutomaticByPlatform 的其他設定。
enableHotpatching	boolean	可讓客戶修補其 Azure VM，而不需要重新啟動。針對 enableHotpatching，'provisionVMAgent' 必須設定為 true，且 'patchMode' 必須設定為 'AutomaticByPlatform'。
patchMode	WindowsVMGuestPatchMode	將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。可能的值為：手動 - 您可以控制將修補程式的應用程式套用至虛擬機。您可以手動在 VM 內套用修補程式來執行此動作。在此模式中，會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false AutomaticByOS - 作業系統會自動更新虛擬機。屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。 AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true

Plan

指定用來建立虛擬機之 Marketplace 映像的相關信息。此元素僅用於市集映像。您必須先啟用映像以程序設計方式使用，才能從 API 使用市集映射。在 Azure 入口網站中，尋找您想要使用的市集映像，然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。輸入任何必要資訊，然後按下 [儲存]。

名稱	類型	Description
name	string	方案標識碼。
product	string	指定來自市集的映像產品。這個值與 imageReference 元素下的 Offer 值相同。
promotionCode	string	促銷碼。
publisher	string	發行者標識碼。

PriorityMixPolicy

指定具有彈性協調流程模式之擴展集內 Spot 和一般優先順序 VM 的目標分割。有了這個屬性，客戶就能夠指定建立為 VMSS flex 實例的一般優先順序 VM 基數，以及達到此基底目標之後，Spot 和 Regular 優先順序 VM 之間的分割。

名稱	類型	Description
baseRegularPriorityCount	integer	將在此擴展集中建立之一般優先順序 VM 的基數，因為它會相應放大。
regularPriorityPercentageAboveBase	integer	達到基底一般優先順序計數之後，VM 實例的百分比預期會使用一般優先順序。

ProtocolTypes

指定 WinRM 接聽程式的通訊協定。可能的值為：HTTP、https。

名稱	類型	Description
Http	string
Https	string

ProxyAgentSettings

在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限：2023-09-01。

名稱	類型	Description
enabled	boolean	指定是否應在虛擬機或虛擬機擴展集上啟用 ProxyAgent 功能。
keyIncarnationId	integer	增加此屬性的值可讓使用者重設用來保護客體與主機之間通道的密鑰。
mode	Mode	指定如果啟用此功能，ProxyAgent 將會在上執行的模式。 ProxyAgent 會開始稽核或監視，但不會在稽核模式中對主機端點的要求強制執行訪問控制，而在 [強制執行模式] 中，則會強制執行訪問控制。默認值為 [強制] 模式。

PublicIPAddressSku

描述公用IP Sku。它只能將 OrchestrationMode 設定為彈性。

名稱	類型	Description
name	PublicIPAddressSkuName	指定公用IP SKU 名稱
tier	PublicIPAddressSkuTier	指定公用IP SKU層

PublicIPAddressSkuName

指定公用IP SKU 名稱

名稱	類型	Description
Basic	string
Standard	string

PublicIPAddressSkuTier

指定公用IP SKU層

名稱	類型	Description
Global	string
Regional	string

RepairAction

將用於修復擴展集中狀況不良虛擬機的修復動作類型（取代、重新啟動、重新安裝映像）。預設值為 replace。

名稱	類型	Description
Reimage	string
Replace	string
Restart	string

ResiliencyPolicy

描述復原原則 - resiliencVMCreationPolicy 和/或 resiliencVMDeletionPolicy。

名稱	類型	Description
resilientVMCreationPolicy	ResilientVMCreationPolicy	執行復原 VM 建立時所使用的組態參數。
resilientVMDeletionPolicy	ResilientVMDeletionPolicy	執行復原 VM 刪除時所使用的組態參數。

ResilientVMCreationPolicy

執行復原 VM 建立時所使用的組態參數。

名稱	類型	Description
enabled	boolean	指定是否應在虛擬機擴展集上啟用復原 VM 建立。默認值為 false。

ResilientVMDeletionPolicy

執行復原 VM 刪除時所使用的組態參數。

名稱	類型	Description
enabled	boolean	指定是否應在虛擬機擴展集上啟用復原性 VM 刪除。默認值為 false。

ResourceIdentityType

用於虛擬機擴展集的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機擴展集移除任何身分識別。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

名稱	類型	Description
enableCrossZoneUpgrade	boolean	允許 VMSS 在建構升級批次時忽略 AZ 界限。將 Update 網域和 maxBatchInstancePercent 納入考慮，以判斷批次大小。
maxBatchInstancePercent	integer	一個批次中滾動升級同時升級的虛擬機實例總數上限百分比。由於這是最大值，先前或未來批次中狀況不良的實例可能會導致批次中的實例百分比降低，以確保更高的可靠性。此參數預設值為 20%。
maxSurge	boolean	建立新的虛擬機來升級擴展集，而不是更新現有的虛擬機。建立每個批次的新虛擬機之後，將會刪除現有的虛擬機。
maxUnhealthyInstancePercent	integer	擴展集中可同時狀況不良的虛擬機實例總數百分比上限，可能是因為升級而造成狀況不良，或在滾動升級中止之前，在虛擬機健康情況檢查中發現狀況不良狀態。啟動任何批次之前，會先檢查此條件約束。此參數預設值為 20%。
maxUnhealthyUpgradedInstancePercent	integer	可發現處於狀況不良狀態的已升級虛擬機實例百分比上限。升級每個批次之後，就會進行這項檢查。如果超過這個百分比，滾動更新就會中止。此參數預設值為 20%。
pauseTimeBetweenBatches	string	完成一個批次中所有虛擬機的更新，以及開始下一個批次之間的等候時間。持續時間應以 ISO 8601 格式指定。預設值為 0 秒（PT0S）。
prioritizeUnhealthyInstances	boolean	在任何狀況良好的實例之前，升級擴展集中所有狀況不良的實例。
rollbackFailedInstancesOnPolicyBreach	boolean	如果違反滾動升級原則，回復實例至先前的模型。

ScaleInPolicy

描述虛擬機擴展集的相應縮小原則。

名稱	類型	Description
forceDeletion	boolean	此屬性可讓您指定在虛擬機擴展集相應縮小時，是否必須強制刪除選擇移除的虛擬機。（預覽中的功能）
rules	VirtualMachineScaleSetScaleInRules[]	調整虛擬機擴展集時要遵循的規則。可能的值為：預設當虛擬機擴展集相應縮小時，如果擴展集是區域性擴展集，則擴展集會先跨區域平衡。然後，它會盡可能跨容錯網域進行平衡。在每個容錯網域內，選擇移除的虛擬機將會是不受相應縮小保護的最新虛擬機。 OldestVM 當虛擬機擴展集相應縮小時，將會選擇未受相應縮小保護的最舊虛擬機進行移除。針對區域性虛擬機擴展集，擴展集會先跨區域進行平衡。在每個區域內，將會選擇未受保護的最舊虛擬機來移除。 NewestVM 當虛擬機擴展集相應縮小時，將會選擇未受相應縮小保護的最新虛擬機來移除。針對區域性虛擬機擴展集，擴展集會先跨區域進行平衡。在每個區域內，將會選擇未受保護的最新虛擬機來移除。

ScheduledEventsAdditionalPublishingTargets

名稱	類型	Description
eventGridAndResourceGraph	EventGridAndResourceGraph	建立 eventGridAndResourceGraph Scheduled Event 設定時所使用的組態參數。

ScheduledEventsPolicy

指定重新部署、重新啟動和 ScheduledEventsAdditionalPublishingTargets Scheduled 事件相關組態。

名稱	類型	Description
scheduledEventsAdditionalPublishingTargets	ScheduledEventsAdditionalPublishingTargets	發佈 scheduledEventsAdditionalPublishingTargets 時所使用的組態參數。
userInitiatedReboot	UserInitiatedReboot	建立 userInitiatedReboot 排程事件設定建立時所使用的組態參數。
userInitiatedRedeploy	UserInitiatedRedeploy	建立 userInitiatedRedeploy 排程事件設定建立時所使用的組態參數。

ScheduledEventsProfile

名稱	類型	Description
osImageNotificationProfile	OSImageNotificationProfile	指定OS映像排程事件相關組態。
terminateNotificationProfile	TerminateNotificationProfile	指定終止已排程的事件相關組態。

securityEncryptionTypes

指定受控磁碟的 EncryptionType。它會設定為 DiskWithVMGuestState 來加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly，以便只加密 VMGuestState Blob，以及 NonPersistedTPM 以在 VMGuestState blob 中保存韌體狀態。 注意： 只能設定機密 VM。

名稱	類型	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityPostureReference

指定要在擴展集中使用的安全性狀態。 API 版本下限：2023-03-01

名稱	類型	Description
excludeExtensions	string[]	套用安全性狀態時要排除的虛擬機擴充功能名稱清單。
id	string	安全性狀態參考標識符的格式為 /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}\|latest
isOverridable	boolean	使用者是否可以覆寫安全性狀態。

SecurityProfile

指定虛擬機或虛擬機擴展集的安全性配置檔設定。

名稱	類型	Description
encryptionAtHost	boolean	用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。默認行為為：除非資源將此屬性設定為 true，否則將會停用主機的加密。
encryptionIdentity	EncryptionIdentity	指定 ADE 用來取得金鑰保存庫作業存取令牌的受控識別。
proxyAgentSettings	ProxyAgentSettings	在建立虛擬機時指定 ProxyAgent 設定。 API 版本下限：2023-09-01。
securityType	SecurityTypes	指定虛擬機的 SecurityType。它必須設定為任何指定的值，才能啟用 UefiSettings。默認行為為：除非設定此屬性，否則不會啟用 UefiSettings。
uefiSettings	UefiSettings	指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限：2020-12-01。

SecurityTypes

指定虛擬機的 SecurityType。它必須設定為任何指定的值，才能啟用 UefiSettings。默認行為為：除非設定此屬性，否則不會啟用 UefiSettings。

名稱	類型	Description
ConfidentialVM	string
TrustedLaunch	string

ServiceArtifactReference

指定使用 'latest' 映射版本時，用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。 API 版本下限：2022-11-01

名稱	類型	Description
id	string	服務成品參考標識符的格式為 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

SettingNames

指定套用內容之設定的名稱。可能的值為：FirstLogonCommands 和 AutoLogon。

名稱	類型	Description
AutoLogon	string
FirstLogonCommands	string

Sku

描述虛擬機擴展集 SKU。注意：如果擴展集目前所在的硬體上不支援新的 VM SKU，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。

名稱	類型	Description
capacity	integer	指定擴展集中的虛擬機數目。
name	string	SKU 名稱。
tier	string	指定擴展集中虛擬機的層級。可能的值： Standard 基本

SkuProfile

指定虛擬機擴展集的 SKU 配置檔。有了此屬性，客戶就能夠指定 VM 大小清單和配置策略。

名稱	類型	Description
allocationStrategy	AllocationStrategy	指定虛擬機擴展集的配置策略，根據虛擬機的配置策略進行配置。
vmSizes	SkuProfileVMSize[]	指定虛擬機擴展集的 VM 大小。

SkuProfileVMSize

指定 VM 大小。

名稱	類型	Description
name	string	指定 VM 大小的名稱。

SpotRestorePolicy

指定虛擬機擴展集的Spot-Try-Restore 屬性。透過此屬性，客戶可以根據容量可用性和定價限制，以機會方式啟用或停用收回的Spot VMSS VM 實例的自動還原。

名稱	類型	Description
enabled	boolean	啟用 Spot-Try-Restore 功能，其中將嘗試根據容量可用性和定價限制，以機會方式還原收回的 VMSS SPOT 實例
restoreTimeout	string	以 ISO 8601 時間持續時間表示的逾時值，之後平臺不會嘗試還原 VMSS SPOT 實例

SshConfiguration

在 Azure 上執行的 Linux 型 VM 的 SSH 設定

名稱	類型	Description
publicKeys	SshPublicKey[]	用來向Linux型VM進行驗證的SSH公鑰清單。

SshPublicKey

包含 SSH 憑證公鑰的相關信息，以及放置公鑰之 Linux VM 上的路徑。

名稱	類型	Description
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	指定已建立 VM 上儲存 SSH 公鑰的完整路徑。如果檔案已經存在，指定的索引鍵會附加至檔案。範例：/home/user/.ssh/authorized_keys

StorageAccountTypes

指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。

名稱	類型	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

名稱	類型	Description
id	string	資源標識碼

TerminateNotificationProfile

名稱	類型	Description
enable	boolean	指定是否啟用或停用終止排程事件。
notBeforeTimeout	string	刪除虛擬機的可設定時間長度，在事件自動核准之前，必須先核准終止排程事件（逾時）。設定必須以 ISO 8601 格式指定，預設值為 5 分鐘（PT5M）

UefiSettings

指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 API 版本下限：2020-12-01。

名稱	類型	Description
secureBootEnabled	boolean	指定是否應在虛擬機上啟用安全開機。 API 版本下限：2020-12-01。
vTpmEnabled	boolean	指定是否應在虛擬機上啟用 vTPM。 API 版本下限：2020-12-01。

UpgradeMode

指定升級至擴展集中虛擬機的模式。

可能的值為：

手動 - 您可以控制擴充集中虛擬機的更新應用程式。您可以使用 manualUpgrade 動作來執行此動作。

自動 - 擴展集中的所有虛擬機都會同時自動更新。

名稱	類型	Description
Automatic	string
Manual	string
Rolling	string

UpgradePolicy

描述升級原則 - 自動、手動或滾動。

名稱	類型	Description
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	用於執行自動OS升級的組態參數。
mode	UpgradeMode	指定升級至擴展集中虛擬機的模式。可能的值為：手動 - 您可以控制擴充集中虛擬機的更新應用程式。您可以使用 manualUpgrade 動作來執行此動作。自動 - 擴展集中的所有虛擬機都會同時自動更新。
rollingUpgradePolicy	RollingUpgradePolicy	執行滾動升級時所使用的組態參數。

UserAssignedIdentities

與虛擬機相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱	類型	Description

UserInitiatedReboot

指定重新啟動相關的排程事件相關組態。

名稱	類型	Description
automaticallyApprove	boolean	指定重新啟動排程的事件相關組態。

UserInitiatedRedeploy

指定重新部署相關的排程事件相關組態。

名稱	類型	Description
automaticallyApprove	boolean	指定重新部署排程的事件相關組態。

VaultCertificate

描述 Key Vault 中的單一憑證參考，以及憑證應該位於 VM 上的位置。

名稱	類型	Description
certificateStore	string	針對 Windows VM，指定應新增憑證之虛擬機上的證書存儲。指定的證書存儲隱含在 LocalMachine 帳戶中。針對 Linux VM，憑證檔案會放在 /var/lib/waagent 目錄底下，檔名 <X509 憑證檔案的大寫Thumbprint>.crt，並針對私鑰 <大寫Thumbprint>.prv。這兩個檔案都是 .pem 格式。
certificateUrl	string	這是已上傳至 Key Vault 做為秘密之憑證的 URL。如需將秘密新增至 Key Vault，請參閱將金鑰或秘密新增至金鑰保存庫。在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8： { “data”：“”， “dataType”：“pfx”， “password”：“” } 若要在虛擬機上安裝憑證，建議使用適用於Linux 的 Azure Key Vault 虛擬機擴充功能，或適用於Windows的 Azure Key Vault 虛擬機擴充功能。

VaultSecretGroup

描述一組憑證，這些憑證全都位於相同的Key Vault 中。

名稱	類型	Description
sourceVault	SubResource	Key Vault 的相對 URL，其中包含 VaultCertificates 中的所有憑證。
vaultCertificates	VaultCertificate[]	SourceVault 中包含憑證的金鑰保存庫參考清單。

VirtualHardDisk

描述磁碟的 URI。

名稱	類型	Description
uri	string	指定虛擬硬碟的 URI。

VirtualMachineEvictionPolicyTypes

指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。針對 Azure Spot 虛擬機，支援「解除分配」和「刪除」，且最低 API 版本為 2019-03-01。針對 Azure Spot 擴展集，支援「解除分配」和「刪除」，且最低 API 版本為 2017-10-30-preview。

名稱	類型	Description
Deallocate	string
Delete	string

VirtualMachinePriorityTypes

指定擴展集中虛擬機的優先順序。 API 版本下限：2017-10-30-preview。

名稱	類型	Description
Low	string
Regular	string
Spot	string

VirtualMachineScaleSet

描述虛擬機擴展集。

名稱	類型	Description
etag	string	Etag 是在 VMSS 的 Create/Update/Get 回應中傳回的屬性，讓客戶可以在標頭中提供它，以確保開放式更新
extendedLocation	ExtendedLocation	虛擬機擴展集的擴充位置。
id	string	資源標識碼
identity	VirtualMachineScaleSetIdentity	如果已設定，則為虛擬機擴展集的身分識別。
location	string	資源位置
name	string	資源名稱
plan	Plan	指定用來建立虛擬機之 Marketplace 映像的相關信息。此元素僅用於市集映像。您必須先啟用映像以程序設計方式使用，才能從 API 使用市集映射。在 Azure 入口網站中，尋找您想要使用的市集映像，然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。輸入任何必要資訊，然後按下 [儲存]。
properties.additionalCapabilities	AdditionalCapabilities	指定在虛擬機擴展集的虛擬機上啟用或停用的其他功能。例如：虛擬機是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。
properties.automaticRepairsPolicy	AutomaticRepairsPolicy	自動修復的原則。
properties.constrainedMaximumCapacity	boolean	必須設定為 True 或省略的選擇性屬性。
properties.doNotRunExtensionsOnOverprovisionedVMs	boolean	啟用 Overprovision 時，只會在最後保留的要求 VM 數目上啟動擴充功能。因此，這個屬性可確保延伸模組不會在額外的過度布建 VM 上執行。
properties.hostGroup	SubResource	指定虛擬機擴展集所在專用主機群組的相關信息。 API 版本下限：2020-06-01。
properties.orchestrationMode	OrchestrationMode	指定虛擬機擴展集的協調流程模式。
properties.overprovision	boolean	指定虛擬機擴展集是否應該過度布建。
properties.platformFaultDomainCount	integer	每個放置群組的容錯網域計數。
properties.priorityMixPolicy	PriorityMixPolicy	指定在相同 VMSS Flex 實例內混合 Spot 和一般優先順序 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	指定虛擬機擴展集的Spot Restore 屬性。
properties.timeCreated	string	指定建立虛擬機擴展集資源的時間。 API 版本下限：2021-11-01。
properties.uniqueId	string	指定可唯一識別虛擬機擴展集的標識碼。
properties.upgradePolicy	UpgradePolicy	升級原則。
properties.virtualMachineProfile	VirtualMachineScaleSetVMProfile	虛擬機器配置檔。
properties.zonalPlatformFaultDomainAlignMode	ZonalPlatformFaultDomainAlignMode	指定虛擬機擴展集計算與記憶體容錯網域計數之間的對齊模式。
properties.zoneBalance	boolean	如果發生區域中斷，是否要強制甚至虛擬機散發跨 x 區域。只有在擴展集的區域屬性包含多個區域時，才能設定 zoneBalance 屬性。如果沒有區域或只有一個指定區域，則不應該設定 zoneBalance 屬性。
sku	Sku	虛擬機擴展集 SKU。
tags	object	資源標籤
type	string	資源類型
zones	string[]	虛擬機擴展集區域。

VirtualMachineScaleSetDataDisk

描述虛擬機擴展集數據磁碟。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設值為：標準記憶體的 None。進階記憶體的 ReadOnly。
createOption	DiskCreateOptionTypes	create 選項。
deleteOption	DiskDeleteOptionTypes	指定數據磁碟應該在 VMSS Flex 刪除時刪除或中斷連結（此功能僅適用於具有彈性 OrchestrationMode 的 VMSS）。可能的值：刪除如果使用此值，則會在刪除 VMSS Flex VM 時刪除資料磁碟。卸離如果使用此值，則會在刪除 VMSS Flex VM 之後保留數據磁碟。預設值設定為 Delete。
diskIOPSReadWrite	integer	指定受控磁碟 Read-Write IOPS。只有當 StorageAccountType UltraSSD_LRS時，才應該使用。如果未指定，則會根據diskSizeGB指派預設值。
diskMBpsReadWrite	integer	指定受控磁碟每秒 MB 的頻寬。只有當 StorageAccountType UltraSSD_LRS時，才應該使用。如果未指定，則會根據diskSizeGB指派預設值。
diskSizeGB	integer	指定以 GB 為單位的空白資料磁碟大小。這個元素可用來覆寫虛擬機映像中的磁碟大小。 diskSizeGB 屬性是磁碟的位元組 x 1024^3，且值不能大於 1023。
lun	integer	指定數據磁碟的邏輯單元編號。這個值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	受控磁碟參數。
name	string	磁碟名稱。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

VirtualMachineScaleSetExtension

描述虛擬機擴展集擴充功能。

名稱	類型	Description
id	string	資源標識碼
name	string	延伸模組的名稱。
properties.autoUpgradeMinorVersion	boolean	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。
properties.enableAutomaticUpgrade	boolean	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。
properties.forceUpdateTag	string	如果提供值，且與先前的值不同，即使延伸模組組態尚未變更，擴充處理程式仍會強制更新。
properties.protectedSettings	object	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用
properties.provisionAfterExtensions	string[]	必須布建此延伸模組之後的延伸模組名稱集合。
properties.provisioningState	string	只出現在回應中的布建狀態。
properties.publisher	string	擴充處理程序發行者的名稱。
properties.settings	object	擴充功能的 Json 格式化公用設定。
properties.suppressFailures	boolean	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。默認值為 false。
properties.type	string	指定延伸模組的類型;例如“CustomScriptExtension”。
properties.typeHandlerVersion	string	指定文稿處理程式的版本。
type	string	資源類型

VirtualMachineScaleSetExtensionProfile

描述虛擬機擴展集擴充功能配置檔。

名稱	類型	Description
extensions	VirtualMachineScaleSetExtension[]	虛擬機擴展集子擴充功能資源。
extensionsTimeBudget	string	指定所有延伸模組要啟動的時間。持續時間應介於 15 分鐘到 120 分鐘之間（含），且應以 ISO 8601 格式指定。預設值為90分鐘（PT1H30M）。 API 版本下限：2020-06-01。

VirtualMachineScaleSetHardwareProfile

指定虛擬機擴展集的硬體設定。

名稱	類型	Description
vmSizeProperties	VMSizeProperties	指定自定義虛擬機大小的屬性。 API 版本下限：2021-11-01。如需詳細資訊，請遵循 VM 自定義中的指示。

VirtualMachineScaleSetIdentity

虛擬機擴展集的身分識別。

名稱	類型	Description
principalId	string	虛擬機擴展集身分識別的主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	與虛擬機擴展集相關聯的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於虛擬機擴展集的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從虛擬機擴展集移除任何身分識別。
userAssignedIdentities	UserAssignedIdentities	與虛擬機擴展集相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

VirtualMachineScaleSetIPConfiguration

描述虛擬機擴展集網路配置檔的IP組態。

名稱	類型	Description
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

包含與公用IP位址相關聯的IP標籤。

名稱	類型	Description
ipTagType	string	IP 標籤類型。範例：FirstPartyUsage。
tag	string	與公用IP相關聯的IP標籤。範例：SQL、記憶體等。

VirtualMachineScaleSetManagedDiskParameters

描述 ScaleSet 受控磁碟的參數。

名稱	類型	Description
diskEncryptionSet	DiskEncryptionSetParameters	指定受控磁碟的客戶受控磁碟加密集資源標識符。
securityProfile	VMDiskSecurityProfile	指定受控磁碟的安全性配置檔。
storageAccountType	StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。

VirtualMachineScaleSetNetworkConfiguration

描述虛擬機擴展集網路配置檔的網路組態。

名稱	類型	Description
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個以上的網路介面時的主要網路介面。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

描述虛擬機擴展集網路組態的 DNS 設定。

名稱	類型	Description
dnsServers	string[]	DNS 伺服器 IP 位址清單

VirtualMachineScaleSetNetworkProfile

描述虛擬機擴展集網路配置檔。

名稱	類型	Description
healthProbe	ApiEntityReference	負載平衡器探查的參考，用來判斷虛擬機擴展集中實例的健康情況。參考的格式為：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'。
networkApiVersion	NetworkApiVersion	會指定在具有協調流程模式「彈性」的虛擬機擴展集網路介面組態中建立網路資源時所使用的Microsoft.Network API 版本
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	網路組態的清單。

VirtualMachineScaleSetOSDisk

描述虛擬機擴展集作業系統磁碟。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設值為：標準記憶體的 None。進階記憶體的 ReadOnly。
createOption	DiskCreateOptionTypes	指定應該如何建立擴展集中的虛擬機。唯一允許的值是：FromImage。當您使用映像來建立虛擬機時，會使用此值。如果您使用平臺映像，則也會使用上述的 imageReference 元素。如果您使用市集映像，則也會使用先前所述的 plan 元素。
deleteOption	DiskDeleteOptionTypes	指定 VMSS Flex 刪除時是否應該刪除或中斷連結 OS 磁碟（此功能僅適用於具有彈性 OrchestrationMode 的 VMSS）。可能的值：刪除如果使用此值，刪除 VMSS Flex VM 時會刪除 OS 磁碟。卸離如果使用此值，則會在刪除 VMSS Flex VM 之後保留 OS 磁碟。預設值設定為 Delete。針對暫時 OS 磁碟，預設值會設定為 [刪除]。使用者無法變更暫時 OS 磁碟的刪除選項。
diffDiskSettings	DiffDiskSettings	指定虛擬機擴展集所使用作業系統磁碟的暫時磁碟設定。
diskSizeGB	integer	指定以 GB 為單位的空白資料磁碟大小。這個元素可用來覆寫虛擬機映像中的磁碟大小。屬性 'diskSizeGB' 是磁碟的位元組 x 1024^3，值不能大於 1023。
image	VirtualHardDisk	指定要以擴展集為基礎之 Unmanaged 使用者映像的相關信息。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	受控磁碟參數。
name	string	磁碟名稱。
osType	OperatingSystemTypes	此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。可能的值為：Windows、Linux。
vhdContainers	string[]	指定用來儲存擴展集作業系統磁碟的容器 URL。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

VirtualMachineScaleSetOSProfile

描述虛擬機擴展集 OS 配置檔。

名稱	類型	Description
adminPassword	string	指定系統管理員帳戶的密碼。最小長度（Windows）： 8 個字元最小長度（Linux）： 6 個字元長度上限（Windows）： 123 個字元長度上限（Linux）： 72 個字元複雜性需求：需要滿足下列 4 個條件中的 3 個字元較低具有大字元具有數位具有特殊字元（Regex match [\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

描述虛擬機擴展集IP組態的PublicIPAddress組態

名稱	類型	Description
name	string	publicIP 位址組態名稱。
properties.deleteOption	DeleteOptions	指定刪除 VM 時，公用 IP 會發生什麼事
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	要套用至 publicIP 位址的 DNS 設定。
properties.idleTimeoutInMinutes	integer	公用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 設定為彈性。

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

描述虛擬機擴展集網路組態的 DNS 設定。

名稱	類型	Description
domainNameLabel	string	功能變數名稱標籤。功能變數名稱標籤和 VM 索引的串連將是將要建立之 PublicIPAddress 資源的功能變數名稱標籤
domainNameLabelScope	DomainNameLabelScopeTypes	功能變數名稱標籤範圍。根據功能變數名稱卷標範圍的原則所產生的哈希功能變數名稱卷標串連，VM 索引將是將要建立之 PublicIPAddress 資源的功能變數名稱卷標

VirtualMachineScaleSetScaleInRules

調整虛擬機擴展集時要遵循的規則。

可能的值為：

預設當虛擬機擴展集相應縮小時，如果擴展集是區域性擴展集，則擴展集會先跨區域平衡。然後，它會盡可能跨容錯網域進行平衡。在每個容錯網域內，選擇移除的虛擬機將會是不受相應縮小保護的最新虛擬機。

OldestVM 當虛擬機擴展集相應縮小時，將會選擇未受相應縮小保護的最舊虛擬機進行移除。針對區域性虛擬機擴展集，擴展集會先跨區域進行平衡。在每個區域內，將會選擇未受保護的最舊虛擬機來移除。

NewestVM 當虛擬機擴展集相應縮小時，將會選擇未受相應縮小保護的最新虛擬機來移除。針對區域性虛擬機擴展集，擴展集會先跨區域進行平衡。在每個區域內，將會選擇未受保護的最新虛擬機來移除。

名稱	類型	Description
Default	string
NewestVM	string
OldestVM	string

VirtualMachineScaleSetStorageProfile

描述虛擬機擴展集記憶體配置檔。

名稱	類型	Description
dataDisks	VirtualMachineScaleSetDataDisk[]	指定參數，用來將數據磁碟新增至擴展集中的虛擬機。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。
diskControllerType	DiskControllerTypes[]	指定為擴展集中虛擬機設定的磁碟控制器類型。 API 版本下限：2022-08-01
imageReference	ImageReference	指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。
osDisk	VirtualMachineScaleSetOSDisk	指定擴展集中虛擬機所使用的操作系統磁碟相關信息。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。

VirtualMachineScaleSetVMProfile

描述虛擬機擴展集虛擬機配置檔。

名稱	類型	Description
applicationProfile	ApplicationProfile	指定應該提供給 VM/VMSS 的資源庫應用程式
billingProfile	BillingProfile	指定 Azure Spot VMSS 的計費相關詳細數據。 API 版本下限：2019-03-01。
capacityReservation	CapacityReservationProfile	指定擴展集的容量保留相關詳細數據。 API 版本下限：2021-04-01。
diagnosticsProfile	DiagnosticsProfile	指定開機診斷設定狀態。 API 版本下限：2015-06-15。
evictionPolicy	VirtualMachineEvictionPolicyTypes	指定 Azure Spot 虛擬機和 Azure Spot 擴展集的收回原則。針對 Azure Spot 虛擬機，支援「解除分配」和「刪除」，且最低 API 版本為 2019-03-01。針對 Azure Spot 擴展集，支援「解除分配」和「刪除」，且最低 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 Hybrid Use Benefit 適用於Linux Server的 Azure Hybrid Use Benefit 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' 映射版本時，用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。 API 版本下限：2022-11-01
storageProfile	VirtualMachineScaleSetStorageProfile	指定虛擬機磁碟的記憶體設定。
timeCreated	string	指定建立虛擬機擴展集此 VM 設定文件的時間。建立/更新 VMSS VM 配置文件時，此值將會新增至 VMSS Flex VM 標籤。此屬性的 API 版本下限為 2023-09-01。
userData	string	擴展集中虛擬機的UserData，其必須是base-64編碼。客戶不應在此傳遞任何秘密。 API 版本下限：2021-03-01。

VMDiskSecurityProfile

指定受控磁碟的安全性配置檔設定。 注意： 只能針對機密 VM 設定。

名稱	類型	Description
diskEncryptionSet	DiskEncryptionSetParameters	針對客戶受控密鑰加密的機密VM OS 磁碟和 VMGuest Blob 所使用的受控磁碟，指定客戶受控磁碟加密集資源識別碼。
securityEncryptionType	securityEncryptionTypes	指定受控磁碟的 EncryptionType。它會設定為 DiskWithVMGuestState 來加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly，以便只加密 VMGuestState Blob，以及 NonPersistedTPM 以在 VMGuestState blob 中保存韌體狀態。注意：只能設定機密 VM。

VMGalleryApplication

指定參考計算資源庫應用程式版本的必要資訊

名稱	類型	Description
configurationReference	string	選擇性，指定 Azure Blob 的 URI，如果提供的話，將會取代套件的預設組態
enableAutomaticUpgrade	boolean	如果設定為 true，當 PIR/SIG 中提供新的資源庫應用程式版本時，VM/VMSS 會自動更新它
order	integer	選擇性，指定必須安裝套件的順序
packageReferenceId	string	指定 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/applications/{application}/versions/{version} 形式的 GalleryApplicationVersion 資源標識符
tags	string	選擇性，指定更多泛型內容的傳遞值。
treatFailureAsDeploymentFailure	boolean	選擇性，如果為 true，VmApplication 中任何作業的任何失敗都會使部署失敗

VMSizeProperties

指定虛擬機上的 VM 大小屬性設定。

名稱	類型	Description
vCPUsAvailable	integer	指定 VM 可用的 vCPU 數目。當要求本文中未指定此屬性時，預設行為是將它設定為 api 回應中公開的 vCPU 值，列出區域中所有可用的虛擬機大小。
vCPUsPerCore	integer	指定 vCPU 與實體核心比率。當要求本文中未指定此屬性時，預設行為會針對 api 回應中公開的 VM 大小設定為 vCPUUsPerCore 的值，列出區域中所有可用的虛擬機大小，。將此屬性設定為 1 也表示已停用超線程處理。

WindowsConfiguration

指定虛擬機上的 Windows 作業系統設定。

名稱	類型	Description
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

名稱	類型	Description
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。

名稱	類型	Description
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

指定在 Windows 修補程式設定中選取 Patch 模式 AutomaticByPlatform 時要套用的其他設定。

名稱	類型	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	讓客戶在不意外升級的情況下排程修補
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修補程式安裝作業的重新啟動設定。

WindowsVMGuestPatchMode

將 VM 客體修補模式指定為彈性的 IaaS 虛擬機或與虛擬機擴展集相關聯的虛擬機。

可能的值為：

手動 - 您可以控制將修補程式的應用程式套用至虛擬機。您可以手動在 VM 內套用修補程式來執行此動作。在此模式中，會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。

AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true

名稱	類型	Description
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

描述 VM 的 Windows 遠端管理設定

名稱	類型	Description
listeners	WinRMListener[]	Windows 遠端管理接聽程式清單

WinRMListener

描述 Windows 遠端管理接聽程式的通訊協議和指紋

名稱	類型	Description
certificateUrl	string	這是已上傳至 Key Vault 做為秘密之憑證的 URL。如需將秘密新增至 Key Vault，請參閱將金鑰或秘密新增至金鑰保存庫。在此情況下，您的憑證必須是以UTF-8編碼的下列 JSON 物件的Base64編碼： { “data”：“”， “dataType”：“pfx”， “password”：“” } 若要在虛擬機上安裝憑證，建議使用適用於Linux 的 Azure Key Vault 虛擬機擴充功能，或適用於Windows的 Azure Key Vault 虛擬機擴充功能。
protocol	ProtocolTypes	指定 WinRM 接聽程式的通訊協定。可能的值為：HTTP、https。

ZonalPlatformFaultDomainAlignMode

指定虛擬機擴展集計算與記憶體容錯網域計數之間的對齊模式。

名稱	類型	Description
Aligned	string
Unaligned	string

共用方式為

Virtual Machine Scale Sets - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

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

範例要求

範例回覆

定義

AdditionalCapabilities

AdditionalUnattendContent

AllocationStrategy

ApiEntityReference

ApiError

ApiErrorBase

ApplicationProfile

AutomaticOSUpgradePolicy

AutomaticRepairsPolicy

BillingProfile

BootDiagnostics

CachingTypes

CapacityReservationProfile

CloudError

ComponentNames

DeleteOptions

DiagnosticsProfile

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskEncryptionSetParameters

DomainNameLabelScopeTypes

EncryptionIdentity

EventGridAndResourceGraph

ExpandTypesForGetVMScaleSets

ExtendedLocation

ExtendedLocationTypes

ImageReference

InnerError

IPVersion

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

Mode

NetworkApiVersion

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku

OperatingSystemTypes

OrchestrationMode

OSImageNotificationProfile

PassNames

PatchSettings

Plan

PriorityMixPolicy

ProtocolTypes

ProxyAgentSettings

PublicIPAddressSku

PublicIPAddressSkuName

PublicIPAddressSkuTier

RepairAction

ResiliencyPolicy

ResilientVMCreationPolicy