Virtual Machine Scale Set VMs - Get Instance View

服務:

Compute

API 版本:

2024-07-01

從 VM 擴展集取得虛擬機的狀態。

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

URI 參數

名稱	位於	必要	類型	Description
instanceId	path	True	string	虛擬機的實例標識碼。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
vmScaleSetName	path	True	string	VM 擴展集的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

範例要求

HTTP

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

Java

/**
 * Samples for VirtualMachineScaleSetVMs GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through
     * automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement(
            com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().getInstanceViewWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", "0", 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

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

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

dotnet

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.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_GetInstanceView" 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 VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmInstanceView result = await virtualMachineScaleSetVm.GetInstanceViewAsync();

Console.WriteLine($"Succeeded: {result}");

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

範例回覆

狀態碼:

200

{
  "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-07-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-07-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
    }
  ]
}

定義

名稱	Description
ApiError	Api 錯誤。
ApiErrorBase	API 錯誤基底。
BootDiagnosticsInstanceView	開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。
CloudError	來自計算服務的錯誤回應。
DiskEncryptionSettings	指定 OS 磁碟的加密設定。 API 版本下限：2015-06-15
DiskInstanceView	磁碟資訊。
HyperVGeneration	虛擬機的 Hypervisor 產生 [V1， V2]
InnerError	內部錯誤詳細數據。
InstanceViewStatus	實例檢視狀態。
KeyVaultKeyReference	指定 Key Vault 中金鑰加密金鑰的位置。
KeyVaultSecretReference	指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。
MaintenanceOperationResultCodeTypes	上次維護作業結果碼。
MaintenanceRedeployStatus	虛擬機上的維護作業狀態。
StatusLevelTypes	層級程序代碼。
SubResource	包含秘密之 Key Vault 的相對 URL。
VirtualMachineAgentInstanceView	在虛擬機上執行的 VM 代理程式。
VirtualMachineExtensionHandlerInstanceView	虛擬機擴充處理程序實例檢視。
VirtualMachineExtensionInstanceView	延伸模組資訊。
VirtualMachineHealthStatus	VM 的健康情況狀態。
VirtualMachineScaleSetVMInstanceView	虛擬機擴展集 VM 的實例檢視。

ApiError

Api 錯誤。

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

ApiErrorBase

API 錯誤基底。

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

BootDiagnosticsInstanceView

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

名稱	類型	Description
consoleScreenshotBlobUri	string	控制台螢幕快照 Blob URI。 注意： 如果目前已啟用受控記憶體的開機診斷，不會 設定。
serialConsoleLogBlobUri	string	序列主控台記錄 Blob Uri。 注意： 如果目前已啟用受控記憶體的開機診斷，不會 設定。
status	InstanceViewStatus	VM 的開機診斷狀態資訊。 注意： 只有在啟用開機診斷時發生錯誤時，才會設定它。

CloudError

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

名稱	類型	Description
error	ApiError	Api 錯誤。

DiskEncryptionSettings

指定 OS 磁碟的加密設定。

API 版本下限：2015-06-15

名稱	類型	Description
diskEncryptionKey	KeyVaultSecretReference	指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。
enabled	boolean	指定是否應在虛擬機上啟用磁碟加密。
keyEncryptionKey	KeyVaultKeyReference	指定 Key Vault 中金鑰加密金鑰的位置。

DiskInstanceView

磁碟資訊。

名稱	類型	Description
encryptionSettings	DiskEncryptionSettings[]	指定 OS 磁碟的加密設定。 API 版本下限：2015-06-15
name	string	磁碟名稱。
statuses	InstanceViewStatus[]	資源狀態資訊。

HyperVGeneration

虛擬機的 Hypervisor 產生 [V1， V2]

名稱	類型	Description
V1	string
V2	string

InnerError

內部錯誤詳細數據。

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

InstanceViewStatus

實例檢視狀態。

名稱	類型	Description
code	string	狀態代碼。
displayStatus	string	狀態的簡短可當地語系化標籤。
level	StatusLevelTypes	層級程序代碼。
message	string	詳細的狀態消息，包括警示和錯誤訊息。
time	string	狀態的時間。

KeyVaultKeyReference

指定 Key Vault 中金鑰加密金鑰的位置。

名稱	類型	Description
keyUrl	string	參考 Key Vault 中金鑰加密金鑰的 URL。
sourceVault	SubResource	包含金鑰之 Key Vault 的相對 URL。

KeyVaultSecretReference

指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。

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

MaintenanceOperationResultCodeTypes

上次維護作業結果碼。

名稱	類型	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

虛擬機上的維護作業狀態。

名稱	類型	Description
isCustomerInitiatedMaintenanceAllowed	boolean	如果允許客戶執行維護，則為 True。
lastOperationMessage	string	針對上次維護作業傳回的訊息。
lastOperationResultCode	MaintenanceOperationResultCodeTypes	上次維護作業結果碼。
maintenanceWindowEndTime	string	維護時段的結束時間。
maintenanceWindowStartTime	string	維護時段的開始時間。
preMaintenanceWindowEndTime	string	維護前時段的結束時間。
preMaintenanceWindowStartTime	string	維護前時段的開始時間。

StatusLevelTypes

層級程序代碼。

名稱	類型	Description
Error	string
Info	string
Warning	string

SubResource

包含秘密之 Key Vault 的相對 URL。

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

VirtualMachineAgentInstanceView

在虛擬機上執行的 VM 代理程式。

名稱	類型	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	虛擬機擴充處理程序實例檢視。
statuses	InstanceViewStatus[]	資源狀態資訊。
vmAgentVersion	string	VM 代理程式完整版本。

VirtualMachineExtensionHandlerInstanceView

虛擬機擴充處理程序實例檢視。

名稱	類型	Description
status	InstanceViewStatus	擴充處理程序狀態。
type	string	指定延伸模組的類型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定文稿處理程式的版本。

VirtualMachineExtensionInstanceView

延伸模組資訊。

名稱	類型	Description
name	string	虛擬機擴充功能名稱。
statuses	InstanceViewStatus[]	資源狀態資訊。
substatuses	InstanceViewStatus[]	資源狀態資訊。
type	string	指定延伸模組的類型;例如“CustomScriptExtension”。
typeHandlerVersion	string	指定文稿處理程式的版本。

VirtualMachineHealthStatus

VM 的健康情況狀態。

名稱	類型	Description
status	InstanceViewStatus	VM 的健康情況狀態資訊。

VirtualMachineScaleSetVMInstanceView

虛擬機擴展集 VM 的實例檢視。

名稱	類型	Description
assignedHost	string	當虛擬機與已啟用自動放置的專用主機群組相關聯時，虛擬機會透過自動放置配置專用主機的資源標識符。 API 版本下限：2020-06-01。
bootDiagnostics	BootDiagnosticsInstanceView	開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。 您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。
computerName	string	指定虛擬機的主機OS名稱。 建立 VM 之後，無法更新此名稱。 長度上限 （Windows）： 15 個字元 長度上限（Linux）： 64 個字元。 如需命名慣例和限制，請參閱Azure 基礎結構服務實作指導方針。
disks	DiskInstanceView[]	磁碟資訊。
extensions	VirtualMachineExtensionInstanceView[]	延伸模組資訊。
hyperVGeneration	HyperVGeneration	虛擬機的 Hypervisor 產生 [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 的健康情況狀態。