Virtual Machine Scale Sets - Get

リファレンス

サービス:: Compute

API バージョン:: 2024-03-01

仮想マシンスケールセットに関する情報を表示します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
vmScaleSetName	path	True	string	VM スケールセットの名前。
api-version	query	True	string	クライアント API のバージョン。
$expand	query		ExpandTypesForGetVMScaleSets	操作に適用する展開式。 'UserData' は、VM スケールセットの作成/更新操作中にユーザーによって提供された VM スケールセットの UserData プロパティを取得します

応答

名前	型	説明
200 OK	VirtualMachineScaleSet	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get a virtual machine scale set

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

Get a virtual machine scale set with UserData

Get VM scale set VM with Disk Controller Type

Get a virtual machine scale set

要求のサンプル

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


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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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-03-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

応答のサンプル

状態コード:: 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-03-01&$expand=userData


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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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-03-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

応答のサンプル

状態コード:: 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-03-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-03-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-03-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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-03-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

応答のサンプル

状態コード:: 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-03-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-03-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-03-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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-03-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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
AdditionalCapabilities	仮想マシンまたは仮想マシンスケールセットの機能を有効または無効にします。
AdditionalUnattendContent	Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の XML 形式の情報を指定します。コンテンツは、設定名、コンポーネント名、およびコンテンツが適用されるパスによって定義されます。
ApiEntityReference	API エンティティ参照。
ApiError	API エラー。
ApiErrorBase	API エラーベース。
ApplicationProfile	VM/VMSS で使用できるようにする必要があるギャラリーアプリケーションの一覧が含まれています
AutomaticOSUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。
AutomaticRepairsPolicy	仮想マシンスケールセットでの自動修復の構成パラメーターを指定します。
BillingProfile	Azure スポット VM または VMSS の課金関連の詳細を指定します。最小 API バージョン: 2019-03-01。
BootDiagnostics	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。
CachingTypes	キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。既定値は、Standard Storage None です。Premium Storage の ReadOnly。
CapacityReservationProfile	容量予約プロファイルのパラメーター。
CloudError	コンピューティングサービスからのエラー応答。
ComponentNames	コンポーネント名。現在、許容される値は Microsoft-Windows-Shell-Setup のみです。
DeleteOptions	VM が削除されたときのパブリック IP の動作を指定する
DiagnosticsProfile	ブート診断設定の状態を指定します。最小 API バージョン: 2015-06-15。
DiffDiskOptions	オペレーティングシステムディスクのエフェメラルディスク設定を指定します。
DiffDiskPlacement	オペレーティングシステムディスクのエフェメラルディスクの配置を指定します。このプロパティは、要求のユーザーが、エフェメラル OS ディスクプロビジョニング用のキャッシュディスク、リソースディスク、または nvme ディスク領域などの場所を選択するために使用できます。エフェメラル OS ディスクサイズの要件の詳細については、https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements の Windows VM と https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsの Linux VM のエフェメラル OS ディスクサイズの要件に関するページを参照してください。 NvmeDisk の最小 API バージョン: 2024-03-01。
DiffDiskSettings	オペレーティングシステムディスクに指定できるエフェメラルディスク設定のパラメーターについて説明します。注: エフェメラルディスクの設定は、マネージドディスクに対してのみ指定できます。
DiskControllerTypes
DiskCreateOptionTypes	スケールセット内の仮想マシンの作成方法を指定します。使用できる値は、FromImage のみです。この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、前述の imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。
DiskDeleteOptionTypes	VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブルオーケストレーションモードの VMSS でのみ使用できます)。使用可能な値: 削除この値を使用すると、VMSS Flex VM が削除されるときに OS ディスクが削除されます。デタッチこの値を使用すると、VMSS Flex VM が削除された後も OS ディスクが保持されます。既定値は Deleteに設定されます。エフェメラル OS ディスクの場合、既定値は Deleteに設定されます。ユーザーはエフェメラル OS ディスクの削除オプションを変更できません。
DiskEncryptionSetParameters	ディスクに指定できるカスタマーマネージドディスク暗号化セットのリソース ID のパラメーターについて説明します。注: ディスク暗号化セットのリソース ID は、マネージドディスクに対してのみ指定できます。詳細については、https://aka.ms/mdssewithcmkoverview を参照してください。
DomainNameLabelScopeTypes	ドメイン名ラベルスコープ。ドメイン名ラベルスコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。
EncryptionIdentity	キーコンテナー操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。
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 パッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。
LinuxVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲストパッチ適用のモードを指定します。使用可能な値は次のとおりです。 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 portal で、使用するマーケットプレースイメージを見つけて、[プログラムでデプロイする ] をクリック>。必要な情報を入力し、[保存クリックします。
PriorityMixPolicy	柔軟なオーケストレーションモードのスケールセット内のスポットおよび標準の優先度 VM のターゲット分割を指定します。このプロパティを使用すると、VMSS flex インスタンスのスケールアウト時に作成される通常の優先順位 VM の基本数と、このベースターゲットに到達した後のスポットと通常の優先度の VM の間の分割を指定できます。
ProtocolTypes	WinRM リスナーのプロトコルを指定します。指定できる値は、http 、httpsです。
ProxyAgentSettings	仮想マシンの作成時に ProxyAgent の設定を指定します。最小 API バージョン: 2024-03-01。
PublicIPAddressSku	パブリック IP SKU について説明します。 OrchestrationMode をフレキシブルとしてのみ設定できます。
PublicIPAddressSkuName	パブリック IP SKU 名を指定する
PublicIPAddressSkuTier	パブリック IP SKU レベルを指定する
RepairAction	スケールセット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。既定値は replace です。
ResiliencyPolicy	回復性ポリシー (resilientVMCreationPolicy または resilientVMDeletionPolicy) について説明します。
ResilientVMCreationPolicy	回復性のある VM の作成の実行中に使用される構成パラメーター。
ResilientVMDeletionPolicy	回復性のある VM 削除の実行中に使用される構成パラメーター。
ResourceIdentityType	仮想マシンスケールセットに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンスケールセットからすべての ID を削除します。
RollingUpgradePolicy	ローリングアップグレードの実行中に使用される構成パラメーター。
ScaleInPolicy	仮想マシンスケールセットのスケールインポリシーについて説明します。
ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy	Redeploy、Reboot、ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations を指定します。
ScheduledEventsProfile
securityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクの暗号化を行う場合は DiskWithVMGuestState、VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定できます。
SecurityPostureReference	スケールセットで使用するセキュリティ体制を指定します。最小 API バージョン: 2023-03-01
SecurityProfile	仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。
ServiceArtifactReference	"最新" イメージバージョンを使用する場合に、スケールセット内のすべての仮想マシンに同じイメージバージョンを設定するために使用されるサービス成果物参照 ID を指定します。最小 API バージョン: 2022-11-01
SettingNames	コンテンツが適用される設定の名前を指定します。指定できる値は、FirstLogonCommands と AutoLogon です。
Sku	仮想マシンスケールセット SKU について説明します。注: スケールセットが現在オンになっているハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケールセット内の VM の割り当てを解除する必要があります。
SpotRestorePolicy	仮想マシンスケールセットのスポットTry-Restore プロパティを指定します。このプロパティを使用すると、お客様は、容量の可用性と価格の制約に基づいて、削除されたスポット 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	仮想マシンに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。
UserInitiatedReboot	再起動関連のスケジュールされたイベント関連の構成を指定します。
UserInitiatedRedeploy	再デプロイ関連のスケジュールされたイベント関連の構成を指定します。
VaultCertificate	Key Vault 内の 1 つの証明書参照と、証明書が VM 上に存在する場所について説明します。
VaultSecretGroup	すべて同じ Key Vault 内にある証明書のセットについて説明します。
VirtualHardDisk	ディスクの URI について説明します。
VirtualMachineEvictionPolicyTypes	Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。 Azure Spot 仮想マシンでは、"割り当て解除" と "削除" の両方がサポートされており、最小 API バージョンは 2019-03-01 です。 Azure スポットスケールセットの場合、"割り当て解除" と "削除" の両方がサポートされ、最小 API バージョンは 2017-10-30-preview です。
VirtualMachinePriorityTypes	スケールセット内の仮想マシンの優先順位を指定します。最小 API バージョン: 2017-10-30-preview。
VirtualMachineScaleSet	仮想マシンスケールセットについて説明します。
VirtualMachineScaleSetDataDisk	仮想マシンスケールセットのデータディスクについて説明します。
VirtualMachineScaleSetExtension	仮想マシンスケールセット拡張機能について説明します。
VirtualMachineScaleSetExtensionProfile	仮想マシンスケールセット拡張機能プロファイルについて説明します。
VirtualMachineScaleSetHardwareProfile	仮想マシンスケールセットのハードウェア設定を指定します。
VirtualMachineScaleSetIdentity	仮想マシンスケールセットの ID。
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 のパッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。
WindowsVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲストパッチ適用のモードを指定します。使用可能な値は次のとおりです。手動 - 仮想マシンへのパッチの適用を制御します。これを行うには、VM 内でパッチを手動で適用します。このモードでは、自動更新は無効になります。プロパティ WindowsConfiguration.enableAutomaticUpdates は false にする必要があります AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。プロパティ WindowsConfiguration.enableAutomaticUpdates は true である必要があります。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。 provisionVMAgent プロパティと WindowsConfiguration.enableAutomaticUpdates プロパティは true である必要があります
WinRMConfiguration	VM の Windows リモート管理の構成について説明します
WinRMListener	Windows リモート管理リスナーのプロトコルと拇印について説明します

AdditionalCapabilities

仮想マシンまたは仮想マシンスケールセットの機能を有効または無効にします。

名前	型	説明
hibernationEnabled	boolean	VM の休止機能を有効または無効にするフラグ。
ultraSSDEnabled	boolean	VM または VMSS でストレージアカウントの種類がUltraSSD_LRSされた 1 つ以上のマネージドデータディスクを持つ機能を有効または無効にするフラグ。ストレージアカウントの種類がUltraSSD_LRSマネージドディスクは、このプロパティが有効になっている場合にのみ、仮想マシンまたは仮想マシンスケールセットに追加できます。

AdditionalUnattendContent

Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の XML 形式の情報を指定します。コンテンツは、設定名、コンポーネント名、およびコンテンツが適用されるパスによって定義されます。

名前	型	説明
componentName	ComponentNames	コンポーネント名。現在、許容される値は Microsoft-Windows-Shell-Setup のみです。
content	string	指定したパスとコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満で、挿入する設定または機能のルート要素を含める必要があります。
passName	PassNames	パス名。現在、使用可能な値は OobeSystem のみです。
settingName	SettingNames	コンテンツが適用される設定の名前を指定します。指定できる値は、FirstLogonCommands と AutoLogon です。

ApiEntityReference

API エンティティ参照。

名前	型	説明
id	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApplicationProfile

VM/VMSS で使用できるようにする必要があるギャラリーアプリケーションの一覧が含まれています

名前	型	説明
galleryApplications	VMGalleryApplication[]	VM/VMSS で使用できるようにするギャラリーアプリケーションを指定します。

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

名前	型	説明
disableAutomaticRollback	boolean	OS イメージのロールバック機能を無効にする必要があるかどうか。既定値は false です。
enableAutomaticOSUpgrade	boolean	新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケールセットインスタンスに自動的に適用するかどうかを示します。既定値は false です。 Windows ベースのスケールセットでこれが true に設定されている場合、enableAutomaticUpdates 自動的に false に設定され、true に設定することはできません。
osRollingUpgradeDeferral	boolean	OS の自動アップグレードを延期するかどうかを示します。遅延 OS のアップグレードでは、IMDS タグ "Platform.PendingOSUpgrade" を使用して、ローリングアップグレードからの OS アップグレードが受信されたことを VM ごとに高度な通知が送信されます。その後、アップグレードは、ApproveRollingUpgrade 呼び出しによってアップグレードが承認されるまで延期されます。
useRollingUpgradePolicy	boolean	自動 OS アップグレード中にローリングアップグレードポリシーを使用するかどうかを示します。既定値は false です。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。

AutomaticRepairsPolicy

仮想マシンスケールセットでの自動修復の構成パラメーターを指定します。

名前	型	説明
enabled	boolean	仮想マシンスケールセットで自動修復を有効にするかどうかを指定します。既定値は false です。
gracePeriod	string	VM の状態変更により自動修復が中断される時間。猶予期間は、状態の変更が完了した後に開始されます。これは、早期または偶発的な修復を回避するのに役立ちます。期間は ISO 8601 形式で指定する必要があります。許可される最小猶予期間は 10 分 (PT10M) です。これは既定値でもあります。許可される猶予期間の上限は 90 分 (PT90M) です。
repairAction	RepairAction	スケールセット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。既定値は replace です。

BillingProfile

Azure スポット VM または VMSS の課金関連の詳細を指定します。最小 API バージョン: 2019-03-01。

名前	型	説明
maxPrice	number	Azure スポット VM/VMSS に対して支払う最大価格を指定します。この価格は米ドルです。この価格は、VM サイズの現在の Azure スポット価格と比較されます。また、価格は Azure Spot VM/VMSS の作成/更新時に比較され、maxPrice が現在の Azure スポット価格より大きい場合にのみ操作が成功します。現在の Azure スポット価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は Azure スポット VM/VMSS の削除にも使用されます。使用可能な値は次のとおりです。 - 0 より大きい任意の 10 進値。例: 0.01538 -1 – 既定の価格がオンデマンドで up-to されることを示します。 maxPrice を -1 に設定して、価格上の理由から Azure Spot VM/VMSS を削除しないことを示すことができます。また、ユーザーが提供していない場合、既定の最大価格は -1 されます。最小 API バージョン: 2019-03-01。

BootDiagnostics

ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。

名前	型	説明
enabled	boolean	仮想マシンでブート診断を有効にする必要があるかどうか。
storageUri	string	コンソール出力とスクリーンショットの配置に使用するストレージアカウントの URI。ブート診断の有効化中に storageUri が指定されていない場合は、マネージドストレージが使用されます。

CachingTypes

キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。 既定値は、Standard Storage None です。Premium Storage の ReadOnly。

名前	型	説明
None	string
ReadOnly	string
ReadWrite	string

CapacityReservationProfile

容量予約プロファイルのパラメーター。

名前	型	説明
capacityReservationGroup	SubResource	十分な容量が予約されていれば、仮想マシンまたはスケールセット VM インスタンスの割り当てに使用する必要がある容量予約グループのリソース ID を指定します。詳細については、https://aka.ms/CapacityReservation を参照してください。

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

ComponentNames

コンポーネント名。現在、許容される値は Microsoft-Windows-Shell-Setup のみです。

名前	型	説明
Microsoft-Windows-Shell-Setup	string

DeleteOptions

VM が削除されたときのパブリック IP の動作を指定する

名前	型	説明
Delete	string
Detach	string

DiagnosticsProfile

ブート診断設定の状態を指定します。最小 API バージョン: 2015-06-15。

名前	型	説明
bootDiagnostics	BootDiagnostics	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。注: storageUri が指定されている場合は、ストレージアカウントが VM と同じリージョンとサブスクリプションにあることを確認します。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。

DiffDiskOptions

オペレーティングシステムディスクのエフェメラルディスク設定を指定します。

名前	型	説明
Local	string

DiffDiskPlacement

オペレーティングシステムディスクのエフェメラルディスクの配置を指定します。このプロパティは、要求のユーザーが、エフェメラル OS ディスクプロビジョニング用のキャッシュディスク、リソースディスク、または nvme ディスク領域などの場所を選択するために使用できます。エフェメラル OS ディスクサイズの要件の詳細については、https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements の Windows VM と https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsの Linux VM のエフェメラル OS ディスクサイズの要件に関するページを参照してください。 NvmeDisk の最小 API バージョン: 2024-03-01。

名前	型	説明
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

オペレーティングシステムディスクに指定できるエフェメラルディスク設定のパラメーターについて説明します。注: エフェメラルディスクの設定は、マネージドディスクに対してのみ指定できます。

名前	型	説明
option	DiffDiskOptions	オペレーティングシステムディスクのエフェメラルディスク設定を指定します。
placement	DiffDiskPlacement	オペレーティングシステムディスクのエフェメラルディスクの配置を指定します。指定できる値は、CacheDisk、ResourceDisk、NvmeDisk です。既定の動作は、vm サイズ用に構成されている場合は CacheDisk を、それ以外の場合は ResourceDisk するか、NvmeDisk 使用されます。キャッシュディスクを公開する VM サイズを確認するには、https://docs.microsoft.com/azure/virtual-machines/windows/sizes の Windows VM と https://docs.microsoft.com/azure/virtual-machines/linux/sizes の Linux VM の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 API バージョン: 2024-03-01。

DiskControllerTypes

名前	型	説明
NVMe	string
SCSI	string

DiskCreateOptionTypes

スケールセット内の仮想マシンの作成方法を指定します。使用できる値は、FromImage のみです。 この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、前述の imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

名前	型	説明
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブルオーケストレーションモードの VMSS でのみ使用できます)。

