Virtual Machines - Get

サービス:: Compute

API バージョン:: 2025-04-01

仮想マシンのモデルビューまたはインスタンスビューに関する情報を取得します。

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

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

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
vmName	path	True	string	仮想マシンの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$expand	query		InstanceViewTypes	操作に適用する展開式。 'InstanceView' は、プラットフォームによって管理され、コントロールプレーン操作の外部で変更できる仮想マシンのランタイムプロパティのスナップショットを取得します。 'UserData' は、VM の作成/更新操作中にユーザーによって提供された VM モデルビューの一部として UserData プロパティを取得します。

応答

名前	型	説明
200 OK	VirtualMachine	Azure 操作は正常に完了しました。
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 placed on a dedicated host group through automatic placement

Get a virtual machine with Disk Controller Type Properties

Get a virtual machine with VM Size Properties

Get a Virtual Machine.

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

要求のサンプル

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2025-04-01


/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get a virtual machine placed on a dedicated host group through automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .getByResourceGroupWithResponse("myResourceGroup", "myVM", 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_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_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardD2SV3),
	// 		},
	// 		HostGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"),
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 			},
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](30),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
 */
async function getAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName);
  console.log(result);
}

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

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachines_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineResource result = await virtualMachine.GetAsync();

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

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

応答のサンプル

状態コード:: 200

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "___location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    },
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": []
    },
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Get a virtual machine with Disk Controller Type Properties

要求のサンプル

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


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

/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
     */
    /**
     * Sample code: Get a virtual machine with Disk Controller Type Properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getAVirtualMachineWithDiskControllerTypeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().getByResourceGroupWithResponse(
            "myResourceGroup", "myVM", InstanceViewTypes.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_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_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachineWithDiskControllerTypeProperties() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{Expand: to.Ptr(armcompute.InstanceViewTypesUserData)})
	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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		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"),
	// 			}},
	// 		},
	// 		AvailabilitySet: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"),
	// 		},
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 				StorageURI: to.Ptr("http://{myStorageAccount}.blob.core.windows.net"),
	// 			},
	// 		},
	// 		ExtensionsTimeBudget: to.Ptr("PT50M"),
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardDS3V2),
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("myDataDisk0"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					Lun: to.Ptr[int32](0),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("myDataDisk1"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 					DiskSizeGB: to.Ptr[int32](100),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 			}},
	// 			DiskControllerType: to.Ptr(armcompute.DiskControllerTypesNVMe),
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](30),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("west us"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
 */
async function getAVirtualMachineWithDiskControllerTypeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const expand = "userData";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName, options);
  console.log(result);
}

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

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
// this example is just showing the usage of "VirtualMachines_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
InstanceViewType? expand = InstanceViewType.UserData;
VirtualMachineResource result = await virtualMachine.GetAsync(expand: expand);

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

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

応答のサンプル

状態コード:: 200

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "___location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ],
      "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": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "___location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a virtual machine with VM Size Properties

要求のサンプル

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2025-04-01


/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
     */
    /**
     * Sample code: Get a virtual machine with VM Size Properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachineWithVMSizeProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .getByResourceGroupWithResponse("myResourceGroup", "myVM", 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_get_with_vm_size_properties.py

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


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

    response = client.virtual_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachineWithVmSizeProperties() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		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"),
	// 			}},
	// 		},
	// 		AvailabilitySet: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"),
	// 		},
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 				StorageURI: to.Ptr("http://{myStorageAccount}.blob.core.windows.net"),
	// 			},
	// 		},
	// 		ExtensionsTimeBudget: to.Ptr("PT50M"),
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardDS3V2),
	// 			VMSizeProperties: &armcompute.VMSizeProperties{
	// 				VCPUsAvailable: to.Ptr[int32](1),
	// 				VCPUsPerCore: to.Ptr[int32](1),
	// 			},
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("myDataDisk0"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					Lun: to.Ptr[int32](0),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("myDataDisk1"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 					DiskSizeGB: to.Ptr[int32](100),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](30),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("west us"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
 */
async function getAVirtualMachineWithVMSizeProperties() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName);
  console.log(result);
}

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

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
// this example is just showing the usage of "VirtualMachines_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineResource result = await virtualMachine.GetAsync();

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

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

応答のサンプル

状態コード:: 200

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "___location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "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": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "___location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a Virtual Machine.

要求のサンプル

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


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

/**
 * Samples for VirtualMachines GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/
     * virtualMachineExamples/VirtualMachine_Get.json
     */
    /**
     * Sample code: Get a Virtual Machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().getByResourceGroupWithResponse(
            "myResourceGroup", "myVM", InstanceViewTypes.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_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_machines.get(
        resource_group_name="myResourceGroup",
        vm_name="myVM",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/fb90eb1bec64c6e8ad3e288a64c84cc18742a394/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get.json
func ExampleVirtualMachinesClient_Get_getAVirtualMachine() {
	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.NewVirtualMachinesClient().Get(ctx, "myResourceGroup", "myVM", &armcompute.VirtualMachinesClientGetOptions{Expand: to.Ptr(armcompute.InstanceViewTypesUserData)})
	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.VirtualMachine = armcompute.VirtualMachine{
	// 	Name: to.Ptr("myVM"),
	// 	Type: to.Ptr("Microsoft.Compute/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"myTag1": to.Ptr("tagValue1"),
	// 	},
	// 	Etag: to.Ptr("\"1\""),
	// 	ManagedBy: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}"),
	// 	Properties: &armcompute.VirtualMachineProperties{
	// 		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"),
	// 			}},
	// 		},
	// 		AvailabilitySet: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"),
	// 		},
	// 		DiagnosticsProfile: &armcompute.DiagnosticsProfile{
	// 			BootDiagnostics: &armcompute.BootDiagnostics{
	// 				Enabled: to.Ptr(true),
	// 				StorageURI: to.Ptr("http://{myStorageAccount}.blob.core.windows.net"),
	// 			},
	// 		},
	// 		ExtensionsTimeBudget: to.Ptr("PT50M"),
	// 		HardwareProfile: &armcompute.HardwareProfile{
	// 			VMSize: to.Ptr(armcompute.VirtualMachineSizeTypesStandardDS3V2),
	// 		},
	// 		NetworkProfile: &armcompute.NetworkProfile{
	// 			NetworkInterfaces: []*armcompute.NetworkInterfaceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"),
	// 			}},
	// 		},
	// 		OSProfile: &armcompute.OSProfile{
	// 			AdminUsername: to.Ptr("admin"),
	// 			ComputerName: to.Ptr("myVM"),
	// 			Secrets: []*armcompute.VaultSecretGroup{
	// 			},
	// 			WindowsConfiguration: &armcompute.WindowsConfiguration{
	// 				EnableAutomaticUpdates: to.Ptr(false),
	// 				ProvisionVMAgent: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ProximityPlacementGroup: &armcompute.SubResource{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"),
	// 		},
	// 		StorageProfile: &armcompute.StorageProfile{
	// 			DataDisks: []*armcompute.DataDisk{
	// 				{
	// 					Name: to.Ptr("myDataDisk0"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesEmpty),
	// 					DiskSizeGB: to.Ptr[int32](30),
	// 					Lun: to.Ptr[int32](0),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("myDataDisk1"),
	// 					Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 					CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 					DiskSizeGB: to.Ptr[int32](100),
	// 					Lun: to.Ptr[int32](1),
	// 					ManagedDisk: &armcompute.ManagedDiskParameters{
	// 						ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"),
	// 						StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 					},
	// 			}},
	// 			ImageReference: &armcompute.ImageReference{
	// 				Offer: to.Ptr("WindowsServer"),
	// 				Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 				SKU: to.Ptr("2016-Datacenter"),
	// 				Version: to.Ptr("latest"),
	// 			},
	// 			OSDisk: &armcompute.OSDisk{
	// 				Name: to.Ptr("myOsDisk"),
	// 				Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 				CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 				DiskSizeGB: to.Ptr[int32](30),
	// 				ManagedDisk: &armcompute.ManagedDiskParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 					StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 				},
	// 				OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			},
	// 		},
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-27T01:02:38.313Z"); return t}()),
	// 		UserData: to.Ptr("RXhhbXBsZSBVc2VyRGF0YQ=="),
	// 		VMID: to.Ptr("0f47b100-583c-48e3-a4c0-aefc2c9bbcc1"),
	// 	},
	// 	Resources: []*armcompute.VirtualMachineExtension{
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension-DSC"),
	// 			Type: to.Ptr("Microsoft.Compute/virtualMachines/extensions"),
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC"),
	// 			Location: to.Ptr("west us"),
	// 			Tags: map[string]*string{
	// 				"displayName": to.Ptr("CustomScriptExtension-DSC"),
	// 			},
	// 			Properties: &armcompute.VirtualMachineExtensionProperties{
	// 				Type: to.Ptr("CustomScriptExtension"),
	// 				AutoUpgradeMinorVersion: to.Ptr(true),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Publisher: to.Ptr("Microsoft.Compute"),
	// 				Settings: map[string]any{
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.9"),
	// 			},
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Retrieves information about the model view or the instance view of a virtual machine.
 *
 * @summary Retrieves information about the model view or the instance view of a virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get.json
 */
