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

Virtual Machine Scale Set VMs - Get Instance View

Service:

Compute

API Version:

2024-03-01

从 VM 规模集获取虚拟机的状态。

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

URI 参数

名称	在	必需	类型	说明
instanceId	path	True	string	虚拟机的实例 ID。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
vmScaleSetName	path	True	string	VM 规模集的名称。
api-version	query	True	string	客户端 API 版本。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

Sample Request

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_instance_view_auto_placed_on_dedicated_host_group.py

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


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

    response = client.virtual_machine_scale_set_vms.get_instance_view(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachineScaleSetVMsClient_GetInstanceView() {
	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.NewVirtualMachineScaleSetVMsClient().GetInstanceView(ctx, "myResourceGroup", "myVirtualMachineScaleSet", "0", 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.VirtualMachineScaleSetVMInstanceView = armcompute.VirtualMachineScaleSetVMInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	Disks: []*armcompute.DiskInstanceView{
	// 		{
	// 			Name: to.Ptr("myOSDisk"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T04:58:58.088Z"); return t}()),
	// 			}},
	// 	}},
	// 	PlatformFaultDomain: to.Ptr[int32](0),
	// 	PlatformUpdateDomain: to.Ptr[int32](0),
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-05T04:59:58.185Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/Unavailable"),
	// 				DisplayStatus: to.Ptr("Not Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesWarning),
	// 				Message: to.Ptr("VM status blob is found but not yet populated."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T05:00:32.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("Unknown"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets the status of a virtual machine from a VM scale set.
 *
 * @summary Gets the status of a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  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

Sample Response

Status code:

200

{
  "platformUpdateDomain": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "Unknown",
    "statuses": [
      {
        "code": "ProvisioningState/Unavailable",
        "level": "Warning",
        "displayStatus": "Not Ready",
        "message": "VM status blob is found but not yet populated.",
        "time": "2024-03-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2024-03-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "bootDiagnostics": null,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2020-06-05T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

定义

名称	说明
ApiError	API 错误。
ApiErrorBase	API 错误基。
BootDiagnosticsInstanceView	启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。
CloudError	来自计算服务的错误响应。
DiskEncryptionSettings	指定 OS 磁盘的加密设置。 最低 API 版本：2015-06-15
DiskInstanceView	磁盘信息。
HyperVGeneration	虚拟机的虚拟机监控程序代系 [V1， V2]
InnerError	内部错误详细信息。
InstanceViewStatus	实例视图状态。
KeyVaultKeyReference	指定密钥加密密钥在 密钥保管库 中的位置。
KeyVaultSecretReference	指定磁盘加密密钥的位置，即密钥保管库机密。
MaintenanceOperationResultCodeTypes	上次维护操作结果代码。
MaintenanceRedeployStatus	虚拟机上的维护操作状态。
StatusLevelTypes	级别代码。
SubResource	包含机密的密钥保管库的相对 URL。
VirtualMachineAgentInstanceView	虚拟机上运行的 VM 代理。
VirtualMachineExtensionHandlerInstanceView	虚拟机扩展处理程序实例视图。
VirtualMachineExtensionInstanceView	扩展信息。
VirtualMachineHealthStatus	VM 的运行状况。
VirtualMachineScaleSetVMInstanceView	虚拟机规模集 VM 的实例视图。

ApiError

API 错误。

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

ApiErrorBase

API 错误基。

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

BootDiagnosticsInstanceView

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

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

CloudError

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

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

DiskEncryptionSettings

指定 OS 磁盘的加密设置。

最低 API 版本：2015-06-15

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

DiskInstanceView

磁盘信息。

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

HyperVGeneration

虚拟机的虚拟机监控程序代系 [V1， V2]

名称	类型	说明
V1	string
V2	string

InnerError

内部错误详细信息。

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

InstanceViewStatus

实例视图状态。

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

KeyVaultKeyReference

指定密钥加密密钥在 密钥保管库 中的位置。

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

KeyVaultSecretReference

指定磁盘加密密钥的位置，即密钥保管库机密。

名称	类型	说明
secretUrl	string	引用密钥保管库中的机密的 URL。
sourceVault	SubResource	包含机密的密钥保管库的相对 URL。

MaintenanceOperationResultCodeTypes

上次维护操作结果代码。

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

MaintenanceRedeployStatus

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

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

StatusLevelTypes

级别代码。

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

SubResource

包含机密的密钥保管库的相对 URL。

名称	类型	说明
id	string	资源 ID

VirtualMachineAgentInstanceView

虚拟机上运行的 VM 代理。

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

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 的运行状况信息。

VirtualMachineScaleSetVMInstanceView

虚拟机规模集 VM 的实例视图。

名称	类型	说明
assignedHost	string	当虚拟机与启用了自动放置的专用主机组相关联时，专用主机的资源 ID（通过自动放置在该主机上分配虚拟机）。 最低 API 版本：2020-06-01。
bootDiagnostics	BootDiagnosticsInstanceView	启动诊断是一项调试功能，可用于查看控制台输出和屏幕截图以诊断 VM 状态。 可以轻松查看控制台日志的输出。 Azure 还使你能够查看虚拟机监控程序中 VM 的屏幕截图。
computerName	string	指定虚拟机的主机 OS 名称。 创建 VM 后，无法更新此名称。 最大长度 (Windows) ： 15 个字符 Linux) 的最大长度 (： 64 个字符。 有关命名约定和限制，请参阅 Azure 基础结构服务实现指南。
disks	DiskInstanceView[]	磁盘信息。
extensions	VirtualMachineExtensionInstanceView[]	扩展信息。
hyperVGeneration	HyperVGeneration	虚拟机的虚拟机监控程序代系 [V1， V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	虚拟机上的维护操作状态。
osName	string	在混合计算机上运行的操作系统。
osVersion	string	在混合计算机上运行的操作系统的版本。
placementGroupId	string	运行 VM 的放置组。 如果 VM 已解除分配，它将没有 placementGroupId。
platformFaultDomain	integer	容错域计数。
platformUpdateDomain	integer	更新域计数。
rdpThumbPrint	string	远程桌面证书指纹。
statuses	InstanceViewStatus[]	资源状态信息。
vmAgent	VirtualMachineAgentInstanceView	虚拟机上运行的 VM 代理。
vmHealth	VirtualMachineHealthStatus	VM 的运行状况。