Virtual Machine Scale Set VMs - Get Instance View

サービス:: Compute

API バージョン:: 2025-11-01

VM スケールセットから仮想マシンの状態を取得します。

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

URI パラメーター

名前	/	必須	型	説明
instanceId	path	True	string	仮想マシンのインスタンス ID。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
vmScaleSetName	path	True	string	VM スケールセットの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	VirtualMachineScaleSetVMInstanceView	Azureの運用は無事に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: 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=2025-11-01

応答のサンプル

状態コード:: 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": "2025-04-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2025-04-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	仮想マシンのブート診断のインスタンスビュー。
CloudError	コンピューティングサービスからのエラー応答。
DiskEncryptionSettings	ディスクの暗号化設定について説明します
DiskInstanceView	ディスクのインスタンスビュー。
HyperVGeneration	仮想マシンのハイパーバイザー生成 [V1,V2]
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンスビューの状態。
KeyVaultKeyReference	Key Vault Keyへの言及を説明します
KeyVaultSecretReference	Key Vault Secretへの言及を説明しています
MaintenanceOperationResultCodeTypes	最後のメンテナンス操作の結果コード。
MaintenanceRedeployStatus	メンテナンス操作の状態。
StatusLevelTypes	レベルコード。
StorageAlignmentStatus	ディスクのストレージアライメント状態を指定します。
SubResource
VirtualMachineAgentInstanceView	仮想マシンで実行されている VM エージェントのインスタンスビュー。
VirtualMachineExtensionHandlerInstanceView	仮想マシン拡張機能ハンドラーのインスタンスビュー。
VirtualMachineExtensionInstanceView	仮想マシン拡張機能のインスタンスビュー。
VirtualMachineHealthStatus	VM の正常性状態。
VirtualMachineScaleSetVMInstanceView	仮想マシンスケールセット VM のインスタンスビュー。

ApiError

Object

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

Object

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

BootDiagnosticsInstanceView

Object

仮想マシンのブート診断のインスタンスビュー。

名前	型	説明
consoleScreenshotBlobUri	string	コンソールのスクリーンショット BLOB URI。注: ブート診断がマネージドストレージで現在有効になっている場合、これは設定。
serialConsoleLogBlobUri	string	シリアルコンソールログ BLOB URI。注: ブート診断がマネージドストレージで現在有効になっている場合、これは設定。
status	InstanceViewStatus	VM のブート診断の状態情報。注: ブート診断の有効化でエラーが発生した場合にのみ設定されます。

CloudError

Object

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

DiskEncryptionSettings

Object

ディスクの暗号化設定について説明します

名前	型	説明
diskEncryptionKey	KeyVaultSecretReference	ディスク暗号化鍵の場所を指定することであり、それはKey Vault Secretです。
enabled	boolean	仮想マシンでディスク暗号化を有効にするかどうかを指定します。
keyEncryptionKey	KeyVaultKeyReference	Key Vault内の鍵暗号鍵の場所を指定します。

DiskInstanceView

Object

ディスクのインスタンスビュー。

名前	型	説明
encryptionSettings	DiskEncryptionSettings[]	OS ディスクの暗号化設定を指定します。最小 API バージョン: 2015-06-15
name	string	ディスク名。
statuses	InstanceViewStatus[]	リソースの状態情報。
storageAlignmentStatus	StorageAlignmentStatus	ディスクのストレージアライメント状態を指定します。

HyperVGeneration

列挙

仮想マシンのハイパーバイザー生成 [V1,V2]

値	説明
V1
V2

InnerError

Object

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

InstanceViewStatus

Object

インスタンスビューの状態。

名前	型	説明
code	string	状態コード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベルコード。
message	string	アラートやエラーメッセージを含む詳細なステータスメッセージ。
time	string (date-time)	状態の時刻。

KeyVaultKeyReference

Object

Key Vault Keyへの言及を説明します

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

KeyVaultSecretReference

Object

Key Vault Secretへの言及を説明しています

名前	型	説明
secretUrl	string	Key Vault内の秘密を参照するURLです。
sourceVault	SubResource	秘密を含むKey Vaultの相関URLです。

MaintenanceOperationResultCodeTypes

列挙

最後のメンテナンス操作の結果コード。

値	説明
None
RetryLater
MaintenanceAborted
MaintenanceCompleted

MaintenanceRedeployStatus

Object

メンテナンス操作の状態。

名前	型	説明
isCustomerInitiatedMaintenanceAllowed	boolean	True の場合は、お客様がメンテナンスを実行できます。
lastOperationMessage	string	最後のメンテナンス操作に関して返されたメッセージ。
lastOperationResultCode	MaintenanceOperationResultCodeTypes	最後のメンテナンス操作の結果コード。
maintenanceWindowEndTime	string (date-time)	メンテナンス期間の終了時刻。
maintenanceWindowStartTime	string (date-time)	メンテナンス期間の開始時刻。
preMaintenanceWindowEndTime	string (date-time)	メンテナンス前期間の終了時刻。
preMaintenanceWindowStartTime	string (date-time)	メンテナンス前期間の開始時刻。

StatusLevelTypes

列挙

レベルコード。

値	説明
Info
Warning
Error

StorageAlignmentStatus

列挙

ディスクのストレージアライメント状態を指定します。

値	説明
Unaligned	ディスクには故障ドメインのマッピングを計算するためのストレージ障害ドメイン(Storage Fault Domain)はありません。単一のストレージフォールトドメイン障害が、このディスクプロファイルを参照するすべてのVMに影響を及ぼす可能性があります。
Aligned	ディスクにはストレージフォールトドメインがあり、フォールトドメインのマッピングを計算します。ストレージフォールトドメインの障害は、単一のコンピュートフォールトドメイン内のVMに限定されます。

SubResource

Object

名前	型	説明
id	string	リソース ID

VirtualMachineAgentInstanceView

Object

仮想マシンで実行されている VM エージェントのインスタンスビュー。

名前	型	説明
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	仮想マシン拡張機能ハンドラーインスタンスビュー。
statuses	InstanceViewStatus[]	リソースの状態情報。
vmAgentVersion	string	VM エージェントの完全なバージョン。

VirtualMachineExtensionHandlerInstanceView

Object

仮想マシン拡張機能ハンドラーのインスタンスビュー。

名前	型	説明
status	InstanceViewStatus	拡張機能ハンドラーの状態。
type	string	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
typeHandlerVersion	string	スクリプトハンドラーのバージョンを指定します。

VirtualMachineExtensionInstanceView

Object

仮想マシン拡張機能のインスタンスビュー。

名前	型	説明
name	string	仮想マシン拡張機能の名前。
statuses	InstanceViewStatus[]	リソースの状態情報。
substatuses	InstanceViewStatus[]	リソースの状態情報。
type	string	拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
typeHandlerVersion	string	スクリプトハンドラーのバージョンを指定します。

VirtualMachineHealthStatus

Object

VM の正常性状態。

名前	型	説明
status	InstanceViewStatus	VM の正常性状態情報。

VirtualMachineScaleSetVMInstanceView

Object

仮想マシンスケールセット 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 (int32)	障害ドメインの数。
platformUpdateDomain	integer (int32)	ドメインの更新数。
rdpThumbPrint	string	リモートデスクトップ証明書の拇印。
statuses	InstanceViewStatus[]	リソースの状態情報。
vmAgent	VirtualMachineAgentInstanceView	仮想マシンで実行されている VM エージェント。
vmHealth	VirtualMachineHealthStatus	VM の正常性状態。