使用可能な値:

削除この値を使用すると、VMSS Flex VM が削除されるときに OS ディスクが削除されます。

デタッチ この値を使用すると、VMSS Flex VM が削除された後も OS ディスクが保持されます。

既定値は Deleteに設定されます。エフェメラル OS ディスクの場合、既定値は Deleteに設定されます。ユーザーはエフェメラル OS ディスクの削除オプションを変更できません。

名前	型	説明
Delete	string
Detach	string

DiskEncryptionSetParameters

ディスクに指定できるカスタマーマネージドディスク暗号化セットのリソース ID のパラメーターについて説明します。注: ディスク暗号化セットのリソース ID は、マネージドディスクに対してのみ指定できます。詳細については、https://aka.ms/mdssewithcmkoverview を参照してください。

名前	型	説明
id	string	リソース ID

DomainNameLabelScopeTypes

ドメイン名ラベルスコープ。ドメイン名ラベルスコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。

名前	型	説明
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

EncryptionIdentity

キーコンテナー操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。

名前	型	説明
userAssignedIdentityResourceId	string	VM に関連付けられているいずれかのユーザー ID の ARM リソース ID を指定します。

EventGridAndResourceGraph

eventGridAndResourceGraph 関連のスケジュールされたイベント関連の構成を指定します。

