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	OK
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.

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

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

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-version: 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-version: 2015-06-15

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

DiskInstanceView

ディスク情報。

名前	型	説明
encryptionSettings	DiskEncryptionSettings[]	OS ディスクの暗号化設定を指定します。最小 api-version: 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-version: 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 の正常性状態。