async function getAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmName = "myVM";
  const expand = "userData";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.get(resourceGroupName, vmName, options);
  console.log(result);
}

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

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/examples/virtualMachineExamples/VirtualMachine_Get.json
// this example is just showing the usage of "VirtualMachines_Get" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string vmName = "myVM";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
InstanceViewType? expand = InstanceViewType.UserData;
VirtualMachineResource result = await virtualMachine.GetAsync(expand: expand);

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

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

応答のサンプル

状態コード:: 200

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "___location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "proximityPlacementGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "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": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded",
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "___location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ],
  "managedBy": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}"
}

定義

名前	説明
AdditionalCapabilities	仮想マシンまたは仮想マシンスケールセットの機能を有効または無効にします。
AdditionalUnattendContent	Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の XML 形式の情報を指定します。コンテンツは、設定名、コンポーネント名、およびコンテンツが適用されるパスによって定義されます。
AllInstancesDown	すべてのインスタンスがダウンしたときにスケジュールされたイベントを自動承認するかどうかを指定します。
ApiEntityReference	API エンティティ参照。
ApiError	API エラー。
ApiErrorBase	API エラーベース。
ApplicationProfile	VM/VMSS で使用できるようにする必要があるギャラリーアプリケーションの一覧が含まれています
AvailablePatchSummary	使用可能なパッチ・サマリーの仮想マシン・インスタンス・ビューのプロパティについて説明します。
BillingProfile	Azure スポット VM または VMSS の課金関連の詳細を指定します。最小 API バージョン: 2019-03-01。
BootDiagnostics	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。
BootDiagnosticsInstanceView	仮想マシンのブート診断のインスタンスビュー。
CachingTypes	キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。デフォルト値は、標準ストレージの場合は「なし」です。Premium ストレージの読み取り専用
CapacityReservationProfile	容量予約プロファイルのパラメーター。
CloudError	コンピュート・サービスからのエラー・レスポンス。
ComponentNames
createdByType	リソースを作成した ID の種類。
DataDisk	データディスクについて説明します。
DeleteOptions	VM が削除されたときのネットワークインターフェイスの動作を指定する
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	VM と VirtualMachineScaleSet 用に構成されたディスクコントローラーの種類を指定します。このプロパティは、オペレーティングシステムディスクと VM SKU が第 2 世代 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2) をサポートしている仮想マシンでのみサポートされています。リージョンの Microsoft.Compute SKU API の応答で VM SKU 機能の一部として返される HyperVGenerations 機能に V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list) が含まれていることを確認してください。サポートされているディスクコントローラーの種類の詳細については、https://aka.ms/azure-diskcontrollertypesを参照してください。
DiskCreateOptionTypes	仮想マシンディスクの作成方法を指定します。指定できる値はアタッチ: この値は、特殊なディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。空: この値は、空のデータディスクを作成するときに使用されます。コピー: この値は、スナップショットまたは別のディスクからデータディスクを作成するために使用されます。 Restore: この値は、ディスク復元ポイントからデータディスクを作成するために使用されます。
DiskDeleteOptionTypes	VM が削除されたときのマネージドディスクの動作を指定します (マネージドディスクを削除するかデタッチするかなど)。サポートされている値は、削除です。この値を使用すると、VM の削除時にマネージドディスクが削除されます。切り離す。この値を使用すると、VM が削除された後もマネージドディスクが保持されます。最小 API バージョン: 2021-03-01。
DiskDetachOptionTypes	ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。サポートされている値は、 ForceDetach です。 detachOption: ForceDetach は、管理対象データディスクにのみ適用されます。仮想マシンからの予期しない障害が原因でデータディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、ディスクを VM から強制的にデタッチします。このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。この機能はまだプレビュー段階です。 detachOption: 'ForceDetach' の設定と共に、データディスクの更新を 'true' に強制的にデタッチするには。
DiskEncryptionSetParameters	ディスクに指定できるカスタマーマネージドディスク暗号化セットのリソース ID のパラメーターについて説明します。注: ディスク暗号化セットのリソース ID は、マネージドディスクに対してのみ指定できます。詳細については、https://aka.ms/mdssewithcmkoverview を参照してください。
DiskEncryptionSettings	ディスクの暗号化設定について説明します
DiskInstanceView	ディスクのインスタンス・ビュー。
DomainNameLabelScopeTypes	ドメイン名ラベルスコープ。ドメイン名ラベルスコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。
EncryptionIdentity	キーコンテナー操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。
EventGridAndResourceGraph	eventGridAndResourceGraph 関連のスケジュールされたイベント関連の構成を指定します。
ExtendedLocation	拡張された場所の複合型。
ExtendedLocationTypes	拡張された場所の種類。
HardwareProfile	仮想マシンのハードウェア設定を指定します。
HostEndpointSettings	特定のホストエンドポイント設定を指定します。
HyperVGenerationType	リソースに関連付けられた HyperVGeneration タイプを指定します
ImageReference	使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。注: イメージ参照パブリッシャーとオファーは、スケールセットの作成時にのみ設定できます。
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンスビューの状態。
InstanceViewTypes
IPVersions	Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。既定値は IPv4 と見なされます。使用可能な値は、'IPv4' と 'IPv6' です。
KeyVaultKeyReference	Key Vault キーへの参照について説明します
KeyVaultSecretReference	Key Vault シークレットへの参照について説明します
LastPatchInstallationSummary	最後にインストールされたパッチの概要のプロパティについて説明します。
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 である必要があります
MaintenanceOperationResultCodeTypes	最終保守操作結果コード。
MaintenanceRedeployStatus	メンテナンス操作ステータス。
ManagedDiskParameters	マネージドディスクのパラメーター。
Mode	機能が有効になっている場合に ProxyAgent が実行されるモードを指定します。 ProxyAgent は監査または監視を開始しますが、監査モードでエンドポイントをホストする要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。既定値は [強制モード] です。
Modes	実行モードを指定します。監査モードでは、システムは、ログにアクセス拒否エントリを出力するなど、アクセス制御ポリシーを適用しているかのように機能しますが、実際にはホストエンドポイントへの要求を拒否しません。強制モードでは、システムはアクセス制御を強制し、推奨される操作モードです。
NetworkApiVersion	は、ネットワークインターフェイス構成でネットワークリソースを作成するときに使用される Microsoft.Network API のバージョンを指定します
NetworkInterfaceAuxiliaryMode	ネットワークインターフェイスリソースに対して補助モードを有効にするかどうかを指定します。
NetworkInterfaceAuxiliarySku	ネットワークインターフェイスリソースに対して補助 SKU を有効にするかどうかを指定します。
NetworkInterfaceReference	ネットワークインターフェイスの参照について説明します。
NetworkProfile	仮想マシンのネットワークインターフェイスまたはネットワーク構成を指定します。
OperatingSystemTypes	このプロパティを使用すると、ユーザーイメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。使用可能な値は、Windows Linuxです。
OSDisk	仮想マシンで使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「Azure 仮想マシンのディスクと VHD について」を参照してください。
OSImageNotificationProfile
OSProfile	仮想マシンのオペレーティングシステム設定を指定します。一部の設定は、VM をプロビジョニングした後は変更できません。
PassNames
PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで「InProgress」のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。
PatchSettings	Windows での VM ゲストパッチ適用に関連する設定を指定します。
Placement	リソース・ハードウェアの配置に関するユーザー定義の制約について説明します。
Plan	仮想マシンの作成に使用されるマーケットプレースイメージに関する情報を指定します。この要素は、Marketplace イメージにのみ使用されます。 API からマーケットプレースイメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portal で、使用するマーケットプレースイメージを見つけて、[プログラムでデプロイする ] をクリック>。必要な情報を入力し、[保存クリックします。
ProtocolTypes	WinRM リスナーのプロトコルを指定します。指定できる値は、http 、httpsです。
ProxyAgentSettings	仮想マシンまたは仮想マシンスケールセットの ProxyAgent 設定を指定します。最小 API バージョン: 2023-09-01。
PublicIPAddressSku	パブリック IP SKU について説明します。 OrchestrationMode をフレキシブルとしてのみ設定できます。
PublicIPAddressSkuName	パブリック IP SKU 名を指定する
PublicIPAddressSkuTier	パブリック IP SKU レベルを指定する
PublicIPAllocationMethod	パブリック IP 割り当ての種類を指定する
ResourceIdentityType	仮想マシンスケールセットに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンスケールセットからすべての ID を削除します。
ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy	Redeploy、Reboot、および ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。
ScheduledEventsProfile
SecurityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクの暗号化を行う場合は DiskWithVMGuestState、VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定できます。
SecurityProfile	仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。
SettingNames	コンテンツが適用される設定の名前を指定します。指定できる値は、FirstLogonCommands と AutoLogon です。
SshConfiguration	Azure で実行されている Linux ベースの VM の SSH 構成
SshPublicKey	SSH 証明書の公開キーと、公開キーが配置されている Linux VM 上のパスに関する情報が含まれています。
StatusLevelTypes	レベルコード。
StorageAccountTypes	マネージドディスクのストレージアカウントの種類を指定します。マネージド OS ディスクストレージアカウントの種類は、スケールセットの作成時にのみ設定できます。注: UltraSSD_LRSは、データディスクでのみ使用できます。 OS ディスクでは使用できません。 Standard_LRSは Standard HDD を使用します。 StandardSSD_LRSは Standard SSD を使用します。 Premium_LRSは Premium SSD を使用します。 UltraSSD_LRSは Ultra ディスクを使用します。 Premium_ZRSでは、Premium SSD ゾーン冗長ストレージが使用されます。 StandardSSD_ZRSでは、Standard SSD ゾーン冗長ストレージが使用されます。 Windows Virtual Machines でサポートされるディスクの詳細については、「https://docs.microsoft.com/azure/virtual-machines/windows/disks-types」を参照してください。Linux Virtual Machines については、https://docs.microsoft.com/azure/virtual-machines/linux/disks-types を参照してください。
StorageProfile	仮想マシンディスクのストレージ設定を指定します。
SubResource
systemData	リソースの作成と最後の変更に関連するメタデータ。
TerminateNotificationProfile
UefiSettings	仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。最小 API バージョン: 2020-12-01。
UserAssignedIdentitiesValue
UserInitiatedReboot	再起動関連のスケジュールされたイベント関連の構成を指定します。
UserInitiatedRedeploy	再デプロイ関連のスケジュールされたイベント関連の構成を指定します。
VaultCertificate	Key Vault 内の 1 つの証明書参照と、証明書が VM 上に存在する場所について説明します。
VaultSecretGroup	すべて同じ Key Vault 内にある証明書のセットについて説明します。
VirtualHardDisk	ディスクの URI について説明します。
VirtualMachine	仮想マシンについて説明します。
VirtualMachineAgentInstanceView	仮想マシンで実行されているVMエージェントのインスタンス・ビュー。
VirtualMachineEvictionPolicyTypes	Azure スポット VM/VMSS の削除ポリシーを指定します
VirtualMachineExtension	仮想マシンの拡張機能について説明します。
VirtualMachineExtensionHandlerInstanceView	仮想マシン拡張機能ハンドラーのインスタンスビュー。
VirtualMachineExtensionInstanceView	仮想マシン拡張機能のインスタンスビュー。
VirtualMachineHealthStatus	VM の正常性状態。
VirtualMachineIdentity	仮想マシンの ID。
VirtualMachineInstanceView	仮想マシンのインスタンスビュー。
VirtualMachineIpTag	パブリック IP アドレスに関連付けられている IP タグを格納します。
VirtualMachineNetworkInterfaceConfiguration	仮想マシンのネットワークインターフェイス構成について説明します。
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	仮想マシンのネットワーク構成の DNS 設定について説明します。
VirtualMachineNetworkInterfaceIPConfiguration	仮想マシンネットワークプロファイルの IP 構成について説明します。
VirtualMachinePatchStatus	仮想マシンのパッチ操作のステータス。
VirtualMachinePriorityTypes	スタンドアロン仮想マシンまたはスケールセット内の仮想マシンの優先度を指定します。 'Low' 列挙型は今後非推奨になる予定ですので、列挙型として 'Spot' を使用して Azure Spot VM/VMSS をデプロイしてください。
VirtualMachinePublicIPAddressConfiguration	仮想マシンの IP 構成の PublicIPAddress 構成について説明します
VirtualMachinePublicIPAddressDnsSettingsConfiguration	仮想マシンのネットワーク構成の DNS 設定について説明します。
VirtualMachineSizeTypes	仮想マシンのサイズを指定します。列挙型データ型は現在非推奨であり、2023 年 12 月 23 日までに削除されます。使用可能なサイズの一覧を取得するには、次の API を使用することをお勧めします。可用性セットで使用可能なすべての仮想マシンサイズの一覧表示、リージョンで使用可能なすべての仮想マシンサイズの一覧表示、サイズ変更に使用できるすべての仮想マシンサイズの一覧表示です。仮想マシンのサイズの詳細については、「仮想マシンのサイズ」を参照してください。使用可能な VM サイズは、リージョンと可用性セットによって異なります。
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 リモート管理リスナーのプロトコルと拇印について説明します
ZonePlacementPolicyType	可用性ゾーンでのリソースの配置に関するポリシーを指定します。指定できる値は、 Any (Virtual Machines に使用)、 Auto (Virtual Machine Scale Sets に使用) - 可用性ゾーンは、リソースの作成の一環としてシステムによって自動的に選択されます。

AdditionalCapabilities

Object

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

名前	型	説明
enableFips1403Encryption	boolean	このフラグにより、拡張機能の protectedSettings で FIPS 140-3 準拠の暗号化を使用できます。詳細については、https://aka.ms/linuxagentfipssupport を参照してください。
hibernationEnabled	boolean	VM の休止機能を有効または無効にするフラグ。
ultraSSDEnabled	boolean	VM または VMSS でストレージアカウントの種類がUltraSSD_LRSされた 1 つ以上のマネージドデータディスクを持つ機能を有効または無効にするフラグ。ストレージアカウントの種類がUltraSSD_LRSマネージドディスクは、このプロパティが有効になっている場合にのみ、仮想マシンまたは仮想マシンスケールセットに追加できます。

AdditionalUnattendContent

Object

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 です。

AllInstancesDown

Object

すべてのインスタンスがダウンしたときにスケジュールされたイベントを自動承認するかどうかを指定します。

名前	型	説明
automaticallyApprove	boolean	すべてのインスタンスがダウンしたときにスケジュールされたイベントを自動承認するかどうかを指定します。デフォルト値はtrueです

ApiEntityReference

Object

API エンティティ参照。

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

ApiError

Object

API エラー。

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

ApiErrorBase

Object

API エラーベース。

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

ApplicationProfile

Object

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

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

AvailablePatchSummary

Object

使用可能なパッチ・サマリーの仮想マシン・インスタンス・ビューのプロパティについて説明します。

名前	型	説明
assessmentActivityId	string	この結果を生成した操作のアクティビティ ID。 CRP ログと拡張機能ログを関連付けるために使用されます。
criticalAndSecurityPatchCount	integer (int32)	使用可能として検出され、まだインストールされていない重要なパッチまたはセキュリティパッチの数。
error	ApiError	操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。
lastModifiedTime	string (date-time)	操作が開始されたときの UTC タイムスタンプ。
otherPatchCount	integer (int32)	クリティカルとセキュリティを除く、使用可能なすべてのパッチの数。
rebootPending	boolean	VM の全体的な再起動状態。これは、部分的にインストールされたパッチがインストールを完了するために再起動する必要があるが、再起動がまだ行われていない場合に当てはまります。
startTime	string (date-time)	操作が開始されたときの UTC タイムスタンプ。
status	PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで「InProgress」のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

BillingProfile

Object

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

名前	型	説明
maxPrice	number (double)	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

Object

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

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

BootDiagnosticsInstanceView

Object

仮想マシンのブート診断のインスタンスビュー。

名前	型	説明
consoleScreenshotBlobUri	string	コンソールのスクリーンショット BLOB URI。手記：これは、ブート診断が現在管理対象ストレージで有効になっている場合には設定されません。
serialConsoleLogBlobUri	string	シリアルコンソールログ BLOB Uri。手記：これは、ブート診断が現在管理対象ストレージで有効になっている場合には設定されません。
status	InstanceViewStatus	VM のブート診断状態情報。手記：これは、ブート診断の有効化でエラーが発生した場合にのみ設定されます。

CachingTypes

列挙

キャッシュ要件を指定します。指定できる値は 、None、ReadOnly、ReadWrite です。 デフォルト値は、 標準ストレージの場合は「なし」です。Premium ストレージの読み取り専用

値	説明
None
ReadOnly
ReadWrite

CapacityReservationProfile

Object

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

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

CloudError

Object

コンピュート・サービスからのエラー・レスポンス。

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

ComponentNames

列挙

値	説明
Microsoft-Windows-Shell-Setup

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DataDisk

Object

データディスクについて説明します。

名前	型	説明
caching	CachingTypes	キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。既定の動作は、Standard Storage の場合は [なし] です。Premium Storage の ReadOnly。
createOption	DiskCreateOptionTypes	仮想マシンディスクの作成方法を指定します。指定できる値はアタッチ: この値は、特殊なディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンデータディスクを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。空: この値は、空のデータディスクを作成するときに使用されます。コピー: この値は、スナップショットまたは別のディスクからデータディスクを作成するために使用されます。 Restore: この値は、ディスク復元ポイントからデータディスクを作成するために使用されます。
deleteOption	DiskDeleteOptionTypes	VM の削除時にデータディスクを削除するかデタッチするかを指定します。指定できる値は、Delete です。この値を使用すると、VM の削除時にデータディスクが削除されます。切り離す。この値を使用すると、VM が削除された後もデータディスクが保持されます。既定値は、[デタッチに設定されます。
detachOption	DiskDetachOptionTypes	ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。サポートされている値: ForceDetach。 detachOption: ForceDetach は、マネージドデータディスクにのみ適用されます。仮想マシンからの予期しない障害が原因でデータディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、ディスクを VM から強制的にデタッチします。このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。この機能はまだプレビュー段階です。 detachOption: 'ForceDetach' の設定と共に、データディスクの更新を 'true' に強制的にデタッチするには。
diskIOPSReadWrite	integer (int64)	StorageAccountType が UltraSSD_LRS の場合のマネージドディスクの Read-Write IOPS を指定します。
diskMBpsReadWrite	integer (int64)	StorageAccountType が UltraSSD_LRS の場合のマネージドディスクの帯域幅を MB/秒で指定します。
diskSizeGB	integer (int32)	空のデータディスクのサイズをギガバイト単位で指定します。この要素を使用して、仮想マシンイメージ内のディスクのサイズを上書きできます。プロパティ 'diskSizeGB' は、ディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。
image	VirtualHardDisk	ソースユーザーイメージの仮想ハードディスク。仮想ハードディスクは、仮想マシンに接続される前にコピーされます。 SourceImage が指定されている場合、移行先の仮想ハードドライブは存在しない必要があります。
lun	integer (int32)	データディスクの論理ユニット番号を指定します。この値は、VM 内のデータディスクを識別するために使用されるため、VM に接続されているデータディスクごとに一意である必要があります。
managedDisk	ManagedDiskParameters	マネージドディスクのパラメーター。
name	string	ディスク名。
sourceResource	ApiEntityReference	ソースリソース識別子。スナップショットまたはディスクの作成元のディスク復元ポイントを指定できます。
toBeDetached	boolean	データディスクが VirtualMachine/VirtualMachineScaleset からデタッチ中かどうかを指定します。
vhd	VirtualHardDisk	仮想ハードディスク。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

DeleteOptions

列挙

VM が削除されたときのネットワークインターフェイスの動作を指定する

値	説明
Delete
Detach

DiagnosticsProfile

Object

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

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

DiffDiskOptions

列挙

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

値	説明
Local

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
ResourceDisk
NvmeDisk

DiffDiskSettings

Object

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

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

列挙

VM と VirtualMachineScaleSet 用に構成されたディスクコントローラーの種類を指定します。このプロパティは、オペレーティングシステムディスクと VM SKU が第 2 世代 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2) をサポートしている仮想マシンでのみサポートされています。リージョンの Microsoft.Compute SKU API の応答で VM SKU 機能の一部として返される HyperVGenerations 機能に V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list) が含まれていることを確認してください。サポートされているディスクコントローラーの種類の詳細については、https://aka.ms/azure-diskcontrollertypesを参照してください。