名前	型	説明
enable	boolean	スケジュールされたイベント関連の構成でイベントグリッドとリソースグラフが有効かどうかを指定します。

ExpandTypesForGetVMScaleSets

操作に適用する展開式。 'UserData' は、VM スケールセットの作成/更新操作中にユーザーによって提供された VM スケールセットの UserData プロパティを取得します

名前	型	説明
userData	string

ExtendedLocation

拡張された場所の複合型。

名前	型	説明
name	string	拡張された場所の名前。
type	ExtendedLocationTypes	拡張された場所の型。

ExtendedLocationTypes

拡張された場所の型。

名前	型	説明
EdgeZone	string

ImageReference

使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。注: イメージ参照パブリッシャーとオファーは、スケールセットの作成時にのみ設定できます。

名前	型	説明
communityGalleryImageId	string	VM デプロイのコミュニティギャラリーイメージの一意の ID を指定しました。これは、コミュニティギャラリーイメージの GET 呼び出しからフェッチできます。
exactVersion	string	仮想マシンの作成に使用されるプラットフォームイメージまたはマーケットプレースイメージのバージョンを 10 進数で指定します。この読み取り専用フィールドは、'version' フィールドに指定された値が 'latest' の場合にのみ、'version' と異なります。
id	string	リソース ID
offer	string	仮想マシンの作成に使用するプラットフォームイメージまたはマーケットプレースイメージのオファーを指定します。
publisher	string	イメージの発行元。
sharedGalleryImageId	string	VM デプロイの共有ギャラリーイメージの一意の ID を指定しました。これは、共有ギャラリーイメージの GET 呼び出しからフェッチできます。
sku	string	イメージ SKU。
version	string	仮想マシンの作成に使用するプラットフォームイメージまたはマーケットプレースイメージのバージョンを指定します。使用できる形式は Major.Minor.Build または 'latest' です。メジャー、マイナー、ビルドは 10 進数です。デプロイ時に使用可能なイメージの最新バージョンを使用するには、'latest' を指定します。 "最新" を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ後に VM イメージが自動的に更新されることはありません。ギャラリーイメージのデプロイにはフィールド 'version' を使用しないでください。ギャラリーイメージは常に 'id' フィールドを使用する必要があります。ギャラリーイメージの '最新' バージョンを使用するには、バージョン入力なしで '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleryName}/images/{imageName}' を 'id' フィールドに設定してください。

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

IPVersion

Api-Version 2019-07-01 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。既定値は IPv4 と見なされます。使用可能な値は、'IPv4' と 'IPv6' です。

名前	型	説明
IPv4	string
IPv6	string

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

名前	型	説明
secretUrl	string	Key Vault 内のシークレットを参照する URL。
sourceVault	SubResource	シークレットを含む Key Vault の相対 URL。

LinuxConfiguration

仮想マシン上の Linux オペレーティングシステムの設定を指定します。サポートされている Linux ディストリビューションの一覧については、Azure-Endorsed ディストリビューションLinux を参照してください。

名前	型	説明
disablePasswordAuthentication	boolean	パスワード認証を無効にするかどうかを指定します。
enableVMAgentPlatformUpdates	boolean	Linux 仮想マシンに対して VMAgent プラットフォーム更新プログラムが有効になっているかどうかを示します。既定値は false です。
patchSettings	LinuxPatchSettings	[プレビュー機能]Linux での VM ゲストパッチ適用に関連する設定を指定します。
provisionVMAgent	boolean	仮想マシンエージェントを仮想マシンにプロビジョニングするかどうかを示します。このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
ssh	SshConfiguration	Linux OS の ssh キー構成を指定します。

LinuxPatchAssessmentMode

IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。

使用可能な値は次のとおりです。

ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。

AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。

名前	型	説明
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

Linux での VM ゲストパッチ適用に関連する設定を指定します。

名前	型	説明
assessmentMode	LinuxPatchAssessmentMode	IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。使用可能な値は次のとおりです。 ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。 AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Linux 上の VM ゲストパッチ適用でのパッチモード AutomaticByPlatform の追加設定を指定します。
patchMode	LinuxVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲストパッチ適用のモードを指定します。使用可能な値は次のとおりです。 ImageDefault - 仮想マシンの既定の修正プログラムの適用構成が使用されます。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent は true である必要があります

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

名前	型	説明
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Linux パッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。

名前	型	説明
bypassPlatformSafetyChecksOnUserSchedule	boolean	お客様が誤ってアップグレードすることなく修正プログラムの適用をスケジュールできるようにします
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

LinuxVMGuestPatchMode

OrchestrationMode をフレキシブルとして使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲストパッチ適用のモードを指定します。

使用可能な値は次のとおりです。

ImageDefault - 仮想マシンの既定の修正プログラムの適用構成が使用されます。

AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent は true である必要があります

名前	型	説明
AutomaticByPlatform	string
ImageDefault	string

Mode

機能が有効になっている場合に ProxyAgent が実行されるモードを指定します。 ProxyAgent は監査または監視を開始しますが、監査モードでエンドポイントをホストする要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。既定値は [強制モード] です。

名前	型	説明
Audit	string
Enforce	string

NetworkApiVersion

は、オーケストレーションモード 'フレキシブル' を使用して仮想マシンスケールセットのネットワークインターフェイス構成でネットワークリソースを作成するときに使用される Microsoft.Network API バージョンを指定します

