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

Virtual Machines - Get

参考

服务:: Compute

API 版本:: 2024-07-01

检索有关虚拟机的模型视图或实例视图的信息。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
vmName	path	True	string	虚拟机的名称。
api-version	query	True	string	客户端 API 版本。
$expand	query		InstanceViewTypes	要应用于操作的展开表达式。 “InstanceView”检索由平台管理的虚拟机的运行时属性的快照，并且可以在控制平面操作之外进行更改。 “UserData”检索 UserData 属性，作为 VM 创建/更新操作期间用户提供的 VM 模型视图的一部分。

响应

名称	类型	说明
200 OK	VirtualMachine	还行
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get a virtual machine 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=2024-07-01


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

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

/**
 * 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/2024-07-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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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?$expand=userData&api-version=2024-07-01


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/2024-07-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/2024-07-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/v6"
)

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

/**
 * 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/2024-07-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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
InstanceViewType? expand = InstanceViewType.UserData;
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName, expand: expand);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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=2024-07-01


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

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

/**
 * 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/2024-07-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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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?$expand=userData&api-version=2024-07-01


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/2024-07-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/2024-07-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/v6"
)

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

/**
 * 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/2024-07-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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualMachineResource
VirtualMachineCollection collection = resourceGroupResource.GetVirtualMachines();

// invoke the operation
string vmName = "myVM";
InstanceViewType? expand = InstanceViewType.UserData;
NullableResponse<VirtualMachineResource> response = await collection.GetIfExistsAsync(vmName, expand: expand);
VirtualMachineResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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	指定其他 base-64 编码的 XML 格式信息，这些信息可以包含在 Windows 安装程序使用的 Unattend.xml 文件中。
ApiEntityReference	源资源标识符。它可以是用于创建磁盘的快照或磁盘还原点。
ApiError	Api 错误。
ApiErrorBase	Api 错误基数。
ApplicationProfile	指定应提供给 VM/VMSS 的库应用程序。
AvailablePatchSummary	虚拟机的最新评估操作的可用修补程序摘要。
BillingProfile	指定 Azure 现成虚拟机的计费相关详细信息。最低 API 版本：2019-03-01。
BootDiagnostics	启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。注意：如果指定 storageUri，请确保存储帐户与 VM 位于同一区域和订阅中。可以轻松查看控制台日志的输出。通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。
BootDiagnosticsInstanceView	启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图来诊断 VM 状态。可以轻松查看控制台日志的输出。通过 Azure，还可以从虚拟机监控程序查看 VM 的屏幕截图。
CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认行为为：标准存储 None。高级存储的 ReadOnly。
CapacityReservationProfile	指定有关用于分配虚拟机的容量预留的信息。最低 API 版本：2021-04-01。
CloudError	来自计算服务的错误响应。
ComponentNames	组件名称。目前，唯一允许的值是Microsoft-Windows-Shell-Setup。
DataDisk	指定用于向虚拟机添加数据磁盘的参数。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。
DeleteOptions	指定删除 VM 时网络接口发生的情况
DiagnosticsProfile	指定启动诊断设置状态。最低 API 版本：2015-06-15。
DiffDiskOptions	指定操作系统磁盘的临时磁盘设置。
DiffDiskPlacement	指定操作系统磁盘的临时磁盘放置。可能的值为：CacheDisk、ResourceDisk、NvmeDisk。默认行为为：如果为 VM 大小配置了一个，则 CacheDisk;否则，ResourceDisk 或使用 NvmeDisk。请参阅 https://docs.microsoft.com/azure/virtual-machines/linux/sizes https://docs.microsoft.com/azure/virtual-machines/windows/sizes 上的 Windows VM 和 Linux VM 的 VM 大小文档，以检查哪些 VM 大小公开了缓存磁盘。 NvmeDisk 的最低 API 版本：2024-03-01。
DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
DiskControllerTypes	指定为 VM 配置的磁盘控制器类型。注意：如果未指定提供的虚拟机，则会根据指定的最低 API 版本中的操作系统磁盘和 VM 大小的功能，使用“hyperVGeneration”设置为 V2，此属性将设置为默认磁盘控制器类型。在更新 VM 控制器类型之前，需要解除分配 VM，除非在 VM 配置中更新 VM 大小，该配置隐式解除分配并重新分配 VM。最低 API 版本：2022-08-01。
DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。
DiskDeleteOptionTypes	指定在删除 VM 时是否应删除或分离 OS 磁盘。可能的值为：Delete。如果使用此值，则删除 VM 时会删除 OS 磁盘。分离。如果使用此值，则会在删除 VM 后保留 os 磁盘。默认值设置为 Detach。对于临时 OS 磁盘，默认值设置为删除。用户无法更改临时 OS 磁盘的删除选项。
DiskDetachOptionTypes	指定要在分离磁盘时使用的分离行为，或者已在从虚拟机分离过程中使用。支持的值：ForceDetach。 detachOption：ForceDetach 仅适用于托管数据磁盘。如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段选项从 VM 强行分离磁盘。使用此分离行为时，可能不会刷新所有写入。若要强制分离数据磁盘更新到BeDetached 到“true”，以及设置 detachOption：“ForceDetach”。
DiskEncryptionSetParameters	指定托管磁盘的客户托管磁盘加密集资源 ID。
DiskEncryptionSettings	指定 OS 磁盘的加密设置。最低 API 版本：2015-06-15。
DiskInstanceView	虚拟机磁盘信息。
DomainNameLabelScopeTypes	将创建的 PublicIPAddress 资源的域名标签范围。生成的名称标签是哈希域名标签与策略的串联，根据域名标签范围和 vm 网络配置文件唯一 ID。
EncryptionIdentity	指定 ADE 用于获取 keyvault 操作的访问令牌的托管标识。
EventGridAndResourceGraph	创建 eventGridAndResourceGraph Scheduled 事件设置时使用的配置参数。
ExtendedLocation	虚拟机的扩展位置。
ExtendedLocationTypes	扩展位置的类型。
HardwareProfile	指定虚拟机的硬件设置。
HyperVGenerationType	指定与资源关联的 HyperVGeneration 类型
ImageReference	指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。
InnerError	内部错误详细信息。
InstanceViewStatus	实例视图状态。
InstanceViewTypes	要应用于操作的展开表达式。 “InstanceView”检索由平台管理的虚拟机的运行时属性的快照，并且可以在控制平面操作之外进行更改。 “UserData”检索 UserData 属性，作为 VM 创建/更新操作期间用户提供的 VM 模型视图的一部分。
IPVersions	从 Api-Version 2019-07-01 开始提供，它表示特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。可能的值为：“IPv4”和“IPv6”。
KeyVaultKeyReference	指定 Key Vault 中密钥加密密钥的位置。
KeyVaultSecretReference	由引用传递的扩展保护的设置，并从密钥保管库使用
LastPatchInstallationSummary	虚拟机最新安装操作的安装摘要。
LinuxConfiguration	指定虚拟机上的 Linux 操作系统设置。有关受支持的 Linux 分发版的列表，请参阅 Azure-Endorsed 分发版上的 Linux。
LinuxPatchAssessmentMode	指定 IaaS 虚拟机的 VM 来宾修补评估模式。可能的值包括： ImageDefault - 控制虚拟机上的修补程序评估的时间。 AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。
LinuxPatchSettings	[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
LinuxVMGuestPatchAutomaticByPlatformSettings	指定 Linux 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。
LinuxVMGuestPatchMode	指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。可能的值包括： ImageDefault - 使用虚拟机的默认修补配置。 AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 必须为 true
MaintenanceOperationResultCodeTypes	上次维护操作结果代码。
MaintenanceRedeployStatus	虚拟机上的维护操作状态。
ManagedDiskParameters	托管磁盘参数。
Mode	指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视，但不强制对审核模式下主机终结点的请求实施访问控制，而在“强制”模式下，将强制实施访问控制。默认值为“强制”模式。
NetworkApiVersion	指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本
NetworkInterfaceAuxiliaryMode	指定是否为网络接口资源启用辅助模式。
NetworkInterfaceAuxiliarySku	指定是否为网络接口资源启用辅助 SKU。
NetworkInterfaceReference	指定与虚拟机关联的网络接口的资源 ID 列表。
NetworkProfile	指定虚拟机的网络接口。
OperatingSystemTypes	操作系统类型。
OSDisk	指定有关虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。
OSImageNotificationProfile	指定 OS 映像计划事件相关配置。
OSProfile	指定创建虚拟机时使用的操作系统设置。预配 VM 后，无法更改某些设置。
PassNames	传递名称。目前，唯一允许的值是 OobeSystem。
PatchOperationStatus	操作的总体成功或失败状态。在操作完成之前，它将保持“InProgress”。此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。
PatchSettings	[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。
Plan	指定有关用于创建虚拟机的市场映像的信息。此元素仅用于市场映像。必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。在 Azure 门户中，找到要使用的市场映像，然后单击想要以编程方式部署，开始使用 ->。输入任何必需的信息，然后单击“保存。
ProtocolTypes	指定 WinRM 侦听器的协议。可能的值为：http、https。
ProxyAgentSettings	在创建虚拟机时指定 ProxyAgent 设置。最低 API 版本：2023-09-01。
PublicIPAddressSku	描述公共 IP Sku。只能将 OrchestrationMode 设置为灵活。
PublicIPAddressSkuName	指定公共 IP SKU 名称
PublicIPAddressSkuTier	指定公共 IP SKU 层
PublicIPAllocationMethod	指定公共 IP 分配类型
ResourceIdentityType	用于虚拟机的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机中删除任何标识。
ScheduledEventsAdditionalPublishingTargets	发布 scheduledEventsAdditionalPublishingTargets 时使用的配置参数。
ScheduledEventsPolicy	指定虚拟机的重新部署、重新启动和 ScheduledEventsAdditionalPublishingTargets 计划事件相关配置。
ScheduledEventsProfile	指定与计划事件相关的配置。
securityEncryptionTypes	指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。注意：只能为机密 VM 设置它。
SecurityProfile	指定虚拟机的安全相关配置文件设置。
SecurityTypes	指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。默认行为为：除非设置了此属性，否则不会启用 UefiSettings。
SettingNames	指定内容应用到的设置的名称。可能的值包括：FirstLogonCommands 和 AutoLogon。
SshConfiguration	指定 Linux OS 的 ssh 密钥配置。
SshPublicKey	用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。
StatusLevelTypes	级别代码。
StorageAccountTypes	指定托管磁盘的存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。
StorageProfile	指定虚拟机磁盘的存储设置。
SubResource	包含机密的 Key Vault 的相对 URL。
TerminateNotificationProfile	指定终止计划事件相关配置。
UefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。最低 api 版本：2020-12-01。
UserAssignedIdentities	与虚拟机关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
UserInitiatedReboot	创建 userInitiatedReboot 计划事件设置创建时使用的配置参数。
UserInitiatedRedeploy	创建 userInitiatedRedeploy 计划事件设置创建时使用的配置参数。
VaultCertificate	SourceVault 中包含证书的密钥保管库引用列表。
VaultSecretGroup	指定应安装在虚拟机上的证书集。若要在虚拟机上安装证书，建议使用适用于 Linux 的 Azure Key Vault 虚拟机扩展或适用于 Windows的 Azure Key Vault 虚拟机扩展。
VirtualHardDisk	虚拟硬盘。
VirtualMachine	描述虚拟机。
VirtualMachineAgentInstanceView	在虚拟机上运行的 VM 代理。
VirtualMachineEvictionPolicyTypes	指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。对于 Azure 现成虚拟机，支持“解除分配”和“删除”，最低 API 版本为 2019-03-01。对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。
VirtualMachineExtension	虚拟机子扩展资源。
VirtualMachineExtensionHandlerInstanceView	虚拟机扩展处理程序实例视图。
VirtualMachineExtensionInstanceView	虚拟机扩展实例视图。
VirtualMachineHealthStatus	VM 的运行状况。
VirtualMachineIdentity	虚拟机的标识（如果已配置）。
VirtualMachineInstanceView	虚拟机实例视图。
VirtualMachineIpTag	与公共 IP 地址关联的 IP 标记列表。
VirtualMachineNetworkInterfaceConfiguration	指定将用于创建虚拟机网络资源的网络配置。
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	要应用于网络接口的 dns 设置。
VirtualMachineNetworkInterfaceIPConfiguration	指定网络接口的 IP 配置。
VirtualMachinePatchStatus	[预览功能]虚拟机修补操作的状态。
VirtualMachinePriorityTypes	指定虚拟机的优先级。最低 API 版本：2019-03-01
VirtualMachinePublicIPAddressConfiguration	publicIPAddressConfiguration。
VirtualMachinePublicIPAddressDnsSettingsConfiguration	要应用于 publicIP 地址的 dns 设置。
VirtualMachineSizeTypes	指定虚拟机的大小。枚举数据类型当前已弃用，将于 2023 年 12 月 23 日删除。获取可用大小列表的建议方法是使用以下 API：列出可用性集中的所有可用虚拟机大小，列出区域中所有可用的虚拟机大小，列出所有可用的虚拟机大小以调整大小。有关虚拟机大小的详细信息，请参阅虚拟机大小。可用的 VM 大小取决于区域和可用性集。
VMDiskSecurityProfile	指定托管磁盘的安全配置文件。
VMGalleryApplication	指定应提供给 VM/VMSS 的库应用程序
VMSizeProperties	指定用于自定义虚拟机大小的属性。最低 API 版本：2021-07-01。此功能仍处于预览模式，VirtualMachineScaleSet 不支持此功能。有关详细信息，请按照 VM 自定义中的说明进行操作。
WindowsConfiguration	指定虚拟机上的 Windows 操作系统设置。
WindowsPatchAssessmentMode	指定 IaaS 虚拟机的 VM 来宾修补程序评估模式。可能的值包括： ImageDefault - 控制虚拟机上的修补程序评估的时间。 AutomaticByPlatform - 平台将触发定期修补评估。属性 provisionVMAgent 必须为 true。
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	指定所有 AutomaticByPlatform 修补程序安装操作的重新启动设置。
WindowsVMGuestPatchAutomaticByPlatformSettings	指定 Windows 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。
WindowsVMGuestPatchMode	指定 VM 来宾修补到 IaaS 虚拟机的模式，或与将 OrchestrationMode 作为灵活业务流程模式的虚拟机规模集关联的虚拟机。可能的值包括：手动 - 可以控制将修补程序应用到虚拟机。为此，请在 VM 中手动应用修补程序。在此模式下，自动更新处于禁用状态;属性 WindowsConfiguration.enableAutomaticUpdates 必须为 false AutomaticByOS - 虚拟机将由 OS 自动更新。属性 WindowsConfiguration.enableAutomaticUpdates 必须为 true。 AutomaticByPlatform - 虚拟机将由平台自动更新。属性 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 必须为 true
WinRMConfiguration	指定 Windows 远程管理侦听器。这将启用远程 Windows PowerShell。
WinRMListener	Windows 远程管理侦听器列表

AdditionalCapabilities

指定在虚拟机上启用或禁用的其他功能。

名称	类型	说明
hibernationEnabled	boolean	在 VM 上启用或禁用休眠功能的标志。
ultraSSDEnabled	boolean	启用或禁用在 VM 或 VMSS 上具有一个或多个具有UltraSSD_LRS存储帐户类型的托管数据磁盘的功能的标志。仅当此属性已启用时，才能将存储帐户类型UltraSSD_LRS的托管磁盘添加到虚拟机或虚拟机规模集。

AdditionalUnattendContent

指定其他 base-64 编码的 XML 格式信息，这些信息可以包含在 Windows 安装程序使用的 Unattend.xml 文件中。

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

ApiEntityReference

源资源标识符。它可以是用于创建磁盘的快照或磁盘还原点。

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

ApiError

Api 错误。

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

ApiErrorBase

Api 错误基数。

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

ApplicationProfile

指定应提供给 VM/VMSS 的库应用程序。

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

AvailablePatchSummary

虚拟机的最新评估操作的可用修补程序摘要。

名称	类型	说明
assessmentActivityId	string	生成此结果的操作的活动 ID。它用于跨 CRP 和扩展日志关联。
criticalAndSecurityPatchCount	integer	检测到为可用但尚未安装的关键或安全修补程序的数量。
error	ApiError	执行操作期间遇到的错误。详细信息数组包含它们的列表。
lastModifiedTime	string	操作开始时的 UTC 时间戳。
otherPatchCount	integer	排除关键和安全性的所有可用修补程序的数量。
rebootPending	boolean	VM 的总体重启状态。当部分安装的修补程序需要重新启动才能完成安装，但尚未重新启动时，情况将属实。
startTime	string	操作开始时的 UTC 时间戳。
status	PatchOperationStatus	操作的总体成功或失败状态。在操作完成之前，它将保持“InProgress”。此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。

BillingProfile

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

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

BootDiagnostics

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

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

BootDiagnosticsInstanceView

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

名称	类型	说明
consoleScreenshotBlobUri	string	控制台屏幕截图 blob URI。注意：如果当前启用了托管存储启动诊断，则不会设置此设置。
serialConsoleLogBlobUri	string	串行控制台日志 Blob Uri。注意：如果当前启用了托管存储启动诊断，则不会设置此设置。
status	InstanceViewStatus	VM 的启动诊断状态信息。注意：仅在启用启动诊断时遇到错误时设置。

CachingTypes

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

名称	类型	说明
None	string
ReadOnly	string
ReadWrite	string

CapacityReservationProfile

指定有关用于分配虚拟机的容量预留的信息。最低 API 版本：2021-04-01。

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

CloudError

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

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

ComponentNames

组件名称。目前，唯一允许的值是Microsoft-Windows-Shell-Setup。

名称	类型	说明
Microsoft-Windows-Shell-Setup	string

DataDisk

指定用于向虚拟机添加数据磁盘的参数。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认行为为：标准存储 None。高级存储的 ReadOnly。
createOption	DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机数据磁盘时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。空：创建空数据磁盘时使用此值。复制：此值用于从快照或其他磁盘创建数据磁盘。还原：此值用于从磁盘还原点创建数据磁盘。
deleteOption	DiskDeleteOptionTypes	指定在删除 VM 时是否应删除或分离数据磁盘。可能的值为：Delete。如果使用此值，则会在删除 VM 时删除数据磁盘。分离。如果使用此值，则在删除 VM 后保留数据磁盘。默认值设置为 Detach。
detachOption	DiskDetachOptionTypes	指定要在分离磁盘时使用的分离行为，或者已在从虚拟机分离过程中使用。支持的值：ForceDetach。 detachOption：ForceDetach 仅适用于托管数据磁盘。如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段选项从 VM 强行分离磁盘。使用此分离行为时，可能不会刷新所有写入。若要强制分离数据磁盘更新到BeDetached 到“true”，以及设置 detachOption：“ForceDetach”。
diskIOPSReadWrite	integer	指定存储AccountType UltraSSD_LRS时托管磁盘的 Read-Write IOPS。仅针对 VirtualMachine ScaleSet VM 磁盘返回。只能通过对 VirtualMachine 规模集的更新进行更新。
diskMBpsReadWrite	integer	UltraSSD_LRS StorageAccountType 时，指定托管磁盘的带宽（以 MB/秒为单位）。仅针对 VirtualMachine ScaleSet VM 磁盘返回。只能通过对 VirtualMachine 规模集的更新进行更新。
diskSizeGB	integer	指定空数据磁盘的大小（以 GB 为单位）。此元素可用于覆盖虚拟机映像中的磁盘大小。属性“diskSizeGB”是磁盘的字节数 x 1024^3，该值不能大于 1023。
image	VirtualHardDisk	源用户映像虚拟硬盘。在附加到虚拟机之前，将复制虚拟硬盘。如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。
lun	integer	指定数据磁盘的逻辑单元号。此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。
managedDisk	ManagedDiskParameters	托管磁盘参数。
name	string	磁盘名称。
sourceResource	ApiEntityReference	源资源标识符。它可以是用于创建磁盘的快照或磁盘还原点。
toBeDetached	boolean	指定数据磁盘是否正在从 VirtualMachine/VirtualMachineScaleset 分离
vhd	VirtualHardDisk	虚拟硬盘。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

DeleteOptions

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

名称	类型	说明
Delete	string
Detach	string

DiagnosticsProfile

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

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

DiffDiskOptions

指定操作系统磁盘的临时磁盘设置。

名称	类型	说明
Local	string

DiffDiskPlacement

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

名称	类型	说明
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

指定虚拟机使用的操作系统磁盘的临时磁盘设置。

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

DiskControllerTypes

指定为 VM 配置的磁盘控制器类型。 注意： 如果未指定提供的虚拟机，则会根据指定的最低 API 版本中的操作系统磁盘和 VM 大小的功能，使用“hyperVGeneration”设置为 V2，此属性将设置为默认磁盘控制器类型。在更新 VM 控制器类型之前，需要解除分配 VM，除非在 VM 配置中更新 VM 大小，该配置隐式解除分配并重新分配 VM。最低 API 版本：2022-08-01。

名称	类型	说明
NVMe	string
SCSI	string

DiskCreateOptionTypes

指定应如何创建虚拟机磁盘。可能的值是 附加： 使用专用磁盘创建虚拟机时，将使用此值。 FromImage： 使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。

名称	类型	说明
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

指定在删除 VM 时是否应删除或分离 OS 磁盘。可能的值为：Delete。 如果使用此值，则删除 VM 时会删除 OS 磁盘。 分离。 如果使用此值，则会在删除 VM 后保留 os 磁盘。默认值设置为 Detach。对于临时 OS 磁盘，默认值设置为删除。用户无法更改临时 OS 磁盘的删除选项。

名称	类型	说明
Delete	string
Detach	string

DiskDetachOptionTypes

指定要在分离磁盘时使用的分离行为，或者已在从虚拟机分离过程中使用。支持的值：ForceDetach。 detachOption：ForceDetach 仅适用于托管数据磁盘。如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段选项从 VM 强行分离磁盘。使用此分离行为时，可能不会刷新所有写入。若要强制分离数据磁盘更新到BeDetached 到“true”，以及设置 detachOption：“ForceDetach”。

名称	类型	说明
ForceDetach	string

DiskEncryptionSetParameters

指定托管磁盘的客户托管磁盘加密集资源 ID。

名称	类型	说明
id	string	资源 ID

DiskEncryptionSettings

指定 OS 磁盘的加密设置。最低 API 版本：2015-06-15。

名称	类型	说明
diskEncryptionKey	KeyVaultSecretReference	指定磁盘加密密钥的位置，该密钥是 Key Vault 机密。
enabled	boolean	指定是否应在虚拟机上启用磁盘加密。
keyEncryptionKey	KeyVaultKeyReference	指定 Key Vault 中密钥加密密钥的位置。

DiskInstanceView

虚拟机磁盘信息。

名称	类型	说明
encryptionSettings	DiskEncryptionSettings[]	指定 OS 磁盘的加密设置。最低 API 版本：2015-06-15
name	string	磁盘名称。
statuses	InstanceViewStatus[]	资源状态信息。

DomainNameLabelScopeTypes

将创建的 PublicIPAddress 资源的域名标签范围。生成的名称标签是哈希域名标签与策略的串联，根据域名标签范围和 vm 网络配置文件唯一 ID。

名称	类型	说明
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

EncryptionIdentity

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

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

EventGridAndResourceGraph

创建 eventGridAndResourceGraph Scheduled 事件设置时使用的配置参数。

名称	类型	说明
enable	boolean	指定是否为计划事件相关配置启用了事件网格和资源图。

ExtendedLocation

虚拟机的扩展位置。

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

ExtendedLocationTypes

扩展位置的类型。

名称	类型	说明
EdgeZone	string

HardwareProfile

指定虚拟机的硬件设置。

名称	类型	说明
vmSize	VirtualMachineSizeTypes	指定虚拟机的大小。枚举数据类型当前已弃用，将于 2023 年 12 月 23 日删除。获取可用大小列表的建议方法是使用以下 API：列出可用性集中的所有可用虚拟机大小，列出区域中所有可用的虚拟机大小，列出所有可用的虚拟机大小以调整大小。有关虚拟机大小的详细信息，请参阅虚拟机大小。可用的 VM 大小取决于区域和可用性集。
vmSizeProperties	VMSizeProperties	指定用于自定义虚拟机大小的属性。最低 API 版本：2021-07-01。此功能仍处于预览模式，VirtualMachineScaleSet 不支持此功能。有关详细信息，请按照 VM 自定义中的说明进行操作。

HyperVGenerationType

指定与资源关联的 HyperVGeneration 类型

名称	类型	说明
V1	string
V2	string

ImageReference

指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。

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

InnerError

内部错误详细信息。

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

InstanceViewStatus

实例视图状态。

名称	类型	说明
code	string	状态代码。
displayStatus	string	状态的简短可本地化标签。
level	StatusLevelTypes	级别代码。
message	string	详细状态消息，包括警报和错误消息。
time	string	状态的时间。

InstanceViewTypes

要应用于操作的展开表达式。 “InstanceView”检索由平台管理的虚拟机的运行时属性的快照，并且可以在控制平面操作之外进行更改。 “UserData”检索 UserData 属性，作为 VM 创建/更新操作期间用户提供的 VM 模型视图的一部分。

名称	类型	说明
instanceView	string
userData	string

IPVersions

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

名称	类型	说明
IPv4	string
IPv6	string

KeyVaultKeyReference

指定 Key Vault 中密钥加密密钥的位置。

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

KeyVaultSecretReference

由引用传递的扩展保护的设置，并从密钥保管库使用

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

LastPatchInstallationSummary

虚拟机最新安装操作的安装摘要。

名称	类型	说明
error	ApiError	执行操作期间遇到的错误。详细信息数组包含它们的列表。
excludedPatchCount	integer	所有可用修补程序的数量，但由客户指定的排除列表匹配显式排除。
failedPatchCount	integer	安装失败的修补程序计数。
installationActivityId	string	生成此结果的操作的活动 ID。它用于跨 CRP 和扩展日志关联。
installedPatchCount	integer	已成功安装的修补程序计数。
lastModifiedTime	string	操作开始时的 UTC 时间戳。
maintenanceWindowExceeded	boolean	描述操作是否在完成其所有预期操作之前的时间不足
notSelectedPatchCount	integer	所有可用修补程序的数量，但不会安装，因为它与分类或包含列表条目不匹配。
pendingPatchCount	integer	修补程序安装操作过程中应安装的所有可用修补程序的数量。
startTime	string	操作开始时的 UTC 时间戳。
status	PatchOperationStatus	操作的总体成功或失败状态。在操作完成之前，它将保持“InProgress”。此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。

LinuxConfiguration

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

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

LinuxPatchAssessmentMode

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

可能的值包括：

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

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

名称	类型	说明
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

[预览功能]指定与 Linux 上的 VM 来宾修补相关的设置。

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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

名称	类型	说明
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

指定 Linux 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。

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

LinuxVMGuestPatchMode

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

可能的值包括：

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

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

名称	类型	说明
AutomaticByPlatform	string
ImageDefault	string

MaintenanceOperationResultCodeTypes

上次维护操作结果代码。

名称	类型	说明
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

虚拟机上的维护操作状态。

名称	类型	说明
isCustomerInitiatedMaintenanceAllowed	boolean	如此，如果允许客户执行维护。
lastOperationMessage	string	为上次维护操作返回的消息。
lastOperationResultCode	MaintenanceOperationResultCodeTypes	上次维护操作结果代码。
maintenanceWindowEndTime	string	维护时段的结束时间。
maintenanceWindowStartTime	string	维护时段的开始时间。
preMaintenanceWindowEndTime	string	预维护时段的结束时间。
preMaintenanceWindowStartTime	string	预维护时段的开始时间。

ManagedDiskParameters

托管磁盘参数。

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

Mode

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

名称	类型	说明
Audit	string
Enforce	string

NetworkApiVersion

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

名称	类型	说明
2020-11-01	string

NetworkInterfaceAuxiliaryMode

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

名称	类型	说明
AcceleratedConnections	string
Floating	string
None	string

NetworkInterfaceAuxiliarySku

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

名称	类型	说明
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceReference

指定与虚拟机关联的网络接口的资源 ID 列表。

名称	类型	说明
id	string	资源 ID
properties.deleteOption	DeleteOptions	指定删除 VM 时网络接口发生的情况
properties.primary	boolean	指定主网络接口，以防虚拟机具有 1 个以上的网络接口。

NetworkProfile

指定虚拟机的网络接口。

名称	类型	说明
networkApiVersion	NetworkApiVersion	指定在网络接口配置中创建网络资源时使用的 Microsoft.Network API 版本
networkInterfaceConfigurations	VirtualMachineNetworkInterfaceConfiguration[]	指定将用于创建虚拟机网络资源的网络配置。
networkInterfaces	NetworkInterfaceReference[]	指定与虚拟机关联的网络接口的资源 ID 列表。

OperatingSystemTypes

操作系统类型。

名称	类型	说明
Linux	string
Windows	string

OSDisk

指定有关虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认行为为：标准存储 None。高级存储的 ReadOnly。
createOption	DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。
deleteOption	DiskDeleteOptionTypes	指定在删除 VM 时是否应删除或分离 OS 磁盘。可能的值为：Delete。如果使用此值，则删除 VM 时会删除 OS 磁盘。分离。如果使用此值，则会在删除 VM 后保留 os 磁盘。默认值设置为 Detach。对于临时 OS 磁盘，默认值设置为删除。用户无法更改临时 OS 磁盘的删除选项。
diffDiskSettings	DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
diskSizeGB	integer	指定空数据磁盘的大小（以 GB 为单位）。此元素可用于覆盖虚拟机映像中的磁盘大小。属性“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

指定 OS 映像计划事件相关配置。

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

OSProfile

指定创建虚拟机时使用的操作系统设置。预配 VM 后，无法更改某些设置。

名称	类型	说明
adminPassword	string	指定管理员帐户的密码。最小长度（Windows）： 8 个字符最小长度（Linux）： 6 个字符最大长度（Windows）： 123 个字符最大长度（Linux）： 72 个字符复杂性要求：需要满足以下 4 个条件中的 3 个字符数较低具有大写字符包含数字具有特殊字符（正则表达式匹配 [\W_]）不允许的值：“abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password！”、“Password1”、“Password22”、“iloveyou！” 若要重置密码，请参阅如何在 Windows VM 中重置远程桌面服务或其登录密码有关重置根密码，请参阅使用 VMAccess 扩展管理用户、SSH 并检查或修复 Azure Linux VM 上的磁盘
adminUsername	string	指定管理员帐户的名称。创建 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 上的自定义数据。有关将 cloud-init 用于 Linux VM，请参阅使用 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。

名称	类型	说明
OobeSystem	string

PatchOperationStatus

操作的总体成功或失败状态。在操作完成之前，它将保持“InProgress”。此时，它将变为“Unknown”、“Failed”、“Succeeded”或“CompletedWithWarnings”。

名称	类型	说明
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

PatchSettings

[预览功能]指定与 Windows 上的 VM 来宾修补相关的设置。

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

Plan

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

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

ProtocolTypes

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

名称	类型	说明
Http	string
Https	string

ProxyAgentSettings

在创建虚拟机时指定 ProxyAgent 设置。最低 API 版本：2023-09-01。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机或虚拟机规模集上启用 ProxyAgent 功能。
keyIncarnationId	integer	增加此属性的值允许用户重置用于保护来宾和主机之间的通信通道的密钥。
mode	Mode	指定在启用该功能时 ProxyAgent 将执行的模式。 ProxyAgent 将开始审核或监视，但不强制对审核模式下主机终结点的请求实施访问控制，而在“强制”模式下，将强制实施访问控制。默认值为“强制”模式。

PublicIPAddressSku

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

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

PublicIPAddressSkuName

指定公共 IP SKU 名称

名称	类型	说明
Basic	string
Standard	string

PublicIPAddressSkuTier

指定公共 IP SKU 层

名称	类型	说明
Global	string
Regional	string

PublicIPAllocationMethod

指定公共 IP 分配类型

名称	类型	说明
Dynamic	string
Static	string

ResourceIdentityType

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

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ScheduledEventsAdditionalPublishingTargets

发布 scheduledEventsAdditionalPublishingTargets 时使用的配置参数。

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

ScheduledEventsPolicy

指定虚拟机的重新部署、重新启动和 ScheduledEventsAdditionalPublishingTargets 计划事件相关配置。

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

ScheduledEventsProfile

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

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

securityEncryptionTypes

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

名称	类型	说明
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

指定虚拟机的安全相关配置文件设置。

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

SecurityTypes

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

名称	类型	说明
ConfidentialVM	string
TrustedLaunch	string

SettingNames

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

名称	类型	说明
AutoLogon	string
FirstLogonCommands	string

SshConfiguration

指定 Linux OS 的 ssh 密钥配置。

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

SshPublicKey

用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。

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

StatusLevelTypes

级别代码。

名称	类型	说明
Error	string
Info	string
Warning	string

StorageAccountTypes

指定托管磁盘的存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。

名称	类型	说明
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

指定虚拟机磁盘的存储设置。

名称	类型	说明
dataDisks	DataDisk[]	指定用于向虚拟机添加数据磁盘的参数。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。
diskControllerType	DiskControllerTypes	指定为 VM 配置的磁盘控制器类型。注意：如果未指定提供的虚拟机，则会根据指定的最低 API 版本中的操作系统磁盘和 VM 大小的功能，使用“hyperVGeneration”设置为 V2，此属性将设置为默认磁盘控制器类型。在更新 VM 控制器类型之前，需要解除分配 VM，除非在 VM 配置中更新 VM 大小，该配置隐式解除分配并重新分配 VM。最低 API 版本：2022-08-01。
imageReference	ImageReference	指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。
osDisk	OSDisk	指定有关虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。

SubResource

包含机密的 Key Vault 的相对 URL。

名称	类型	说明
id	string	资源 ID

TerminateNotificationProfile

指定终止计划事件相关配置。

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

UefiSettings

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

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

UserAssignedIdentities

与虚拟机关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明

UserInitiatedReboot

创建 userInitiatedReboot 计划事件设置创建时使用的配置参数。

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

UserInitiatedRedeploy

创建 userInitiatedRedeploy 计划事件设置创建时使用的配置参数。

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

VaultCertificate

SourceVault 中包含证书的密钥保管库引用列表。

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

VaultSecretGroup

指定应安装在虚拟机上的证书集。若要在虚拟机上安装证书，建议使用适用于 Linux 的 Azure Key Vault 虚拟机扩展或适用于 Windows的 Azure Key Vault 虚拟机扩展。

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

VirtualHardDisk

虚拟硬盘。

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

VirtualMachine

描述虚拟机。

名称	类型	说明
etag	string	Etag 是在 VM 的 Create/Update/Get 响应中返回的属性，以便客户可以在标头中提供它，以确保乐观更新。
extendedLocation	ExtendedLocation	虚拟机的扩展位置。
id	string	资源 ID
identity	VirtualMachineIdentity	虚拟机的标识（如果已配置）。
location	string	资源位置
managedBy	string	如果 VM 是 VMSS 的一部分，则 ManagedBy 设置为虚拟机规模集（VMSS）弹性 ARM 资源 ID。此属性由平台用于内部资源组删除优化。
name	string	资源名称
plan	Plan	指定有关用于创建虚拟机的市场映像的信息。此元素仅用于市场映像。必须先启用映像以编程方式使用映像，然后才能从 API 使用市场映像。在 Azure 门户中，找到要使用的市场映像，然后单击想要以编程方式部署，开始使用 ->。输入任何必需的信息，然后单击“保存。
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 Spot 规模集的逐出策略。对于 Azure 现成虚拟机，支持“解除分配”和“删除”，最低 API 版本为 2019-03-01。对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 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	指定有关虚拟机所在的专用主机组的信息。注意：用户不能同时指定主机和 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	指定要在其中创建虚拟机的规模集逻辑容错域。默认情况下，虚拟机将自动分配给容错域，该容错域最适合跨可用容错域保持平衡。仅当设置了此虚拟机的“virtualMachineScaleSet”属性时，这才适用。引用的虚拟机规模集必须具有大于 1 的“platformFaultDomainCount”。创建虚拟机后，无法更新此属性。可以在虚拟机实例视图中查看容错域分配。最低 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 计划事件相关配置。
properties.scheduledEventsProfile	ScheduledEventsProfile	指定与计划事件相关的配置。
properties.securityProfile	SecurityProfile	指定虚拟机的安全相关配置文件设置。
properties.storageProfile	StorageProfile	指定虚拟机磁盘的存储设置。
properties.timeCreated	string	指定创建虚拟机资源的时间。最低 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	指定 VM 唯一 ID，该 ID 是一个 128 位标识符，该标识符已编码并存储在所有 Azure IaaS VM SMBIOS 中，并且可以使用平台 BIOS 命令进行读取。
resources	VirtualMachineExtension[]	虚拟机子扩展资源。
tags	object	资源标记
type	string	资源类型
zones	string[]	虚拟机区域。

VirtualMachineAgentInstanceView

在虚拟机上运行的 VM 代理。

名称	类型	说明
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	虚拟机扩展处理程序实例视图。
statuses	InstanceViewStatus[]	资源状态信息。
vmAgentVersion	string	VM 代理完整版本。

VirtualMachineEvictionPolicyTypes

指定 Azure 现成虚拟机和 Azure Spot 规模集的逐出策略。对于 Azure 现成虚拟机，支持“解除分配”和“删除”，最低 API 版本为 2019-03-01。对于 Azure Spot 规模集，支持“Deallocate”和“Delete”，最低 API 版本为 2017-10-30-preview。

名称	类型	说明
Deallocate	string
Delete	string

VirtualMachineExtension

虚拟机子扩展资源。

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

VirtualMachineExtensionHandlerInstanceView

虚拟机扩展处理程序实例视图。

名称	类型	说明
status	InstanceViewStatus	扩展处理程序状态。
type	string	指定扩展的类型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定脚本处理程序的版本。

VirtualMachineExtensionInstanceView

虚拟机扩展实例视图。

名称	类型	说明
name	string	虚拟机扩展名称。
statuses	InstanceViewStatus[]	资源状态信息。
substatuses	InstanceViewStatus[]	资源状态信息。
type	string	指定扩展的类型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定脚本处理程序的版本。

VirtualMachineHealthStatus

VM 的运行状况。

名称	类型	说明
status	InstanceViewStatus	VM 的运行状况信息。

VirtualMachineIdentity

虚拟机的标识（如果已配置）。

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

VirtualMachineInstanceView

虚拟机实例视图。

名称	类型	说明
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	指定虚拟机的容错域。
platformUpdateDomain	integer	指定虚拟机的更新域。
rdpThumbPrint	string	远程桌面证书指纹。
statuses	InstanceViewStatus[]	资源状态信息。
vmAgent	VirtualMachineAgentInstanceView	在虚拟机上运行的 VM 代理。
vmHealth	VirtualMachineHealthStatus	VM 的运行状况。

VirtualMachineIpTag

与公共 IP 地址关联的 IP 标记列表。

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

VirtualMachineNetworkInterfaceConfiguration

指定将用于创建虚拟机网络资源的网络配置。

名称	类型	说明
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 个以上的网络接口。

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

要应用于网络接口的 dns 设置。

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

VirtualMachineNetworkInterfaceIPConfiguration

指定网络接口的 IP 配置。

名称	类型	说明
name	string	IP 配置名称。
properties.applicationGatewayBackendAddressPools	SubResource[]	指定对应用程序网关后端地址池的引用数组。虚拟机可以引用多个应用程序网关的后端地址池。多个虚拟机不能使用相同的应用程序网关。
properties.applicationSecurityGroups	SubResource[]	指定对应用程序安全组的引用数组。
properties.loadBalancerBackendAddressPools	SubResource[]	指定对负载均衡器后端地址池的引用数组。虚拟机可以引用一个公共负载均衡器和一个内部负载均衡器的后端地址池。 [多个虚拟机不能使用相同的基本 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

[预览功能]虚拟机修补操作的状态。

名称	类型	说明
availablePatchSummary	AvailablePatchSummary	虚拟机的最新评估操作的可用修补程序摘要。
configurationStatuses	InstanceViewStatus[]	指定 patchMode 的启用状态
lastPatchInstallationSummary	LastPatchInstallationSummary	虚拟机最新安装操作的安装摘要。

VirtualMachinePriorityTypes

指定虚拟机的优先级。最低 API 版本：2019-03-01

名称	类型	说明
Low	string
Regular	string
Spot	string

VirtualMachinePublicIPAddressConfiguration

publicIPAddressConfiguration。

名称	类型	说明
name	string	publicIP 地址配置名称。
properties.deleteOption	DeleteOptions	指定删除 VM 时公共 IP 地址发生的情况
properties.dnsSettings	VirtualMachinePublicIPAddressDnsSettingsConfiguration	要应用于 publicIP 地址的 dns 设置。
properties.idleTimeoutInMinutes	integer	公共 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 设置为灵活。

VirtualMachinePublicIPAddressDnsSettingsConfiguration

要应用于 publicIP 地址的 dns 设置。

名称	类型	说明
domainNameLabel	string	将创建的 PublicIPAddress 资源的域名标签前缀。生成的名称标签是域名标签和 vm 网络配置文件唯一 ID 的串联。
domainNameLabelScope	DomainNameLabelScopeTypes	将创建的 PublicIPAddress 资源的域名标签范围。生成的名称标签是哈希域名标签与策略的串联，根据域名标签范围和 vm 网络配置文件唯一 ID。

VirtualMachineSizeTypes

指定虚拟机的大小。枚举数据类型当前已弃用，将于 2023 年 12 月 23 日删除。获取可用大小列表的建议方法是使用以下 API：列出可用性集中的所有可用虚拟机大小，列出区域中所有可用的虚拟机大小，列出所有可用的虚拟机大小以调整大小。有关虚拟机大小的详细信息，请参阅虚拟机大小。可用的 VM 大小取决于区域和可用性集。

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

VMDiskSecurityProfile

指定托管磁盘的安全配置文件。

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

VMGalleryApplication

指定应提供给 VM/VMSS 的库应用程序

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

VMSizeProperties

指定用于自定义虚拟机大小的属性。最低 API 版本：2021-07-01。此功能仍处于预览模式，VirtualMachineScaleSet 不支持此功能。有关详细信息，请按照 VM 自定义中的说明进行操作。

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

WindowsConfiguration

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

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

WindowsPatchAssessmentMode

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

可能的值包括：

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

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

名称	类型	说明
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

名称	类型	说明
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

指定 Windows 上的 VM 来宾修补中修补程序模式 AutomaticByPlatform 的其他设置。

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

WindowsVMGuestPatchMode

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

可能的值包括：

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

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

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

名称	类型	说明
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

指定 Windows 远程管理侦听器。这将启用远程 Windows PowerShell。

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

WinRMListener

Windows 远程管理侦听器列表

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