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 パラメーター

名前	/	必須	型	説明
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 フロー

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

スコープ

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

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
BootDiagnosticsInstanceView	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。 コンソール ログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。
CloudError	コンピューティング サービスからのエラー応答。
DiskEncryptionSettings	OS ディスクの暗号化設定を指定します。 最小 API バージョン: 2015-06-15
DiskInstanceView	ディスク情報。
HyperVGeneration	仮想マシンのハイパーバイザー生成 [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 エラー。

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

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

Key Vault 内のキー暗号化キーの場所を指定します。

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

KeyVaultSecretReference

ディスク暗号化キー (Key Vault シークレット) の場所を指定します。

名前	型	説明
secretUrl	string	Key Vault 内のシークレットを参照する URL。
sourceVault	SubResource	シークレットを含む Key Vault の相対 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

シークレットを含む Key Vault の相対 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 の正常性状態。