名前	型	説明
2020-11-01	string

NetworkInterfaceAuxiliaryMode

ネットワークインターフェイスリソースに対して補助モードを有効にするかどうかを指定します。

名前	型	説明
AcceleratedConnections	string
Floating	string
None	string

NetworkInterfaceAuxiliarySku

ネットワークインターフェイスリソースに対して補助 SKU を有効にするかどうかを指定します。

名前	型	説明
A1	string
A2	string
A4	string
A8	string
None	string

OperatingSystemTypes

このプロパティを使用すると、ユーザーイメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。使用可能な値は、Windows Linuxです。

名前	型	説明
Linux	string
Windows	string

OrchestrationMode

仮想マシンスケールセットのオーケストレーションモードを指定します。

名前	型	説明
Flexible	string
Uniform	string

OSImageNotificationProfile

名前	型	説明
enable	boolean	OS Image Scheduled イベントを有効にするか無効にするかを指定します。
notBeforeTimeout	string	仮想マシンの再イメージ化または OS のアップグレードが必要になる時間の長さは、イベントが自動的に承認 (タイムアウト) する前に、OS イメージのスケジュールされたイベントを承認する必要があります。構成は ISO 8601 形式で指定され、値は 15 分 (PT15M) である必要があります

PassNames

パス名。現在、使用可能な値は OobeSystem のみです。

名前	型	説明
OobeSystem	string

PatchSettings

Windows での VM ゲストパッチ適用に関連する設定を指定します。

名前	型	説明
assessmentMode	WindowsPatchAssessmentMode	IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。使用可能な値は次のとおりです。 ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。 AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Windows 上の VM ゲスト修正プログラムの適用におけるパッチモード AutomaticByPlatform の追加設定を指定します。
enableHotpatching	boolean	お客様は、再起動を必要とせずに Azure VM にパッチを適用できます。 enableHotpatching の場合、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。
patchMode	WindowsVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲストパッチ適用のモードを指定します。使用可能な値は次のとおりです。手動 - 仮想マシンへのパッチの適用を制御します。これを行うには、VM 内でパッチを手動で適用します。このモードでは、自動更新は無効になります。プロパティ WindowsConfiguration.enableAutomaticUpdates は false にする必要があります AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。プロパティ WindowsConfiguration.enableAutomaticUpdates は true である必要があります。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。 provisionVMAgent プロパティと WindowsConfiguration.enableAutomaticUpdates プロパティは true である必要があります

Plan

仮想マシンの作成に使用されるマーケットプレースイメージに関する情報を指定します。この要素は、Marketplace イメージにのみ使用されます。 API からマーケットプレースイメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portal で、使用するマーケットプレースイメージを見つけて、[プログラムでデプロイする ] をクリック>。必要な情報を入力し、[保存クリックします。

名前	型	説明
name	string	プラン ID。
product	string	マーケットプレースからのイメージの製品を指定します。これは、imageReference 要素の下の Offer と同じ値です。
promotionCode	string	昇格コード。
publisher	string	発行元 ID。

PriorityMixPolicy

柔軟なオーケストレーションモードのスケールセット内のスポットおよび標準の優先度 VM のターゲット分割を指定します。このプロパティを使用すると、VMSS flex インスタンスのスケールアウト時に作成される通常の優先順位 VM の基本数と、このベースターゲットに到達した後のスポットと通常の優先度の VM の間の分割を指定できます。

名前	型	説明
baseRegularPriorityCount	integer	スケールアウト時にこのスケールセットに作成される通常の優先順位の VM の基本数。
regularPriorityPercentageAboveBase	integer	基本の通常の優先度の数に達した後の、通常の優先度を使用することが予想される VM インスタンスの割合。

ProtocolTypes

WinRM リスナーのプロトコルを指定します。指定できる値は、http 、httpsです。

名前	型	説明
Http	string
Https	string

ProxyAgentSettings

仮想マシンの作成時に ProxyAgent の設定を指定します。最小 API バージョン: 2024-03-01。

名前	型	説明
enabled	boolean	仮想マシンまたは仮想マシンスケールセットで ProxyAgent 機能を有効にする必要があるかどうかを指定します。
keyIncarnationId	integer	このプロパティの値を大きくすると、ユーザーはゲストとホスト間の通信チャネルをセキュリティで保護するために使用されるキーをリセットできます。
mode	Mode	機能が有効になっている場合に ProxyAgent が実行されるモードを指定します。 ProxyAgent は監査または監視を開始しますが、監査モードでエンドポイントをホストする要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。既定値は [強制モード] です。

PublicIPAddressSku

パブリック IP SKU について説明します。 OrchestrationMode をフレキシブルとしてのみ設定できます。

名前	型	説明
name	PublicIPAddressSkuName	パブリック IP SKU 名を指定する
tier	PublicIPAddressSkuTier	パブリック IP SKU レベルを指定する

PublicIPAddressSkuName

パブリック IP SKU 名を指定する

名前	型	説明
Basic	string
Standard	string

PublicIPAddressSkuTier

パブリック IP SKU レベルを指定する

名前	型	説明
Global	string
Regional	string

RepairAction

スケールセット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。既定値は replace です。

名前	型	説明
Reimage	string
Replace	string
Restart	string

ResiliencyPolicy

回復性ポリシー (resilientVMCreationPolicy または resilientVMDeletionPolicy) について説明します。

名前	型	説明
resilientVMCreationPolicy	ResilientVMCreationPolicy	回復性のある VM の作成の実行中に使用される構成パラメーター。
resilientVMDeletionPolicy	ResilientVMDeletionPolicy	回復性のある VM 削除の実行中に使用される構成パラメーター。

ResilientVMCreationPolicy

回復性のある VM の作成の実行中に使用される構成パラメーター。

名前	型	説明
enabled	boolean	仮想マシンスケールセットで回復性のある VM の作成を有効にするかどうかを指定します。既定値は false です。

ResilientVMDeletionPolicy

回復性のある VM 削除の実行中に使用される構成パラメーター。

名前	型	説明
enabled	boolean	仮想マシンスケールセットで回復性のある VM の削除を有効にするかどうかを指定します。既定値は false です。

ResourceIdentityType

仮想マシンスケールセットに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンスケールセットからすべての ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RollingUpgradePolicy

ローリングアップグレードの実行中に使用される構成パラメーター。

名前	型	説明
enableCrossZoneUpgrade	boolean	アップグレードバッチを構築するときに、VMSS が AZ 境界を無視できるようにします。バッチサイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。
maxBatchInstancePercent	integer	1 回のバッチでのローリングアップグレードによって同時にアップグレードされる仮想マシンインスタンスの合計数に対する最大割合。これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。このパラメーターの既定値は 20%です。
maxSurge	boolean	既存の仮想マシンを更新するのではなく、スケールセットをアップグレードする新しい仮想マシンを作成します。既存の仮想マシンは、バッチごとに新しい仮想マシンが作成されると削除されます。
maxUnhealthyInstancePercent	integer	アップグレードの結果として、またはローリングアップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケールセット内の仮想マシンインスタンスの合計数に対する最大割合。この制約は、バッチを開始する前にチェックされます。このパラメーターの既定値は 20%です。
maxUnhealthyUpgradedInstancePercent	integer	異常な状態にあると検出できるアップグレードされた仮想マシンインスタンスの最大割合。このチェックは、各バッチがアップグレードされた後に行われます。この割合を超えた場合、ローリングアップデートは中止されます。このパラメーターの既定値は 20%です。
pauseTimeBetweenBatches	string	すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。期間は ISO 8601 形式で指定する必要があります。既定値は 0 秒 (PT0S) です。
prioritizeUnhealthyInstances	boolean	正常なインスタンスの前に、スケールセット内のすべての異常なインスタンスをアップグレードします。
rollbackFailedInstancesOnPolicyBreach	boolean	ローリングアップグレードポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。

ScaleInPolicy

仮想マシンスケールセットのスケールインポリシーについて説明します。

名前	型	説明
forceDeletion	boolean	このプロパティを使用すると、仮想マシンスケールセットのスケールイン時に、削除対象として選択した仮想マシンを強制的に削除する必要があるかどうかを指定できます。(プレビューの機能)
rules	VirtualMachineScaleSetScaleInRules[]	仮想マシンスケールセットのスケールイン時に従う規則。使用可能な値は次のとおりです。既定の仮想マシンスケールセットがスケールインされると、スケールセットがゾーンスケールセットの場合、まずゾーン間でバランスが取られます。その後、障害ドメイン間で可能な限りバランスが取られます。各障害ドメイン内では、削除対象として選択された仮想マシンが、スケールインから保護されていない最新の仮想マシンになります。 OldestVM 仮想マシンスケールセットがスケールインされるときに、スケールインから保護されていない最も古い仮想マシンが削除対象として選択されます。ゾーン仮想マシンスケールセットの場合、スケールセットは最初にゾーン間で分散されます。各ゾーン内では、保護されていない最も古い仮想マシンが削除対象として選択されます。 NewestVM 仮想マシンスケールセットがスケールインされるときに、スケールインから保護されていない最新の仮想マシンが削除対象として選択されます。ゾーン仮想マシンスケールセットの場合、スケールセットは最初にゾーン間で分散されます。各ゾーン内では、保護されていない最新の仮想マシンが削除対象として選択されます。

ScheduledEventsAdditionalPublishingTargets

名前	型	説明
eventGridAndResourceGraph	EventGridAndResourceGraph	eventGridAndResourceGraph Scheduled Event 設定の作成時に使用される構成パラメーター。

ScheduledEventsPolicy

Redeploy、Reboot、ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations を指定します。

名前	型	説明
scheduledEventsAdditionalPublishingTargets	ScheduledEventsAdditionalPublishingTargets	scheduledEventsAdditionalPublishingTargets の発行時に使用される構成パラメーター。
userInitiatedReboot	UserInitiatedReboot	userInitiatedReboot スケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。
userInitiatedRedeploy	UserInitiatedRedeploy	userInitiatedRedeploy スケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

ScheduledEventsProfile

名前	型	説明
osImageNotificationProfile	OSImageNotificationProfile	OS イメージのスケジュールされたイベント関連の構成を指定します。
terminateNotificationProfile	TerminateNotificationProfile	Terminate Scheduled Event 関連の構成を指定します。

securityEncryptionTypes

マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクの暗号化を行う場合は DiskWithVMGuestState、VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定できます。

名前	型	説明
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityPostureReference

スケールセットで使用するセキュリティ体制を指定します。最小 API バージョン: 2023-03-01

名前	型	説明
excludeExtensions	string[]	セキュリティ体制を適用するときに除外する仮想マシン拡張機能名の一覧。
id	string	/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}\|latest の形式のセキュリティ体制参照 ID
isOverridable	boolean	ユーザーがセキュリティ体制をオーバーライドできるかどうか。

