Virtual Machine Scale Set VMs - Get Instance View

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

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

URI パラメーター

Name In Required Type Description
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 のバージョン。

応答

Name Type Description
200 OK

OK

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
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

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

Sample Response

{
  "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": "2022-08-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2022-08-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

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

InnerError

内部エラーの詳細。

InstanceViewStatus

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

KeyVaultKeyReference

Key Vault キーへの参照について説明します

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

MaintenanceOperationResultCodeTypes

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

MaintenanceRedeployStatus

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

StatusLevelTypes

レベル コード。

SubResource
VirtualMachineAgentInstanceView

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

VirtualMachineExtensionHandlerInstanceView

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

VirtualMachineExtensionInstanceView

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

VirtualMachineHealthStatus

VM の正常性状態。

VirtualMachineScaleSetVMInstanceView

仮想マシン スケール セット VM のインスタンス ビュー。

ApiError

API エラー。

Name Type Description
code
  • string

エラー コード。

details

Api エラーの詳細

innererror

Api の内部エラー

message
  • string

エラー メッセージ。

target
  • string

特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージ。

target
  • string

特定のエラーのターゲット。

BootDiagnosticsInstanceView

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

Name Type Description
consoleScreenshotBlobUri
  • string

コンソールのスクリーンショット BLOB URI。

注: ブート診断がマネージド ストレージで現在有効になっている場合、これは設定 されません

serialConsoleLogBlobUri
  • string

シリアル コンソール ログ BLOB URI。

注: ブート診断がマネージド ストレージで現在有効になっている場合、これは設定 されません

status

VM のブート診断の状態情報。

注: ブート診断の有効化でエラーが発生した場合にのみ設定されます。

CloudError

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

Name Type Description
error

API エラー。

DiskEncryptionSettings

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

Name Type Description
diskEncryptionKey

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

enabled
  • boolean

仮想マシンでディスク暗号化を有効にするかどうかを指定します。

keyEncryptionKey

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

DiskInstanceView

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

Name Type Description
encryptionSettings

OS ディスクの暗号化設定を指定します。

最小 api-version: 2015-06-15

name
  • string

ディスク名。

statuses

リソースの状態情報。

InnerError

内部エラーの詳細。

Name Type Description
errordetail
  • string

内部エラー メッセージまたは例外ダンプ。

exceptiontype
  • string

例外の種類。

InstanceViewStatus

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

Name Type Description
code
  • string

ステータス コード。

displayStatus
  • string

状態の短いローカライズ可能なラベル。

level

レベル コード。

message
  • string

アラートやエラー メッセージなど、詳細なステータス メッセージ。

time
  • string

状態の時刻。

KeyVaultKeyReference

Key Vault キーへの参照について説明します

Name Type Description
keyUrl
  • string

Key Vaultのキー暗号化キーを参照する URL。

sourceVault

キーを含むKey Vaultの相対 URL。

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

Name Type Description
secretUrl
  • string

Key Vault内のシークレットを参照する URL。

sourceVault

シークレットを含むKey Vaultの相対 URL。

MaintenanceOperationResultCodeTypes

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

Name Type Description
MaintenanceAborted
  • string
MaintenanceCompleted
  • string
None
  • string
RetryLater
  • string

MaintenanceRedeployStatus

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

Name Type Description
isCustomerInitiatedMaintenanceAllowed
  • boolean

True の場合、お客様がメンテナンスの実行を許可されます。

lastOperationMessage
  • string

最後のメンテナンス操作に対して返されたメッセージ。

lastOperationResultCode

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

maintenanceWindowEndTime
  • string

メンテナンス期間の終了時刻。

maintenanceWindowStartTime
  • string

メンテナンス期間の開始時刻。

preMaintenanceWindowEndTime
  • string

メンテナンス前期間の終了時刻。

preMaintenanceWindowStartTime
  • string

メンテナンス前期間の開始時刻。

StatusLevelTypes

レベル コード。

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

SubResource

Name Type Description
id
  • string

リソース ID

VirtualMachineAgentInstanceView

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

Name Type Description
extensionHandlers

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

statuses

リソースの状態情報。

vmAgentVersion
  • string

VM エージェントのフル バージョン。

VirtualMachineExtensionHandlerInstanceView

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

Name Type Description
status

拡張機能ハンドラーの状態。

type
  • string

拡張機能の型を指定します。例は "CustomScriptExtension" です。

typeHandlerVersion
  • string

スクリプト ハンドラーのバージョンを指定します。

VirtualMachineExtensionInstanceView

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

Name Type Description
name
  • string

仮想マシンの拡張機能名。

statuses

リソースの状態情報。

substatuses

リソースの状態情報。

type
  • string

拡張機能の型を指定します。例は "CustomScriptExtension" です。

typeHandlerVersion
  • string

スクリプト ハンドラーのバージョンを指定します。

VirtualMachineHealthStatus

VM の正常性状態。

Name Type Description
status

VM の正常性状態情報。

VirtualMachineScaleSetVMInstanceView

仮想マシン スケール セット VM のインスタンス ビュー。

Name Type Description
assignedHost
  • string

自動配置が有効になっている専用ホスト グループに仮想マシンが関連付けられている場合に、仮想マシンが自動配置によって割り当てられる専用ホストのリソース ID。

最小 api-version: 2020-06-01。

bootDiagnostics

ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。

コンソール ログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。

disks

ディスク情報。

extensions

拡張機能の情報。

maintenanceRedeployStatus

仮想マシンのメンテナンス操作の状態。

placementGroupId
  • string

VM が実行されている配置グループ。 VM の割り当てが解除された場合、placementGroupId はありません。

platformFaultDomain
  • integer

障害ドメインの数。

platformUpdateDomain
  • integer

ドメインの更新数。

rdpThumbPrint
  • string

リモート デスクトップ証明書の拇印。

statuses

リソースの状態情報。

vmAgent

仮想マシンで実行されている VM エージェント。

vmHealth

VM の正常性状態。