値	説明
SCSI
NVMe

DiskCreateOptionTypes

列挙

仮想マシンディスクの作成方法を指定します。指定できる値は アタッチ: この値は、特殊なディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。空: この値は、空のデータディスクを作成するときに使用されます。 コピー: この値は、スナップショットまたは別のディスクからデータディスクを作成するために使用されます。 Restore: この値は、ディスク復元ポイントからデータディスクを作成するために使用されます。

値	説明
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

列挙

VM が削除されたときのマネージドディスクの動作を指定します (マネージドディスクを削除するかデタッチするかなど)。サポートされている値は、削除です。 この値を使用すると、VM の削除時にマネージドディスクが削除されます。 切り離す。 この値を使用すると、VM が削除された後もマネージドディスクが保持されます。最小 API バージョン: 2021-03-01。

値	説明
Delete
Detach

DiskDetachOptionTypes

列挙

ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。サポートされている値は、 ForceDetach です。 detachOption: ForceDetach は、管理対象データディスクにのみ適用されます。仮想マシンからの予期しない障害が原因でデータディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、ディスクを VM から強制的にデタッチします。このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。 この機能はまだプレビュー段階です。 detachOption: 'ForceDetach' の設定と共に、データディスクの更新を 'true' に強制的にデタッチするには。