SecurityProfile

仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。

名前	型	説明
encryptionAtHost	boolean	このプロパティは、要求のユーザーが仮想マシンまたは仮想マシンスケールセットの Host Encryption を有効または無効にするために使用できます。これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。既定の動作は次のとおりです。このプロパティがリソースに対して true に設定されていない限り、ホストでの暗号化は無効になります。
encryptionIdentity	EncryptionIdentity	キーコンテナー操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。
proxyAgentSettings	ProxyAgentSettings	仮想マシンの作成時に ProxyAgent の設定を指定します。最小 API バージョン: 2024-03-01。
securityType	SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。
uefiSettings	UefiSettings	仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。最小 API バージョン: 2020-12-01。

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。

名前	型	説明
ConfidentialVM	string
TrustedLaunch	string

ServiceArtifactReference

"最新" イメージバージョンを使用する場合に、スケールセット内のすべての仮想マシンに同じイメージバージョンを設定するために使用されるサービス成果物参照 ID を指定します。最小 API バージョン: 2022-11-01

名前	型	説明
id	string	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス成果物参照 ID

SettingNames

コンテンツが適用される設定の名前を指定します。指定できる値は、FirstLogonCommands と AutoLogon です。

名前	型	説明
AutoLogon	string
FirstLogonCommands	string

Sku

仮想マシンスケールセット SKU について説明します。注: スケールセットが現在オンになっているハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケールセット内の VM の割り当てを解除する必要があります。

名前	型	説明
capacity	integer	スケールセット内の仮想マシンの数を指定します。
name	string	SKU 名。
tier	string	スケールセット内の仮想マシンの層を指定します。使用可能な値: Standard Basic

SpotRestorePolicy

仮想マシンスケールセットのスポットTry-Restore プロパティを指定します。このプロパティを使用すると、お客様は、容量の可用性と価格の制約に基づいて、削除されたスポット VMSS VM インスタンスの自動復元を日和見的に有効または無効にすることができます。

名前	型	説明
enabled	boolean	容量の可用性と価格の制約に基づいて、削除された VMSS SPOT インスタンスの復元が日和見的に試行されるスポットTry-Restore 機能を有効にします。
restoreTimeout	string	プラットフォームが VMSS SPOT インスタンスの復元を試行しない ISO 8601 期間として表されるタイムアウト値

SshConfiguration

Azure で実行されている Linux ベースの VM の SSH 構成

名前	型	説明
publicKeys	SshPublicKey[]	Linux ベースの VM での認証に使用される SSH 公開キーの一覧。

SshPublicKey

SSH 証明書の公開キーと、公開キーが配置されている Linux VM 上のパスに関する情報が含まれています。

名前	型	説明
keyData	string	SSH を使用して VM で認証するために使用される SSH 公開キー証明書。キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。 ssh キーの作成については、「Azure の Linux VM 用の Linux および Mac での SSH キーの作成」を参照してくださいhttps://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	ssh 公開キーが格納されている作成済み VM 上の完全なパスを指定します。ファイルが既に存在する場合は、指定したキーがファイルに追加されます。例: /home/user/.ssh/authorized_keys

StorageAccountTypes

マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できます。OS ディスクでは使用できません。

名前	型	説明
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

名前	型	説明
id	string	リソース ID

TerminateNotificationProfile

名前	型	説明
enable	boolean	Terminate Scheduled イベントが有効か無効かを指定します。
notBeforeTimeout	string	削除される仮想マシンが、イベントが自動的に承認 (タイムアウト) する前に、スケジュールされた終了イベントを承認する必要がある時間の構成可能な長さ。構成は ISO 8601 形式で指定する必要があります。既定値は 5 分 (PT5M) です

UefiSettings

仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。最小 API バージョン: 2020-12-01。

名前	型	説明
secureBootEnabled	boolean	仮想マシンでセキュアブートを有効にするかどうかを指定します。最小 API バージョン: 2020-12-01。
vTpmEnabled	boolean	仮想マシンで vTPM を有効にするかどうかを指定します。最小 API バージョン: 2020-12-01。

UpgradeMode

スケールセット内の仮想マシンへのアップグレードモードを指定します。

使用可能な値は次のとおりです。

手動 - スケールセット内の仮想マシンへの更新プログラムの適用を制御します。これを行うには、manualUpgrade アクションを使用します。

自動 - スケールセット内のすべての仮想マシンが同時に自動的に更新されます。

名前	型	説明
Automatic	string
Manual	string
Rolling	string

UpgradePolicy

アップグレードポリシー (自動、手動、またはローリング) について説明します。

名前	型	説明
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。
mode	UpgradeMode	スケールセット内の仮想マシンへのアップグレードモードを指定します。使用可能な値は次のとおりです。手動 - スケールセット内の仮想マシンへの更新プログラムの適用を制御します。これを行うには、manualUpgrade アクションを使用します。自動 - スケールセット内のすべての仮想マシンが同時に自動的に更新されます。
rollingUpgradePolicy	RollingUpgradePolicy	ローリングアップグレードの実行中に使用される構成パラメーター。

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前	型	説明

