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=2021-03-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

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

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=2021-03-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": "2021-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": "2021-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
    }
  ]
}

定義

BootDiagnosticsInstanceView

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

DiskEncryptionSettings

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

DiskInstanceView

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

InstanceViewStatus

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

KeyVaultKeyReference

Key Vault キーへの参照を記述します。

KeyVaultSecretReference

Key Vault シークレットへの参照を記述します。

MaintenanceOperationResultCodeTypes

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

MaintenanceRedeployStatus

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

StatusLevelTypes

レベルコード。

SubResource
VirtualMachineAgentInstanceView

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

VirtualMachineExtensionHandlerInstanceView

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

VirtualMachineExtensionInstanceView

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

VirtualMachineHealthStatus

VM の正常性状態。

VirtualMachineScaleSetVMInstanceView

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

BootDiagnosticsInstanceView

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

Name Type Description
consoleScreenshotBlobUri
  • string

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

注: 現在管理されている記憶域でブート診断が有効になっている場合、この設定は設定され ません

serialConsoleLogBlobUri
  • string

シリアルコンソールのログ blob の Uri。

注: 現在管理されている記憶域でブート診断が有効になっている場合、この設定は設定され ません

status

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

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

DiskEncryptionSettings

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

Name Type Description
diskEncryptionKey

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

enabled
  • boolean

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

keyEncryptionKey

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

DiskInstanceView

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

Name Type Description
encryptionSettings

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

最小 api バージョン: 2015-06-15

name
  • string

ディスク名。

statuses

リソースの状態情報。

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 バージョン: 2020-06-01。

bootDiagnostics

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

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

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

disks

ディスク情報。

extensions

拡張機能の情報です。

maintenanceRedeployStatus

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

placementGroupId
  • string

VM が実行されている配置グループ。 VM の割り当てが解除されている場合、その VM には、"の" のようになります。

platformFaultDomain
  • integer

障害ドメインの数。

platformUpdateDomain
  • integer

更新ドメインの数。

rdpThumbPrint
  • string

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

statuses

リソースの状態情報。

vmAgent

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

vmHealth

VM の正常性状態。