値	説明
ForceDetach

DiskEncryptionSetParameters

Object

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

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

DiskEncryptionSettings

Object

ディスクの暗号化設定について説明します

名前	型	説明
diskEncryptionKey	KeyVaultSecretReference	ディスク暗号化キー (Key Vault シークレット) の場所を指定します。
enabled	boolean	仮想マシンでディスク暗号化を有効にするかどうかを指定します。
keyEncryptionKey	KeyVaultKeyReference	Key Vault 内のキー暗号化キーの場所を指定します。

DiskInstanceView

Object

ディスクのインスタンス・ビュー。

名前	型	説明
encryptionSettings	DiskEncryptionSettings[]	OS ディスクの暗号化設定を指定します。最小 API バージョン: 2015-06-15
name	string	ディスク名。
statuses	InstanceViewStatus[]	リソースの状態情報。

DomainNameLabelScopeTypes

列挙

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

値	説明
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

EncryptionIdentity

Object

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

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

EventGridAndResourceGraph

Object

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

名前	型	説明
enable	boolean	スケジュールされたイベント関連の構成でイベントグリッドとリソースグラフが有効かどうかを指定します。
scheduledEventsApiVersion	string	配信されるスケジュールされたイベント構成スキーマのバージョンを決定するための api-version を指定します。

ExtendedLocation

Object

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

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

ExtendedLocationTypes

列挙

拡張された場所の種類。

値	説明
EdgeZone

HardwareProfile

Object

仮想マシンのハードウェア設定を指定します。

名前	型	説明
vmSize	VirtualMachineSizeTypes	仮想マシンのサイズを指定します。列挙型データ型は現在非推奨であり、2023 年 12 月 23 日までに削除されます。使用可能なサイズの一覧を取得するには、次の API を使用することをお勧めします。可用性セットで使用可能なすべての仮想マシンサイズの一覧表示、リージョンで使用可能なすべての仮想マシンサイズの一覧表示、サイズ変更に使用できるすべての仮想マシンサイズの一覧表示です。仮想マシンのサイズの詳細については、「仮想マシンのサイズ」を参照してください。使用可能な VM サイズは、リージョンと可用性セットによって異なります。
vmSizeProperties	VMSizeProperties	仮想マシンのサイズをカスタマイズするためのプロパティを指定します。最小 API バージョン: 2021-07-01。この機能はまだプレビューモードであり、VirtualMachineScaleSet ではサポートされていません。詳細については、VM カスタマイズの手順に従ってください。

HostEndpointSettings

Object

特定のホストエンドポイント設定を指定します。

名前	型	説明
inVMAccessControlProfileReferenceId	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} の形式で InVMAccessControlProfileVersion リソース ID を指定します。
mode	Modes	実行モードを指定します。監査モードでは、システムは、ログにアクセス拒否エントリを出力するなど、アクセス制御ポリシーを適用しているかのように機能しますが、実際にはホストエンドポイントへの要求を拒否しません。強制モードでは、システムはアクセス制御を強制し、推奨される操作モードです。

HyperVGenerationType

列挙

リソースに関連付けられた HyperVGeneration タイプを指定します

値	説明
V1
V2

ImageReference

Object

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

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

Object

内部エラーの詳細。

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

InstanceViewStatus

Object

インスタンスビューの状態。

名前	型	説明
code	string	状態コード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベルコード。
message	string	アラートやエラーメッセージを含む詳細なステータスメッセージ。
time	string (date-time)	状態の時刻。

InstanceViewTypes

列挙

値	説明
instanceView
userData
resiliencyView

IPVersions

列挙

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

値	説明
IPv4
IPv6

KeyVaultKeyReference

Object

Key Vault キーへの参照について説明します

名前	型	説明
keyUrl	string	Key Vault のキー暗号化キーを参照する URL。
sourceVault	SubResource	キーを含む Key Vault の相対 URL。

KeyVaultSecretReference

Object

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

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

LastPatchInstallationSummary

Object

最後にインストールされたパッチの概要のプロパティについて説明します。

名前	型	説明
error	ApiError	操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。
excludedPatchCount	integer (int32)	使用可能なすべてのパッチの数ですが、顧客指定の除外リスト一致によって明示的に除外されます。
failedPatchCount	integer (int32)	インストールに失敗したパッチの数。
installationActivityId	string	この結果を生成した操作のアクティビティ ID。 CRP ログと拡張機能ログを関連付けるために使用されます。
installedPatchCount	integer (int32)	正常にインストールされたパッチの数。
lastModifiedTime	string (date-time)	操作が開始されたときの UTC タイムスタンプ。
maintenanceWindowExceeded	boolean	操作が意図したすべてのアクションを完了する前に時間がなくなったかどうかを示します
notSelectedPatchCount	integer (int32)	使用可能なすべてのパッチの数ですが、分類または包含リストのエントリと一致しなかったためにインストールされません。
pendingPatchCount	integer (int32)	パッチのインストール操作の過程でインストールされると予想されるすべての使用可能なパッチの数。
startTime	string (date-time)	操作が開始されたときの UTC タイムスタンプ。
status	PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで「InProgress」のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

LinuxConfiguration

Object

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

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

LinuxPatchAssessmentMode

列挙

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

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

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

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

値	説明
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Object

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

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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

列挙

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

値	説明
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Object

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

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