UserInitiatedReboot

再起動関連のスケジュールされたイベント関連の構成を指定します。

名前	型	説明
automaticallyApprove	boolean	再起動スケジュールされたイベント関連の構成を指定します。

UserInitiatedRedeploy

再デプロイ関連のスケジュールされたイベント関連の構成を指定します。

名前	型	説明
automaticallyApprove	boolean	スケジュールされたイベント関連の構成を再デプロイするように指定します。

VaultCertificate

Key Vault 内の 1 つの証明書参照と、証明書が VM 上に存在する場所について説明します。

名前	型	説明
certificateStore	string	Windows VM の場合、証明書を追加する仮想マシン上の証明書ストアを指定します。指定された証明書ストアは、LocalMachine アカウントに暗黙的に含まれます。 Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、X509 証明書ファイルのファイル名 <UppercaseThumbprint>.crt、秘密キーの場合は .prv><.prv になります。これらのファイルはどちらも .pem 形式です。
certificateUrl	string	これは、シークレットとして Key Vault にアップロードされた証明書の URL です。 Key Vault にシークレットを追加する方法については、「キーコンテナーにキーまたはシークレットを追加する」を参照してください。この場合、証明書は、UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。 { "data":"", "dataType":"pfx", "password":"" } 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows用の Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

VaultSecretGroup

すべて同じ Key Vault 内にある証明書のセットについて説明します。

名前	型	説明
sourceVault	SubResource	VaultCertificates 内のすべての証明書を含む Key Vault の相対 URL。
vaultCertificates	VaultCertificate[]	証明書を含む SourceVault 内のキーコンテナー参照の一覧。

VirtualHardDisk

ディスクの URI について説明します。

名前	型	説明
uri	string	仮想ハードディスクの URI を指定します。

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。 Azure Spot 仮想マシンでは、"割り当て解除" と "削除" の両方がサポートされており、最小 API バージョンは 2019-03-01 です。 Azure スポットスケールセットの場合、"割り当て解除" と "削除" の両方がサポートされ、最小 API バージョンは 2017-10-30-preview です。

名前	型	説明
Deallocate	string
Delete	string

VirtualMachinePriorityTypes

スケールセット内の仮想マシンの優先順位を指定します。最小 API バージョン: 2017-10-30-preview。

名前	型	説明
Low	string
Regular	string
Spot	string

VirtualMachineScaleSet

仮想マシンスケールセットについて説明します。

名前	型	説明
etag	string	Etag は、VMSS の作成/更新/取得応答で返されるプロパティです。これにより、お客様はヘッダーで指定して、オプティミスティック更新を保証できます
extendedLocation	ExtendedLocation	仮想マシンスケールセットの拡張された場所。
id	string	リソース ID
identity	VirtualMachineScaleSetIdentity	仮想マシンスケールセットの ID (構成されている場合)。
location	string	リソースの場所
name	string	リソース名
plan	Plan	仮想マシンの作成に使用されるマーケットプレースイメージに関する情報を指定します。この要素は、Marketplace イメージにのみ使用されます。 API からマーケットプレースイメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portal で、使用するマーケットプレースイメージを見つけて、[プログラムでデプロイする ] をクリック>。必要な情報を入力し、[保存クリックします。
properties.additionalCapabilities	AdditionalCapabilities	仮想マシンスケールセット内の仮想マシンで有効または無効にされる追加機能を指定します。たとえば、ストレージアカウントの種類がUltraSSD_LRSマネージドデータディスクの接続をサポートする機能が Virtual Machines にあるかどうか。
properties.automaticRepairsPolicy	AutomaticRepairsPolicy	自動修復のポリシー。
properties.constrainedMaximumCapacity	boolean	True に設定するか省略する必要がある省略可能なプロパティ。
properties.doNotRunExtensionsOnOverprovisionedVMs	boolean	オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。
properties.hostGroup	SubResource	仮想マシンスケールセットが存在する専用ホストグループに関する情報を指定します。最小 API バージョン: 2020-06-01。
properties.orchestrationMode	OrchestrationMode	仮想マシンスケールセットのオーケストレーションモードを指定します。
properties.overprovision	boolean	仮想マシンスケールセットをオーバープロビジョニングするかどうかを指定します。
properties.platformFaultDomainCount	integer	各配置グループの障害ドメイン数。
properties.priorityMixPolicy	PriorityMixPolicy	同じ VMSS Flex インスタンス内でスポットと通常の優先度の VM を混在するために必要なターゲットを指定します。
properties.provisioningState	string	プロビジョニング状態。応答にのみ表示されます。
properties.proximityPlacementGroup	SubResource	仮想マシンスケールセットを割り当てる必要がある近接配置グループに関する情報を指定します。最小 API バージョン: 2018-04-01。
properties.resiliencyPolicy	ResiliencyPolicy	回復性のポリシー
properties.scaleInPolicy	ScaleInPolicy	仮想マシンスケールセット内の仮想マシンのスケーリング時に適用されるポリシーを指定します。
properties.scheduledEventsPolicy	ScheduledEventsPolicy	ScheduledEventsPolicy。
properties.singlePlacementGroup	boolean	true の場合、スケールセットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。注: singlePlacementGroup が true の場合、false に変更される可能性があります。ただし、singlePlacementGroup が false の場合は、true に変更することはできません。
properties.spotRestorePolicy	SpotRestorePolicy	仮想マシンスケールセットのスポット復元プロパティを指定します。
properties.timeCreated	string	仮想マシンスケールセットリソースが作成された時刻を指定します。最小 API バージョン: 2021-11-01。
properties.uniqueId	string	仮想マシンスケールセットを一意に識別する ID を指定します。
properties.upgradePolicy	UpgradePolicy	アップグレードポリシー。
properties.virtualMachineProfile	VirtualMachineScaleSetVMProfile	仮想マシンプロファイル。
properties.zoneBalance	boolean	ゾーンの停止が発生した場合に、仮想マシンの分散を x ゾーン間で厳密に行うかどうか。 zoneBalance プロパティは、スケールセットの zones プロパティに複数のゾーンが含まれている場合にのみ設定できます。ゾーンがない場合、またはゾーンが 1 つだけ指定されている場合は、zoneBalance プロパティを設定しないでください。
sku	Sku	仮想マシンスケールセット SKU。
tags	object	リソースタグ
type	string	リソースの種類
zones	string[]	仮想マシンスケールセットゾーン。注: 可用性ゾーンは、スケールセットを作成するときにのみ設定できます

VirtualMachineScaleSetDataDisk

仮想マシンスケールセットのデータディスクについて説明します。

名前	型	説明
caching	CachingTypes	キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。既定値は、Standard Storage None です。Premium Storage の ReadOnly。
createOption	DiskCreateOptionTypes	作成オプション。
deleteOption	DiskDeleteOptionTypes	VMSS Flex の削除時にデータディスクを削除するかデタッチするかを指定します (この機能は、フレキシブルオーケストレーションモードの VMSS でのみ使用できます)。使用可能な値: 削除この値を使用すると、VMSS Flex VM が削除されるときにデータディスクが削除されます。デタッチこの値を使用すると、VMSS Flex VM が削除された後もデータディスクが保持されます。既定値は Deleteに設定されます。
diskIOPSReadWrite	integer	マネージドディスクの Read-Write IOPS を指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用してください。指定しない場合は、diskSizeGB に基づいて既定値が割り当てられます。
diskMBpsReadWrite	integer	マネージドディスクの帯域幅を 1 秒あたりの MB 単位で指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用してください。指定しない場合は、diskSizeGB に基づいて既定値が割り当てられます。
diskSizeGB	integer	空のデータディスクのサイズをギガバイト単位で指定します。この要素を使用して、仮想マシンイメージ内のディスクのサイズを上書きできます。 diskSizeGB プロパティは、ディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。
lun	integer	データディスクの論理ユニット番号を指定します。この値は、VM 内のデータディスクを識別するために使用されるため、VM に接続されているデータディスクごとに一意である必要があります。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	マネージドディスクのパラメーター。
name	string	ディスク名。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

VirtualMachineScaleSetExtension

仮想マシンスケールセット拡張機能について説明します。

名前	型	説明
id	string	リソース ID
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

仮想マシンスケールセット拡張機能プロファイルについて説明します。

名前	型	説明
extensions	VirtualMachineScaleSetExtension[]	仮想マシンスケールセットの子拡張機能リソース。
extensionsTimeBudget	string	すべての拡張機能の割り当て時間を指定します。期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。既定値は 90 分 (PT1H30M) です。最小 API バージョン: 2020-06-01。

VirtualMachineScaleSetHardwareProfile

仮想マシンスケールセットのハードウェア設定を指定します。

名前	型	説明
vmSizeProperties	VMSizeProperties	仮想マシンのサイズをカスタマイズするためのプロパティを指定します。最小 API バージョン: 2021-11-01。詳細については、VM カスタマイズの手順に従ってください。

VirtualMachineScaleSetIdentity

仮想マシンスケールセットの ID。

名前	型	説明
principalId	string	仮想マシンスケールセット ID のプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string	仮想マシンスケールセットに関連付けられているテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ResourceIdentityType	仮想マシンスケールセットに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンスケールセットからすべての ID を削除します。
userAssignedIdentities	UserAssignedIdentities	仮想マシンスケールセットに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

VirtualMachineScaleSetIPConfiguration

仮想マシンスケールセットネットワークプロファイルの IP 構成について説明します。

名前	型	説明
name	string	IP 構成名。
properties.applicationGatewayBackendAddressPools	SubResource[]	アプリケーションゲートウェイのバックエンドアドレスプールへの参照の配列を指定します。スケールセットは、複数のアプリケーションゲートウェイのバックエンドアドレスプールを参照できます。複数のスケールセットで同じアプリケーションゲートウェイを使用することはできません。
properties.applicationSecurityGroups	SubResource[]	アプリケーションセキュリティグループへの参照の配列を指定します。
properties.loadBalancerBackendAddressPools	SubResource[]	ロードバランサーのバックエンドアドレスプールへの参照の配列を指定します。スケールセットは、1 つのパブリックロードバランサーと 1 つの内部ロードバランサーのバックエンドアドレスプールを参照できます。複数のスケールセットで同じ Basic SKU ロードバランサーを使用することはできません。
properties.loadBalancerInboundNatPools	SubResource[]	ロードバランサーの受信 Nat プールへの参照の配列を指定します。スケールセットは、1 つのパブリックロードバランサーと 1 つの内部ロードバランサーの受信 NAT プールを参照できます。複数のスケールセットで同じ Basic 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 タグを格納します。

名前	型	説明
ipTagType	string	IP タグの種類。例: FirstPartyUsage。
tag	string	パブリック IP に関連付けられている IP タグ。例: SQL、Storage など

VirtualMachineScaleSetManagedDiskParameters

ScaleSet マネージドディスクのパラメーターについて説明します。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	マネージドディスクのカスタマーマネージドディスク暗号化セットのリソース ID を指定します。
securityProfile	VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイルを指定します。
storageAccountType	StorageAccountTypes	マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できます。OS ディスクでは使用できません。

VirtualMachineScaleSetNetworkConfiguration

仮想マシンスケールセットネットワークプロファイルのネットワーク構成について説明します。

名前	型	説明
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 設定について説明します。

名前	型	説明
dnsServers	string[]	DNS サーバーの IP アドレスの一覧

VirtualMachineScaleSetNetworkProfile

仮想マシンスケールセットのネットワークプロファイルについて説明します。

名前	型	説明
healthProbe	ApiEntityReference	仮想マシンスケールセット内のインスタンスの正常性を判断するために使用されるロードバランサープローブへの参照。参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}' の形式になります。
networkApiVersion	NetworkApiVersion	は、オーケストレーションモード 'フレキシブル' を使用して仮想マシンスケールセットのネットワークインターフェイス構成でネットワークリソースを作成するときに使用される Microsoft.Network API バージョンを指定します
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	ネットワーク構成の一覧。

VirtualMachineScaleSetOSDisk

仮想マシンスケールセットのオペレーティングシステムディスクについて説明します。

名前	型	説明
caching	CachingTypes	キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。既定値は、Standard Storage None です。Premium Storage の ReadOnly。
createOption	DiskCreateOptionTypes	スケールセット内の仮想マシンの作成方法を指定します。使用できる値は、FromImage のみです。この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、前述の imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。
deleteOption	DiskDeleteOptionTypes	VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブルオーケストレーションモードの VMSS でのみ使用できます)。使用可能な値: 削除この値を使用すると、VMSS Flex VM が削除されるときに OS ディスクが削除されます。デタッチこの値を使用すると、VMSS Flex VM が削除された後も OS ディスクが保持されます。既定値は Deleteに設定されます。エフェメラル OS ディスクの場合、既定値は Deleteに設定されます。ユーザーはエフェメラル OS ディスクの削除オプションを変更できません。
diffDiskSettings	DiffDiskSettings	仮想マシンスケールセットで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。
diskSizeGB	integer	空のデータディスクのサイズをギガバイト単位で指定します。この要素を使用して、仮想マシンイメージ内のディスクのサイズを上書きできます。プロパティ 'diskSizeGB' は、ディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。
image	VirtualHardDisk	スケールセットの基となるアンマネージドユーザーイメージに関する情報を指定します。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	マネージドディスクのパラメーター。
name	string	ディスク名。
osType	OperatingSystemTypes	このプロパティを使用すると、ユーザーイメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。使用可能な値は、Windows Linuxです。
vhdContainers	string[]	スケールセットのオペレーティングシステムディスクの格納に使用するコンテナーの URL を指定します。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

VirtualMachineScaleSetOSProfile

仮想マシンスケールセットの OS プロファイルについて説明します。

名前	型	説明
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 拡張機能を使用した Azure Linux VM でのユーザー、SSH の管理、ディスクの確認または修復を行う方法に関するページを参照してください。
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 構成について説明します

名前	型	説明
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 設定について説明します。

名前	型	説明
domainNameLabel	string	ドメイン名ラベル。ドメイン名ラベルと VM インデックスの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。
domainNameLabelScope	DomainNameLabelScopeTypes	ドメイン名ラベルスコープ。ドメイン名ラベルスコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。

VirtualMachineScaleSetScaleInRules

仮想マシンスケールセットのスケールイン時に従う規則。

使用可能な値は次のとおりです。

既定の 仮想マシンスケールセットがスケールインされると、スケールセットがゾーンスケールセットの場合、まずゾーン間でバランスが取られます。その後、障害ドメイン間で可能な限りバランスが取られます。各障害ドメイン内では、削除対象として選択された仮想マシンが、スケールインから保護されていない最新の仮想マシンになります。

OldestVM 仮想マシンスケールセットがスケールインされるときに、スケールインから保護されていない最も古い仮想マシンが削除対象として選択されます。ゾーン仮想マシンスケールセットの場合、スケールセットは最初にゾーン間で分散されます。各ゾーン内では、保護されていない最も古い仮想マシンが削除対象として選択されます。

NewestVM 仮想マシンスケールセットがスケールインされるときに、スケールインから保護されていない最新の仮想マシンが削除対象として選択されます。ゾーン仮想マシンスケールセットの場合、スケールセットは最初にゾーン間で分散されます。各ゾーン内では、保護されていない最新の仮想マシンが削除対象として選択されます。

名前	型	説明
Default	string
NewestVM	string
OldestVM	string

VirtualMachineScaleSetStorageProfile

仮想マシンスケールセットのストレージプロファイルについて説明します。

名前	型	説明
dataDisks	VirtualMachineScaleSetDataDisk[]	スケールセット内の仮想マシンにデータディスクを追加するために使用するパラメーターを指定します。ディスクの詳細については、「Azure 仮想マシンのディスクと VHD について」を参照してください。
diskControllerType	DiskControllerTypes[]	スケールセット内の仮想マシン用に構成されたディスクコントローラーの種類を指定します。最小 API バージョン: 2022-08-01
imageReference	ImageReference	使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。
osDisk	VirtualMachineScaleSetOSDisk	スケールセット内の仮想マシンによって使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「Azure 仮想マシンのディスクと VHD について」を参照してください。

VirtualMachineScaleSetVMProfile

仮想マシンスケールセットの仮想マシンプロファイルについて説明します。

名前	型	説明
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 スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。 Azure Spot 仮想マシンでは、"割り当て解除" と "削除" の両方がサポートされており、最小 API バージョンは 2019-03-01 です。 Azure スポットスケールセットの場合、"割り当て解除" と "削除" の両方がサポートされ、最小 API バージョンは 2017-10-30-preview です。
extensionProfile	VirtualMachineScaleSetExtensionProfile	スケールセット内の仮想マシンにインストールされている拡張機能の設定のコレクションを指定します。
hardwareProfile	VirtualMachineScaleSetHardwareProfile	スケールセットのハードウェアプロファイル関連の詳細を指定します。最小 API バージョン: 2021-11-01。
licenseType	string	使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。 Windows Server オペレーティングシステムに使用できる値は次のとおりです。 Windows_Client Windows_Server Linux Server オペレーティングシステムで使用できる値は次のとおりです。 RHEL_BYOS (RHEL の場合) SLES_BYOS (SUSE の場合) 詳細については、「Windows Server の Azure ハイブリッド使用特典の」を参照してください。 Linux Server の Azure ハイブリッド使用特典の最小 API バージョン: 2015-06-15
networkProfile	VirtualMachineScaleSetNetworkProfile	スケールセット内の仮想マシンのネットワークインターフェイスのプロパティを指定します。
osProfile	VirtualMachineScaleSetOSProfile	スケールセット内の仮想マシンのオペレーティングシステム設定を指定します。
priority	VirtualMachinePriorityTypes	スケールセット内の仮想マシンの優先順位を指定します。最小 API バージョン: 2017-10-30-preview。
scheduledEventsProfile	ScheduledEventsProfile	スケジュールされたイベント関連の構成を指定します。
securityPostureReference	SecurityPostureReference	スケールセットで使用するセキュリティ体制を指定します。最小 API バージョン: 2023-03-01
securityProfile	SecurityProfile	スケールセット内の仮想マシンのセキュリティ関連のプロファイル設定を指定します。
serviceArtifactReference	ServiceArtifactReference	"最新" イメージバージョンを使用する場合に、スケールセット内のすべての仮想マシンに同じイメージバージョンを設定するために使用されるサービス成果物参照 ID を指定します。最小 API バージョン: 2022-11-01
storageProfile	VirtualMachineScaleSetStorageProfile	仮想マシンディスクのストレージ設定を指定します。
timeCreated	string	仮想マシンスケールセットのこの VM プロファイルが作成された時刻を指定します。このプロパティの最小 API バージョンは 2024-03-01 です。この値は、最小 API バージョン 2024-03-01 で VMSS VM プロファイルを作成または更新するときに、VMSS Flex VM タグに追加されます。
userData	string	スケールセット内の仮想マシンの UserData。Base-64 でエンコードする必要があります。顧客はここでシークレットを渡すべきではありません。最小 API バージョン: 2021-03-01。

VMDiskSecurityProfile

マネージドディスクのセキュリティプロファイル設定を指定します。注: 機密 VM にのみ設定できます。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	カスタマーマネージドキーで暗号化された ConfidentialVM OS ディスクと VMGuest BLOB に使用されるマネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
securityEncryptionType	securityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクの暗号化を行う場合は DiskWithVMGuestState、VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定できます。

VMGalleryApplication

コンピューティングギャラリーアプリケーションのバージョンを参照するために必要な情報を指定します

名前	型	説明
configurationReference	string	省略可能。指定された場合、パッケージの既定の構成を置き換える Azure BLOB の URI を指定します。
enableAutomaticUpgrade	boolean	true に設定すると、PIR/SIG で新しいギャラリーアプリケーションバージョンが使用可能になると、VM/VMSS に対して自動的に更新されます。
order	integer	省略可能、パッケージをインストールする必要がある順序を指定します。
packageReferenceId	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleryName}/applications/{application}/versions/{version} の形式で GalleryApplicationVersion リソース ID を指定します。
tags	string	オプション。より汎用的なコンテキストのパススルー値を指定します。
treatFailureAsDeploymentFailure	boolean	省略可能。true の場合、VmApplication での操作に対するエラーはデプロイに失敗します

VMSizeProperties

仮想マシンの VM サイズプロパティの設定を指定します。

名前	型	説明
vCPUsAvailable	integer	VM で使用できる vCPU の数を指定します。このプロパティが要求本文で指定されていない場合、既定の動作では、api 応答で公開されている VM サイズに対して使用可能な vCPU の値に設定リージョンで使用可能なすべての仮想マシンサイズを一覧表示します。
vCPUsPerCore	integer	vCPU と物理コアの比率を指定します。要求本文でこのプロパティが指定されていない場合、既定の動作は、api 応答で公開される VM サイズの vCPUPerCore の値に設定されますリージョンで使用可能なすべての仮想マシンサイズを一覧表示します。このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。

WindowsConfiguration

仮想マシン上の Windows オペレーティングシステムの設定を指定します。

名前	型	説明
additionalUnattendContent	AdditionalUnattendContent[]	Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の base-64 でエンコードされた XML 形式の情報を指定します。
enableAutomaticUpdates	boolean	Windows 仮想マシンに対して自動更新が有効になっているかどうかを示します。既定値は true です。仮想マシンスケールセットの場合、このプロパティを更新でき、更新は OS の再プロビジョニングで有効になります。
enableVMAgentPlatformUpdates	boolean	Windows 仮想マシンに対して VMAgent プラットフォーム更新プログラムが有効になっているかどうかを示します。既定値は false です。
patchSettings	PatchSettings	[プレビュー機能]Windows での VM ゲストパッチ適用に関連する設定を指定します。
provisionVMAgent	boolean	仮想マシンエージェントを仮想マシンにプロビジョニングするかどうかを示します。このプロパティが要求本文で指定されていない場合、既定では true に設定されます。これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
timeZone	string	仮想マシンのタイムゾーンを指定します。例: "太平洋標準時"。指定できる値は、TimeZoneInfo.GetSystemTimeZonesによって返されるタイムゾーンからの値 TimeZoneInfo.Id できます。
winRM	WinRMConfiguration	Windows リモート管理リスナーを指定します。これにより、リモート Windows PowerShell が有効になります。

WindowsPatchAssessmentMode

名前	型	説明
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

名前	型	説明
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Windows のパッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。

名前	型	説明
bypassPlatformSafetyChecksOnUserSchedule	boolean	お客様が誤ってアップグレードすることなく修正プログラムの適用をスケジュールできるようにします
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

WindowsVMGuestPatchMode

OrchestrationMode をフレキシブルとして使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲストパッチ適用のモードを指定します。

使用可能な値は次のとおりです。

手動 - 仮想マシンへのパッチの適用を制御します。これを行うには、VM 内でパッチを手動で適用します。このモードでは、自動更新は無効になります。プロパティ WindowsConfiguration.enableAutomaticUpdates は false にする必要があります

AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。プロパティ WindowsConfiguration.enableAutomaticUpdates は true である必要があります。

AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。 provisionVMAgent プロパティと WindowsConfiguration.enableAutomaticUpdates プロパティは true である必要があります

名前	型	説明
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

VM の Windows リモート管理の構成について説明します

名前	型	説明
listeners	WinRMListener[]	Windows リモート管理リスナーの一覧

WinRMListener

Windows リモート管理リスナーのプロトコルと拇印について説明します

名前	型	説明
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です。

次の方法で共有

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

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

ResilientVMDeletionPolicy