LinuxVMGuestPatchMode

列挙

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

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

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

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

値	説明
ImageDefault
AutomaticByPlatform

MaintenanceOperationResultCodeTypes

列挙

最終保守操作結果コード。

値	説明
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Object

メンテナンス操作ステータス。

名前	型	説明
isCustomerInitiatedMaintenanceAllowed	boolean	顧客がメンテナンスの実行を許可されている場合は True。
lastOperationMessage	string	最後のメンテナンス操作に対して返されたメッセージ。
lastOperationResultCode	MaintenanceOperationResultCodeTypes	最終保守操作結果コード。
maintenanceWindowEndTime	string (date-time)	メンテナンスウィンドウの終了時刻。
maintenanceWindowStartTime	string (date-time)	メンテナンスウィンドウの開始時刻。
preMaintenanceWindowEndTime	string (date-time)	メンテナンス前のウィンドウの終了時刻。
preMaintenanceWindowStartTime	string (date-time)	事前メンテナンスウィンドウの開始時刻。

ManagedDiskParameters

Object

マネージドディスクのパラメーター。

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

Mode

列挙

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

値	説明
Audit
Enforce

Modes

列挙

実行モードを指定します。監査モードでは、システムは、ログにアクセス拒否エントリを出力するなど、アクセス制御ポリシーを適用しているかのように機能しますが、実際にはホストエンドポイントへの要求を拒否しません。強制モードでは、システムはアクセス制御を強制し、推奨される操作モードです。

値	説明
Audit
Enforce
Disabled

NetworkApiVersion

列挙

は、ネットワークインターフェイス構成でネットワークリソースを作成するときに使用される Microsoft.Network API のバージョンを指定します

値	説明
2020-11-01
2022-11-01

NetworkInterfaceAuxiliaryMode

列挙

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

値	説明
None
AcceleratedConnections
Floating

NetworkInterfaceAuxiliarySku

列挙

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

値	説明
None
A1
A2
A4
A8

NetworkInterfaceReference

Object

ネットワークインターフェイスの参照について説明します。

名前	型	説明
id	string	リソース ID
properties.deleteOption	DeleteOptions	VM が削除されたときのネットワークインターフェイスの動作を指定する
properties.primary	boolean	仮想マシンに 1 つ以上のネットワークインターフェイスがある場合のプライマリネットワークインターフェイスを指定します。

NetworkProfile

Object

仮想マシンのネットワークインターフェイスまたはネットワーク構成を指定します。

名前	型	説明
networkApiVersion	NetworkApiVersion	は、ネットワークインターフェイス構成でネットワークリソースを作成するときに使用される Microsoft.Network API のバージョンを指定します
networkInterfaceConfigurations	VirtualMachineNetworkInterfaceConfiguration[]	仮想マシンネットワークリソースの作成に使用するネットワーク構成を指定します。
networkInterfaces	NetworkInterfaceReference[]	仮想マシンに関連付けられているネットワークインターフェイスのリソース ID の一覧を指定します。

OperatingSystemTypes

列挙

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

値	説明
Windows
Linux

OSDisk

Object

仮想マシンで使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「Azure 仮想マシンのディスクと VHD について」を参照してください。

名前	型	説明
caching	CachingTypes	キャッシュ要件を指定します。指定できる値は、None、ReadOnly、ReadWrite です。既定の動作は、Standard Storage の場合は [なし] です。Premium Storage の ReadOnly。
createOption	DiskCreateOptionTypes	仮想マシンディスクの作成方法を指定します。指定できる値はアタッチ: この値は、特殊なディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。
deleteOption	DiskDeleteOptionTypes	VM の削除時に OS ディスクを削除するかデタッチするかを指定します。指定できる値は、Delete です。この値を使用すると、VM の削除時に OS ディスクが削除されます。切り離す。この値を使用すると、VM が削除された後も os ディスクが保持されます。既定値は、[デタッチに設定されます。エフェメラル OS ディスクの場合、既定値は Deleteに設定されます。ユーザーは、一時的な OS ディスクの削除オプションを変更できません。
diffDiskSettings	DiffDiskSettings	仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。
diskSizeGB	integer (int32)	空のデータディスクのサイズをギガバイト単位で指定します。この要素を使用して、仮想マシンイメージ内のディスクのサイズを上書きできます。プロパティ 'diskSizeGB' は、ディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。
encryptionSettings	DiskEncryptionSettings	OS ディスクの暗号化設定を指定します。最小 API バージョン: 2015-06-15。
image	VirtualHardDisk	ソースユーザーイメージの仮想ハードディスク。仮想ハードディスクは、仮想マシンに接続される前にコピーされます。 SourceImage が指定されている場合、移行先の仮想ハードドライブは存在しない必要があります。
managedDisk	ManagedDiskParameters	マネージドディスクのパラメーター。
name	string	ディスク名。
osType	OperatingSystemTypes	このプロパティを使用すると、ユーザーイメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。使用可能な値は、Windows Linuxです。
vhd	VirtualHardDisk	仮想ハードディスク。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

OSImageNotificationProfile

Object

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

OSProfile

Object

仮想マシンのオペレーティングシステム設定を指定します。一部の設定は、VM をプロビジョニングした後は変更できません。

名前	型	説明
adminPassword	string (password)	管理者アカウントのパスワードを指定します。最小長 (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	管理者アカウントの名前を指定します。このプロパティは、VM の作成後に更新できません。 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 に設定できます。
computerName	string	仮想マシンのホスト OS 名を指定します。 VM の作成後にこの名前を更新することはできません。最大長 (Windows): 15 文字。最大長 (Linux): 64 文字。名前付け規則と制限については、Azure インフラストラクチャサービスの実装ガイドラインを参照してください。
customData	string	カスタムデータの base-64 でエンコードされた文字列を指定します。 base-64 でエンコードされた文字列は、仮想マシン上のファイルとして保存されるバイナリ配列にデコードされます。バイナリ配列の最大長は 65535 バイトです。注: customData プロパティにシークレットやパスワードを渡さないでください。このプロパティは、VM の作成後に更新できません。プロパティ 'customData' は、ファイルとして保存される VM に渡されます。詳細については、Azure VMのカスタムデータ参照してください。 Linux 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 オペレーティングシステムの設定を指定します。

PassNames

列挙

値	説明
OobeSystem

PatchOperationStatus

列挙

操作の全体的な成功または失敗の状態。操作が完了するまで「InProgress」のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

値	説明
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

PatchSettings

Object

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

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

Placement

Object

リソース・ハードウェアの配置に関するユーザー定義の制約について説明します。

名前	型	説明
excludeZones	string[]	このプロパティは、'zonePlacementPolicy' プロパティを補完します。 'zonePlacementPolicy' が 'Any'/'Auto' に設定されている場合、システムによって選択された可用性ゾーンは、'excludeZones' で渡された可用性ゾーンの一覧に存在してはなりません。 'excludeZones' が指定されていない場合、リージョン内のすべての可用性ゾーンが選択対象と見なされます。
includeZones	string[]	このプロパティは、'zonePlacementPolicy' プロパティを補完します。 'zonePlacementPolicy' が 'Any'/'Auto' に設定されている場合、システムによって選択された可用性ゾーンは、'includeZones' で渡される可用性ゾーンの一覧に存在する必要があります。 'includeZones' が指定されていない場合、リージョン内のすべての可用性ゾーンが選択対象と見なされます。
zonePlacementPolicy	ZonePlacementPolicyType	可用性ゾーンでのリソースの配置に関するポリシーを指定します。指定できる値は、 Any (Virtual Machines に使用)、 Auto (Virtual Machine Scale Sets に使用) - 可用性ゾーンは、リソースの作成の一環としてシステムによって自動的に選択されます。

Plan

Object

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

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

ProtocolTypes

列挙

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

値	説明
Http
Https

ProxyAgentSettings

Object

仮想マシンまたは仮想マシンスケールセットの ProxyAgent 設定を指定します。最小 API バージョン: 2023-09-01。

名前	型	説明
addProxyAgentExtension	boolean	ProxyAgent 拡張機能を暗黙的にインストールするかどうかを指定します。このオプションは現在、Linux OS にのみ適用できます。
enabled	boolean	仮想マシンまたは仮想マシンスケールセットで ProxyAgent 機能を有効にする必要があるかどうかを指定します。
imds	HostEndpointSettings	仮想マシンまたは仮想マシンスケールセットの作成時に IMDS エンドポイント設定を指定します。最小 API バージョン: 2024-03-01。
keyIncarnationId	integer (int32)	このプロパティの値を大きくすると、ユーザーはゲストとホストの間の通信チャネルをセキュリティで保護するために使用されるキーをリセットできます。
mode	Mode	ProxyAgent を実行するモードを指定します。警告: このプロパティは非推奨となりました。特定の hostendpoint 設定で "mode" を指定してください。
wireServer	HostEndpointSettings	仮想マシンまたは仮想マシンスケールセットの作成時に Wire Server エンドポイントの設定を指定します。最小 API バージョン: 2024-03-01。

PublicIPAddressSku

Object

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

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

PublicIPAddressSkuName

列挙

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

値	説明
Basic
Standard

PublicIPAddressSkuTier

列挙

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

値	説明
Regional
Global

PublicIPAllocationMethod

列挙

パブリック IP 割り当ての種類を指定する

値	説明
Dynamic
Static

ResourceIdentityType

列挙

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

値	説明
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ScheduledEventsAdditionalPublishingTargets

Object

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

ScheduledEventsPolicy

Object

Redeploy、Reboot、および ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。

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

ScheduledEventsProfile

Object

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

SecurityEncryptionTypes

列挙

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

値	説明
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

SecurityProfile

Object

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

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

SecurityTypes

列挙

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

値	説明
TrustedLaunch
ConfidentialVM

SettingNames

列挙

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

値	説明
AutoLogon
FirstLogonCommands

SshConfiguration

Object

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

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

SshPublicKey

Object

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

名前	型	説明
keyData	string	SSH を使用して VM で認証するために使用される SSH 公開キー証明書。キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。 ssh キーの作成については、「Azure の Linux 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

StatusLevelTypes

列挙

レベルコード。

値	説明
Info
Warning
Error

StorageAccountTypes

列挙

マネージドディスクのストレージアカウントの種類を指定します。マネージド OS ディスクストレージアカウントの種類は、スケールセットの作成時にのみ設定できます。注: UltraSSD_LRSは、データディスクでのみ使用できます。 OS ディスクでは使用できません。 Standard_LRSは Standard HDD を使用します。 StandardSSD_LRSは Standard SSD を使用します。 Premium_LRSは Premium SSD を使用します。 UltraSSD_LRSは Ultra ディスクを使用します。 Premium_ZRSでは、Premium SSD ゾーン冗長ストレージが使用されます。 StandardSSD_ZRSでは、Standard SSD ゾーン冗長ストレージが使用されます。 Windows Virtual Machines でサポートされるディスクの詳細については、「https://docs.microsoft.com/azure/virtual-machines/windows/disks-types」を参照してください。Linux Virtual Machines については、https://docs.microsoft.com/azure/virtual-machines/linux/disks-types を参照してください。

値	説明
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageProfile

Object

仮想マシンディスクのストレージ設定を指定します。

名前	型	説明
alignRegionalDisksToVMZone	boolean	リージョンディスクを配置するか、VM ゾーンに移動するかを指定します。これは、配置プロパティが設定されている VM にのみ適用されます。この変更は元に戻すことはできません。最小 API バージョン: 2024-11-01。
dataDisks	DataDisk[]	仮想マシンにデータディスクを追加するために使用するパラメーターを指定します。ディスクの詳細については、「Azure 仮想マシンのディスクと VHD について」を参照してください。
diskControllerType	DiskControllerTypes	VM 用に構成されたディスクコントローラーの種類を指定します。注: このプロパティは、指定された最小 API バージョンのオペレーティングシステムディスクと VM サイズの機能に基づいて、"hyperVGeneration" を V2 に設定して仮想マシンが作成されている場合、既定のディスクコントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成の VM サイズを更新しない限り、ディスクコントローラーの種類を更新する前に VM の割り当てを解除する必要があります。最小 API バージョン: 2022-08-01。
imageReference	ImageReference	使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。
osDisk	OSDisk	仮想マシンで使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「Azure 仮想マシンのディスクと VHD について」を参照してください。

SubResource

Object

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

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TerminateNotificationProfile

Object

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

UefiSettings

Object

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

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

UserAssignedIdentitiesValue

Object

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。

UserInitiatedReboot

Object

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

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

UserInitiatedRedeploy

Object

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

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

VaultCertificate

Object

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":"<Base64-encoded-certificate>"、 "dataType":"pfx", "パスワード":"<pfx-ファイルパスワード>" } 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用のAzure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

VaultSecretGroup

Object

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

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

VirtualHardDisk

Object

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

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

VirtualMachine

Object

仮想マシンについて説明します。

名前	型	説明
etag	string	Etag は、VM の Create/Update/Get 応答で返されるプロパティであるため、顧客はヘッダーに指定して楽観的な更新を保証できます。
extendedLocation	ExtendedLocation	仮想マシンの拡張された場所。
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	VirtualMachineIdentity	構成されている場合は、仮想マシンの ID。
___location	string	リソースが存在する地理的な場所
managedBy	string	VM が VMSS の一部である場合、ManagedBy は Virtual Machine Scale Set (VMSS) flex ARM resourceID に設定されます。このプロパティーは、内部リソース・グループ削除の最適化のためにプラットフォームによって使用されます。
name	string	リソースの名前
placement	Placement	[配置] セクションでは、仮想マシンのハードウェア配置に対するユーザー定義の制約を指定します。このプロパティは、VM がプロビジョニングされた後は変更できません。最小 API バージョン: 2024-11-01。
plan	Plan	仮想マシンの作成に使用されるマーケットプレースイメージに関する情報を指定します。この要素は、Marketplace イメージにのみ使用されます。 API からマーケットプレースイメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portal で、使用するマーケットプレースイメージを見つけて、[プログラムでデプロイする ] をクリック>。必要な情報を入力し、[保存クリックします。
properties.additionalCapabilities	AdditionalCapabilities	仮想マシンで有効または無効になっている追加の機能を指定します。
properties.applicationProfile	ApplicationProfile	VM/VMSS で使用できるようにするギャラリーアプリケーションを指定します。
properties.availabilitySet	SubResource	仮想マシンを割り当てる可用性セットに関する情報を指定します。同じ可用性セットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。可用性セットの詳細については、「可用性セットの概要を参照してください。 Azure の計画メンテナンスの詳細については、「Azureの仮想マシンのメンテナンスと更新プログラム」を参照してください。現時点では、VM は作成時にのみ可用性セットに追加できます。 VM が追加される可用性セットは、可用性セットリソースと同じリソースグループの下に存在する必要があります。既存の VM を可用性セットに追加することはできません。このプロパティは、null 以外の properties.virtualMachineScaleSet 参照と共に存在できません。
properties.billingProfile	BillingProfile	Azure スポット仮想マシンの課金関連の詳細を指定します。最小 API バージョン: 2019-03-01。
properties.capacityReservation	CapacityReservationProfile	仮想マシンの割り当てに使用される容量予約に関する情報を指定します。最小 API バージョン: 2021-04-01。
properties.diagnosticsProfile	DiagnosticsProfile	ブート診断設定の状態を指定します。最小 API バージョン: 2015-06-15。
properties.evictionPolicy	VirtualMachineEvictionPolicyTypes	Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。 Azure Spot 仮想マシンでは、"割り当て解除" と "削除" の両方がサポートされており、最小 API バージョンは 2019-03-01 です。 Azure スポットスケールセットの場合、"割り当て解除" と "削除" の両方がサポートされ、最小 API バージョンは 2017-10-30-preview です。
properties.extensionsTimeBudget	string	すべての拡張機能の割り当て時間を指定します。期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。既定値は 90 分 (PT1H30M) です。最小 API バージョン: 2020-06-01。
properties.hardwareProfile	HardwareProfile	仮想マシンのハードウェア設定を指定します。
properties.host	SubResource	仮想マシンが存在する専用ホストに関する情報を指定します。最小 API バージョン: 2018-10-01。
properties.hostGroup	SubResource	仮想マシンが存在する専用ホストグループに関する情報を指定します。注: ユーザーは、host プロパティと hostGroup プロパティの両方を指定できません。最小 API バージョン: 2020-06-01。
properties.instanceView	VirtualMachineInstanceView	仮想マシン・インスタンス・ビュー。
properties.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
properties.networkProfile	NetworkProfile	仮想マシンのネットワークインターフェイスを指定します。
properties.osProfile	OSProfile	仮想マシンの作成時に使用されるオペレーティングシステムの設定を指定します。一部の設定は、VM をプロビジョニングした後は変更できません。
properties.platformFaultDomain	integer (int32)	仮想マシンを作成するスケールセットの論理障害ドメインを指定します。既定では、仮想マシンは、使用可能な障害ドメイン間のバランスを最適に維持する障害ドメインに自動的に割り当てられます。これは、この仮想マシンの 'virtualMachineScaleSet' プロパティが設定されている場合にのみ適用されます。参照される仮想マシンスケールセットの 'platformFaultDomainCount' が 1 より大きい必要があります。このプロパティは、仮想マシンが作成された後は更新できません。障害ドメインの割り当ては、仮想マシンインスタンスビューで表示できます。最小 API バージョン: 2020‐12‐01。
properties.priority	VirtualMachinePriorityTypes	仮想マシンの優先順位を指定します。最小 API バージョン: 2019-03-01
properties.provisioningState	string	プロビジョニング状態。応答にのみ表示されます。
properties.proximityPlacementGroup	SubResource	仮想マシンを割り当てる近接通信配置グループに関する情報を指定します。最小 API バージョン: 2018-04-01。
properties.scheduledEventsPolicy	ScheduledEventsPolicy	仮想マシンの再デプロイ、再起動、ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。
properties.scheduledEventsProfile	ScheduledEventsProfile	スケジュールされたイベント関連の構成を指定します。
properties.securityProfile	SecurityProfile	仮想マシンのセキュリティ関連のプロファイル設定を指定します。
properties.storageProfile	StorageProfile	仮想マシンディスクのストレージ設定を指定します。
properties.timeCreated	string (date-time)	仮想マシンリソースが作成された時刻を指定します。最小 API バージョン: 2021-11-01。
properties.userData	string	VM の UserData。base-64 でエンコードする必要があります。顧客はここでシークレットを渡すべきではありません。最小 API バージョン: 2021-03-01。
properties.virtualMachineScaleSet	SubResource	仮想マシンを割り当てる仮想マシンスケールセットに関する情報を指定します。同じ仮想マシンスケールセットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。現時点では、VM は作成時にのみ仮想マシンスケールセットに追加できます。既存の VM を仮想マシンスケールセットに追加することはできません。このプロパティは、null 以外の properties.availabilitySet 参照と共に存在できません。最小 API バージョン: 2019‐03‐01。
properties.vmId	string	すべての Azure IaaS VM SMBIOS にエンコードおよび格納され、プラットフォーム BIOS コマンドを使用して読み取ることができる 128 ビットの識別子である VM の一意の ID を指定します。
resources	VirtualMachineExtension[]	仮想マシンの子拡張機能リソース。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
zones	string[]	可用性ゾーン。

VirtualMachineAgentInstanceView

Object

仮想マシンで実行されているVMエージェントのインスタンス・ビュー。

名前	型	説明
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	仮想マシン拡張機能ハンドラーインスタンスビュー。
statuses	InstanceViewStatus[]	リソースの状態情報。
vmAgentVersion	string	VM エージェントのフルバージョン。

VirtualMachineEvictionPolicyTypes

列挙

Azure スポット VM/VMSS の削除ポリシーを指定します

値	説明
Deallocate
Delete

VirtualMachineExtension

Object

仮想マシンの拡張機能について説明します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
___location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.autoUpgradeMinorVersion	boolean	展開時に使用可能な場合に、拡張機能で新しいマイナーバージョンを使用する必要があるかどうかを示します。ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナーバージョンをアップグレードしません。
properties.enableAutomaticUpgrade	boolean	使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。
properties.forceUpdateTag	string	拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。
properties.instanceView	VirtualMachineExtensionInstanceView	仮想マシン拡張機能インスタンスビュー。
properties.protectedSettings		拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	参照によって渡され、キーコンテナーから使用される、拡張機能で保護された設定
properties.provisionAfterExtensions	string[]	この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。
properties.provisioningState	string	プロビジョニング状態。応答にのみ表示されます。
properties.publisher	string	拡張ハンドラーの発行元の名前。
properties.settings		拡張機能の Json 形式のパブリック設定。
properties.suppressFailures	boolean	拡張機能に起因するエラーを抑制するかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。既定値は false です。
properties.type	string	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
properties.typeHandlerVersion	string	スクリプトハンドラーのバージョンを指定します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

VirtualMachineExtensionHandlerInstanceView

Object

仮想マシン拡張機能ハンドラーのインスタンスビュー。

名前	型	説明
status	InstanceViewStatus	拡張機能ハンドラーの状態。
type	string	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
typeHandlerVersion	string	スクリプトハンドラーのバージョンを指定します。

VirtualMachineExtensionInstanceView

Object

仮想マシン拡張機能のインスタンスビュー。

名前	型	説明
name	string	仮想マシン拡張機能の名前。
statuses	InstanceViewStatus[]	リソースの状態情報。
substatuses	InstanceViewStatus[]	リソースの状態情報。
type	string	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
typeHandlerVersion	string	スクリプトハンドラーのバージョンを指定します。

VirtualMachineHealthStatus

Object

VM の正常性状態。

名前	型	説明
status	InstanceViewStatus	VM の正常性状態情報。

VirtualMachineIdentity

Object

仮想マシンの ID。

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

VirtualMachineInstanceView

Object

仮想マシンのインスタンスビュー。

名前	型	説明
assignedHost	string	仮想マシンが自動配置が有効になっている専用ホストグループに関連付けられている場合に、仮想マシンが自動配置によって割り当てられる専用ホストのリソース ID。最小 API バージョン: 2020-06-01。
bootDiagnostics	BootDiagnosticsInstanceView	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。
computerName	string	仮想マシンに割り当てられているコンピューター名。
disks	DiskInstanceView[]	仮想マシンのディスク情報。
extensions	VirtualMachineExtensionInstanceView[]	拡張機能の情報。
hyperVGeneration	HyperVGenerationType	リソースに関連付けられた HyperVGeneration タイプを指定します
isVMInStandbyPool	boolean	[プレビュー機能]VM が現在スタンバイプール内にあるか、スタンバイプールから外れているかを指定します。
maintenanceRedeployStatus	MaintenanceRedeployStatus	仮想マシンのメンテナンス操作の状態。
osName	string	仮想マシンで実行されているオペレーティングシステム。
osVersion	string	仮想マシンで実行されているオペレーティングシステムのバージョン。
patchStatus	VirtualMachinePatchStatus	[プレビュー機能]仮想マシンのパッチ操作のステータス。
platformFaultDomain	integer (int32)	仮想マシンの障害ドメインを指定します。
platformUpdateDomain	integer (int32)	仮想マシンの更新ドメインを指定します。
rdpThumbPrint	string	リモートデスクトップ証明書の拇印。
statuses	InstanceViewStatus[]	リソースの状態情報。
vmAgent	VirtualMachineAgentInstanceView	仮想マシンで実行されている VM エージェント。
vmHealth	VirtualMachineHealthStatus	VM の正常性状態。

VirtualMachineIpTag

Object

パブリック IP アドレスに関連付けられている IP タグを格納します。

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

VirtualMachineNetworkInterfaceConfiguration

Object

仮想マシンのネットワークインターフェイス構成について説明します。

名前	型	説明
name	string	ネットワークインターフェイス構成名。
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	ネットワークインターフェイスリソースに対して補助モードを有効にするかどうかを指定します。
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	ネットワークインターフェイスリソースに対して補助 SKU を有効にするかどうかを指定します。
properties.deleteOption	DeleteOptions	VM が削除されたときのネットワークインターフェイスの動作を指定する
properties.disableTcpStateTracking	boolean	TCP 状態追跡でネットワークインターフェイスを無効にするかどうかを指定します。
properties.dnsSettings	VirtualMachineNetworkInterfaceDnsSettingsConfiguration	ネットワークインターフェイスに適用される DNS 設定。
properties.dscpConfiguration	SubResource
properties.enableAcceleratedNetworking	boolean	ネットワークインターフェイスが高速ネットワーク対応かどうかを指定します。
properties.enableFpga	boolean	ネットワークインターフェイスが FPGA ネットワーク対応かどうかを指定します。
properties.enableIPForwarding	boolean	この NIC で IP 転送が有効になっているかどうか。
properties.ipConfigurations	VirtualMachineNetworkInterfaceIPConfiguration[]	ネットワークインターフェイスの IP 構成を指定します。
properties.networkSecurityGroup	SubResource	ネットワークセキュリティグループ。
properties.primary	boolean	仮想マシンに 1 つ以上のネットワークインターフェイスがある場合のプライマリネットワークインターフェイスを指定します。
tags	object	この NetworkInterfaceConfiguration によって作成された networkInterface アドレスに適用されるリソースタグ

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Object

仮想マシンのネットワーク構成の DNS 設定について説明します。

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

VirtualMachineNetworkInterfaceIPConfiguration

Object

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

名前	型	説明
name	string	IP 構成名。
properties.applicationGatewayBackendAddressPools	SubResource[]	アプリケーションゲートウェイのバックエンドアドレスプールへの参照の配列を指定します。仮想マシンは、複数のアプリケーションゲートウェイのバックエンドアドレスプールを参照できます。複数の仮想マシンで同じアプリケーションゲートウェイを使用することはできません。
properties.applicationSecurityGroups	SubResource[]	アプリケーションセキュリティグループへの参照の配列を指定します。
properties.loadBalancerBackendAddressPools	SubResource[]	ロードバランサーのバックエンドアドレスプールへの参照の配列を指定します。仮想マシンは、1 つのパブリックロードバランサーと 1 つの内部ロードバランサーのバックエンドアドレスプールを参照できます。 [複数の仮想マシンで同じ Basic SKU ロードバランサーを使用することはできません]。
properties.primary	boolean	仮想マシンに 1 つ以上のネットワークインターフェイスがある場合のプライマリネットワークインターフェイスを指定します。
properties.privateIPAddressVersion	IPVersions	Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。既定値は IPv4 と見なされます。使用可能な値は、'IPv4' と 'IPv6' です。
properties.publicIPAddressConfiguration	VirtualMachinePublicIPAddressConfiguration	publicIPAddressConfiguration。
properties.subnet	SubResource	サブネットの識別子を指定します。

VirtualMachinePatchStatus

Object

仮想マシンのパッチ操作のステータス。

名前	型	説明
availablePatchSummary	AvailablePatchSummary	仮想マシンの最新の評価操作の利用可能なパッチの概要。
configurationStatuses	InstanceViewStatus[]	指定されたpatchModeの有効化ステータス
lastPatchInstallationSummary	LastPatchInstallationSummary	仮想マシンの最新のインストール操作のインストールの概要。

VirtualMachinePriorityTypes

列挙

スタンドアロン仮想マシンまたはスケールセット内の仮想マシンの優先度を指定します。 'Low' 列挙型は今後非推奨になる予定ですので、列挙型として 'Spot' を使用して Azure Spot VM/VMSS をデプロイしてください。

値	説明
Regular
Low
Spot

VirtualMachinePublicIPAddressConfiguration

Object

仮想マシンの IP 構成の PublicIPAddress 構成について説明します

名前	型	説明
name	string	publicIP アドレス構成名。
properties.deleteOption	DeleteOptions	VM が削除されたときのパブリック IP アドレスの動作を指定する
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	publicIP アドレスに適用する DNS 設定。
properties.idleTimeoutInMinutes	integer (int32)	パブリック IP アドレスのアイドルタイムアウト。
properties.ipTags	VirtualMachineIpTag[]	パブリック IP アドレスに関連付けられている IP タグの一覧。
properties.publicIPAddressVersion	IPVersions	Api-Version 2019-07-01 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。既定値は IPv4 と見なされます。使用可能な値は、'IPv4' と 'IPv6' です。
properties.publicIPAllocationMethod	PublicIPAllocationMethod	パブリック IP 割り当ての種類を指定する
properties.publicIPPrefix	SubResource	publicIP アドレスの割り当て元の PublicIPPrefix。
sku	PublicIPAddressSku	パブリック IP SKU について説明します。 OrchestrationMode をフレキシブルとしてのみ設定できます。
tags	object	この PublicIPAddressConfiguration によって作成された publicIP アドレスに適用されるリソースタグ

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Object

仮想マシンのネットワーク構成の DNS 設定について説明します。

名前	型	説明
domainNameLabel	string	作成される PublicIPAddress リソースのドメイン名ラベルプレフィックス。生成される名前ラベルは、ドメイン名ラベルと VM ネットワークプロファイルの一意の ID を連結したものです。
domainNameLabelScope	DomainNameLabelScopeTypes	作成される PublicIPAddress リソースのドメイン名ラベルスコープ。生成された名前ラベルは、ドメイン名ラベルのスコープと VM ネットワークプロファイルの一意の ID に従って、ハッシュドメイン名ラベルとポリシーを連結したものです。

VirtualMachineSizeTypes

列挙

仮想マシンのサイズを指定します。列挙型データ型は現在非推奨であり、2023 年 12 月 23 日までに削除されます。使用可能なサイズの一覧を取得するには、次の API を使用することをお勧めします。可用性セットで使用可能なすべての仮想マシンサイズの一覧表示、リージョンで使用可能なすべての仮想マシンサイズの一覧表示、サイズ変更に使用できるすべての仮想マシンサイズの一覧表示です。仮想マシンのサイズの詳細については、「仮想マシンのサイズ」を参照してください。使用可能な VM サイズは、リージョンと可用性セットによって異なります。

値	説明
Basic_A0
Basic_A1
Basic_A2
Basic_A3
Basic_A4
Standard_A0
Standard_A1
Standard_A2
Standard_A3
Standard_A4
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A9
Standard_A10
Standard_A11
Standard_A1_v2
Standard_A2_v2
Standard_A4_v2
Standard_A8_v2
Standard_A2m_v2
Standard_A4m_v2
Standard_A8m_v2
Standard_B1s
Standard_B1ms
Standard_B2s
Standard_B2ms
Standard_B4ms
Standard_B8ms
Standard_D1
Standard_D2
Standard_D3
Standard_D4
Standard_D11
Standard_D12
Standard_D13
Standard_D14
Standard_D1_v2
Standard_D2_v2
Standard_D3_v2
Standard_D4_v2
Standard_D5_v2
Standard_D2_v3
Standard_D4_v3
Standard_D8_v3
Standard_D16_v3
Standard_D32_v3
Standard_D64_v3
Standard_D2s_v3
Standard_D4s_v3
Standard_D8s_v3
Standard_D16s_v3
Standard_D32s_v3
Standard_D64s_v3
Standard_D11_v2
Standard_D12_v2
Standard_D13_v2
Standard_D14_v2
Standard_D15_v2
Standard_DS1
Standard_DS2
Standard_DS3
Standard_DS4
Standard_DS11
Standard_DS12
Standard_DS13
Standard_DS14
Standard_DS1_v2
Standard_DS2_v2
Standard_DS3_v2
Standard_DS4_v2
Standard_DS5_v2
Standard_DS11_v2
Standard_DS12_v2
Standard_DS13_v2
Standard_DS14_v2
Standard_DS15_v2
Standard_DS13-4_v2
Standard_DS13-2_v2
Standard_DS14-8_v2
Standard_DS14-4_v2
Standard_E2_v3
Standard_E4_v3
Standard_E8_v3
Standard_E16_v3
Standard_E32_v3
Standard_E64_v3
Standard_E2s_v3
Standard_E4s_v3
Standard_E8s_v3
Standard_E16s_v3
Standard_E32s_v3
Standard_E64s_v3
Standard_E32-16_v3
Standard_E32-8s_v3
Standard_E64-32s_v3
Standard_E64-16s_v3
Standard_F1
Standard_F2
Standard_F4
Standard_F8
Standard_F16
Standard_F1s
Standard_F2s
Standard_F4s
Standard_F8s
Standard_F16s
Standard_F2s_v2
Standard_F4s_v2
Standard_F8s_v2
Standard_F16s_v2
Standard_F32s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS5
Standard_GS4-8
Standard_GS4-4
Standard_GS5-16
Standard_GS5-8
Standard_H8
Standard_H16
Standard_H8m
Standard_H16m
Standard_H16r
Standard_H16mr
Standard_L4s
Standard_L8s
Standard_L16s
Standard_L32s
Standard_M64s
Standard_M64ms
Standard_M128s
Standard_M128ms
Standard_M64-32ms
Standard_M64-16ms
Standard_M128-64ms
Standard_M128-32ms
Standard_NC6
Standard_NC12
Standard_NC24
Standard_NC24r
Standard_NC6s_v2
Standard_NC12s_v2
Standard_NC24s_v2
Standard_NC24rs_v2
Standard_NC6s_v3
Standard_NC12s_v3
Standard_NC24s_v3
Standard_NC24rs_v3
Standard_ND6s
Standard_ND12s
Standard_ND24s
Standard_ND24rs
Standard_NV6
Standard_NV12
Standard_NV24

VMDiskSecurityProfile

Object

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

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

VMGalleryApplication

Object

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

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

VMSizeProperties

Object

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

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

WindowsConfiguration

Object

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

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

WindowsPatchAssessmentMode

列挙

値	説明
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

列挙

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

値	説明
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Object

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 である必要があります

値	説明
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Object

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

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

WinRMListener

Object

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

名前	型	説明
certificateUrl	string	これは、シークレットとして Key Vault にアップロードされた証明書の URL です。 Key Vault にシークレットを追加する方法については、「キーコンテナーにキーまたはシークレットを追加する」を参照してください。この場合、証明書は、UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。 { "data":"<Base64-encoded-certificate>"、 "dataType":"pfx", "パスワード":"<pfx-ファイルパスワード>" } 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用のAzure Key Vault 仮想マシン拡張機能を使用することをお勧めします。
protocol	ProtocolTypes	WinRM リスナーのプロトコルを指定します。指定できる値は、http 、httpsです。

ZonePlacementPolicyType

列挙

可用性ゾーンでのリソースの配置に関するポリシーを指定します。指定できる値は、 Any (Virtual Machines に使用)、 Auto (Virtual Machine Scale Sets に使用) - 可用性ゾーンは、リソースの作成の一環としてシステムによって自動的に選択されます。

値	説明
Any
Auto	仮想マシンスケールセットでの自動ゾーン配置。

次の方法で共有

Virtual Machines - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

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

要求のサンプル

応答のサンプル

Get a virtual machine with Disk Controller Type Properties

要求のサンプル

応答のサンプル

Get a virtual machine with VM Size Properties

要求のサンプル

応答のサンプル

Get a Virtual Machine.

要求のサンプル

応答のサンプル

定義

AdditionalCapabilities

AdditionalUnattendContent

AllInstancesDown

ApiEntityReference

ApiError

ApiErrorBase

ApplicationProfile

AvailablePatchSummary

BillingProfile

BootDiagnostics

BootDiagnosticsInstanceView

CachingTypes

CapacityReservationProfile

CloudError

ComponentNames

createdByType

DataDisk

DeleteOptions

DiagnosticsProfile

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskDetachOptionTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskInstanceView

DomainNameLabelScopeTypes

EncryptionIdentity

EventGridAndResourceGraph

ExtendedLocation

ExtendedLocationTypes

HardwareProfile

HostEndpointSettings

HyperVGenerationType

ImageReference

InnerError

InstanceViewStatus

InstanceViewTypes

IPVersions

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

ManagedDiskParameters

Mode

Modes

NetworkApiVersion

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku