Virtual Machines - Instance View

リファレンス

Service:: Compute

API Version:: 2024-03-01

仮想マシンの実行時の状態に関する情報を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView?api-version=2024-03-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vmName	path	True	string	仮想マシンの名前。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	VirtualMachineInstanceView	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 placed on a dedicated host group through automatic placement.

Get Virtual Machine Instance View.

Get instance view of a virtual machine placed on a dedicated host group through automatic placement.

Sample Request

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


/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine placed on a dedicated host group through automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .instanceViewWithResponse("myResourceGroup", "myVM", 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

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/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachinesClient_InstanceView_getInstanceViewOfAVirtualMachinePlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
	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.NewVirtualMachinesClient().InstanceView(ctx, "myResourceGroup", "myVM", 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.VirtualMachineInstanceView = armcompute.VirtualMachineInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	ComputerName: to.Ptr("myVM"),
	// 	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-01T21:29:47.477Z"); return t}()),
	// 			}},
	// 	}},
	// 	HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 	OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 	OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.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, "2024-03-01T21:30:12.805Z"); 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/succeeded"),
	// 				DisplayStatus: to.Ptr("Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Message: to.Ptr("GuestAgent is running and accepting new configurations."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// }
}

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

{
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2024-03-01T23:11:22+00:00"
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2024-03-01T21:29:47.477089+00:00"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2024-03-01T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

Get Virtual Machine Instance View.

Sample Request

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


/**
 * Samples for VirtualMachines InstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachine_Get_InstanceView.json
     */
    /**
     * Sample code: Get Virtual Machine Instance View.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualMachineInstanceView(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines()
            .instanceViewWithResponse("myResourceGroup", "myVM", 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

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/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
func ExampleVirtualMachinesClient_InstanceView_getVirtualMachineInstanceView() {
	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.NewVirtualMachinesClient().InstanceView(ctx, "myResourceGroup", "myVM", 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.VirtualMachineInstanceView = armcompute.VirtualMachineInstanceView{
	// 	BootDiagnostics: &armcompute.BootDiagnosticsInstanceView{
	// 		ConsoleScreenshotBlobURI: to.Ptr("https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp"),
	// 		SerialConsoleLogBlobURI: to.Ptr("https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"),
	// 	},
	// 	ComputerName: to.Ptr("myVM"),
	// 	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, "2019-10-14T21:29:47.477Z"); return t}()),
	// 			}},
	// 		},
	// 		{
	// 			Name: to.Ptr("myDataDisk0"),
	// 			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, "2019-10-14T21:29:47.461Z"); return t}()),
	// 			}},
	// 	}},
	// 	HyperVGeneration: to.Ptr(armcompute.HyperVGenerationTypeV1),
	// 	IsVMInStandbyPool: to.Ptr(false),
	// 	OSName: to.Ptr("Windows Server 2016 Datacenter"),
	// 	OSVersion: to.Ptr("Microsoft Windows NT 10.0.14393.0"),
	// 	PatchStatus: &armcompute.VirtualMachinePatchStatus{
	// 		AvailablePatchSummary: &armcompute.AvailablePatchSummary{
	// 			AssessmentActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 			CriticalAndSecurityPatchCount: to.Ptr[int32](1),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			OtherPatchCount: to.Ptr[int32](2),
	// 			RebootPending: to.Ptr(true),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		},
	// 		ConfigurationStatuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("PatchModeConfigurationState/Ready"),
	// 				DisplayStatus: to.Ptr("Status_PatchModeConfigurationState_Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("AssessmentModeConfigurationState/Pending"),
	// 				DisplayStatus: to.Ptr("Status_AssessmentModeConfigurationState_Pending"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 		}},
	// 		LastPatchInstallationSummary: &armcompute.LastPatchInstallationSummary{
	// 			ExcludedPatchCount: to.Ptr[int32](1),
	// 			FailedPatchCount: to.Ptr[int32](1),
	// 			InstallationActivityID: to.Ptr("68f8b292-dfc2-4646-9981-33cc88631968"),
	// 			InstalledPatchCount: to.Ptr[int32](1),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			MaintenanceWindowExceeded: to.Ptr(false),
	// 			NotSelectedPatchCount: to.Ptr[int32](1),
	// 			PendingPatchCount: to.Ptr[int32](1),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		},
	// 	},
	// 	PlatformFaultDomain: to.Ptr[int32](1),
	// 	PlatformUpdateDomain: to.Ptr[int32](1),
	// 	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, "2019-10-14T21:30:12.805Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		ExtensionHandlers: []*armcompute.VirtualMachineExtensionHandlerInstanceView{
	// 			{
	// 				Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 				Status: &armcompute.InstanceViewStatus{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Ready"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				},
	// 				TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 		}},
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				DisplayStatus: to.Ptr("Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Message: to.Ptr("GuestAgent is running and accepting new configurations."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T23:11:22.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("2.7.41491.949"),
	// 	},
	// 	Extensions: []*armcompute.VirtualMachineExtensionInstanceView{
	// 		{
	// 			Name: to.Ptr("IaaSAntiMalware-ext0"),
	// 			Type: to.Ptr("Microsoft.Azure.Security.IaaSAntimalware"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 					Message: to.Ptr("Microsoft Antimalware enabled"),
	// 			}},
	// 			TypeHandlerVersion: to.Ptr("1.5.5.9"),
	// 	}},
	// }
}

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": 1,
  "platformFaultDomain": 1,
  "computerName": "myVM",
  "osName": "Windows Server 2016 Datacenter",
  "osVersion": "Microsoft Windows NT 10.0.14393.0",
  "vmAgent": {
    "vmAgentVersion": "2.7.41491.949",
    "statuses": [
      {
        "code": "ProvisioningState/succeeded",
        "level": "Info",
        "displayStatus": "Ready",
        "message": "GuestAgent is running and accepting new configurations.",
        "time": "2019-10-14T23:11:22+00:00"
      }
    ],
    "extensionHandlers": [
      {
        "type": "Microsoft.Azure.Security.IaaSAntimalware",
        "typeHandlerVersion": "1.5.5.9",
        "status": {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Ready"
        }
      }
    ]
  },
  "disks": [
    {
      "name": "myOsDisk",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2019-10-14T21:29:47.477089+00:00"
        }
      ]
    },
    {
      "name": "myDataDisk0",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "time": "2019-10-14T21:29:47.461517+00:00"
        }
      ]
    }
  ],
  "bootDiagnostics": {
    "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp",
    "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"
  },
  "extensions": [
    {
      "name": "IaaSAntiMalware-ext0",
      "type": "Microsoft.Azure.Security.IaaSAntimalware",
      "typeHandlerVersion": "1.5.5.9",
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": "Microsoft Antimalware enabled"
        }
      ]
    }
  ],
  "hyperVGeneration": "V1",
  "patchStatus": {
    "availablePatchSummary": {
      "status": "Succeeded",
      "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
      "rebootPending": true,
      "criticalAndSecurityPatchCount": 1,
      "otherPatchCount": 2,
      "startTime": "2020-04-24T21:02:04.2556154Z",
      "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
      "error": null
    },
    "lastPatchInstallationSummary": {
      "status": "Succeeded",
      "installationActivityId": "68f8b292-dfc2-4646-9981-33cc88631968",
      "maintenanceWindowExceeded": false,
      "notSelectedPatchCount": 1,
      "excludedPatchCount": 1,
      "pendingPatchCount": 1,
      "installedPatchCount": 1,
      "failedPatchCount": 1,
      "startTime": "2020-04-24T21:02:04.2556154Z",
      "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
      "error": null
    },
    "configurationStatuses": [
      {
        "code": "PatchModeConfigurationState/Ready",
        "level": "Info",
        "displayStatus": "Status_PatchModeConfigurationState_Ready",
        "time": "2020-04-24T21:02:04.2556154Z"
      },
      {
        "code": "AssessmentModeConfigurationState/Pending",
        "level": "Info",
        "displayStatus": "Status_AssessmentModeConfigurationState_Pending",
        "time": "2020-04-24T21:02:04.2556154Z"
      }
    ]
  },
  "isVMInStandbyPool": false,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2019-10-14T21:30:12.8051917+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running"
    }
  ]
}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
AvailablePatchSummary	仮想マシンの最新の評価操作の利用可能なパッチの概要。
BootDiagnosticsInstanceView	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーからの VM のスクリーンショットも表示できます。
CloudError	コンピューティングサービスからのエラー応答。
DiskEncryptionSettings	OS ディスクの暗号化設定を指定します。最小 api-version: 2015-06-15
DiskInstanceView	仮想マシンのディスク情報。
HyperVGenerationType	リソースに関連付けられている HyperVGeneration の種類を指定します
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンスビューの状態。
KeyVaultKeyReference	Key Vault内のキー暗号化キーの場所を指定します。
KeyVaultSecretReference	Key Vault シークレットであるディスク暗号化キーの場所を指定します。
LastPatchInstallationSummary	仮想マシンの最新のインストール操作のインストールの概要。
MaintenanceOperationResultCodeTypes	最後のメンテナンス操作の結果コード。
MaintenanceRedeployStatus	仮想マシンのメンテナンス操作の状態。
PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。
StatusLevelTypes	レベルコード。
SubResource	シークレットを含むKey Vaultの相対 URL。
VirtualMachineAgentInstanceView	仮想マシンで実行されている VM エージェント。
VirtualMachineExtensionHandlerInstanceView	仮想マシン拡張機能ハンドラーインスタンスビュー。
VirtualMachineExtensionInstanceView	拡張機能の情報。
VirtualMachineHealthStatus	VM の正常性状態。
VirtualMachineInstanceView	仮想マシンのインスタンスビュー。
VirtualMachinePatchStatus	[プレビュー機能]仮想マシンのパッチ操作の状態。

ApiError

API エラー。

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

ApiErrorBase

API エラーベース。

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

AvailablePatchSummary

仮想マシンの最新の評価操作の利用可能なパッチの概要。

名前	型	説明
assessmentActivityId	string	この結果を生成した操作のアクティビティ ID。これは、CRP と拡張機能のログ間で相互に関連付けるために使用されます。
criticalAndSecurityPatchCount	integer	使用可能として検出され、まだインストールされていないクリティカルパッチまたはセキュリティパッチの数。
error	ApiError	操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。
lastModifiedTime	string	操作が開始されたときの UTC タイムスタンプ。
otherPatchCount	integer	クリティカルおよびセキュリティを除く使用可能なすべてのパッチの数。
rebootPending	boolean	VM の全体的な再起動状態。これは、部分的にインストールされたパッチがインストールを完了するために再起動を必要とするが、再起動がまだ発生していない場合に当てはまります。
startTime	string	操作が開始されたときの UTC タイムスタンプ。
status	PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"不明"、"失敗"、"成功"、または "CompletedWithWarnings" になります。

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[]	リソースの状態情報。

HyperVGenerationType

リソースに関連付けられている HyperVGeneration の種類を指定します

名前	型	説明
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。

LastPatchInstallationSummary

仮想マシンの最新のインストール操作のインストールの概要。

名前	型	説明
error	ApiError	操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。
excludedPatchCount	integer	使用可能なすべてのパッチの数。ただし、顧客が指定した除外リストの一致によって明示的に除外されます。
failedPatchCount	integer	インストールに失敗したパッチの数。
installationActivityId	string	この結果を生成した操作のアクティビティ ID。これは、CRP ログと拡張機能ログ間で相互に関連付けるために使用されます。
installedPatchCount	integer	正常にインストールされたパッチの数。
lastModifiedTime	string	操作が開始されたときの UTC タイムスタンプ。
maintenanceWindowExceeded	boolean	操作が目的のすべてのアクションを完了するまでに時間が切れるかどうかを説明します
notSelectedPatchCount	integer	分類または包含リストのエントリと一致しなかったため、使用可能なすべてのパッチの数がインストールされません。
pendingPatchCount	integer	パッチのインストール操作中にインストールされる予定のすべての利用可能なパッチの数。
startTime	string	操作が開始されたときの UTC タイムスタンプ。
status	PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

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	メンテナンス前期間の開始時刻。

PatchOperationStatus

操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

名前	型	説明
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	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 の正常性状態情報。

VirtualMachineInstanceView

仮想マシンのインスタンスビュー。

名前	型	説明
assignedHost	string	自動配置が有効になっている専用ホストグループに仮想マシンが関連付けられている場合に、仮想マシンが自動配置によって割り当てられる専用ホストのリソース ID。最小 api-version: 2020-06-01。
bootDiagnostics	BootDiagnosticsInstanceView	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーからの VM のスクリーンショットも表示できます。
computerName	string	仮想マシンに割り当てられたコンピューター名。
disks	DiskInstanceView[]	仮想マシンのディスク情報。
extensions	VirtualMachineExtensionInstanceView[]	拡張機能の情報。
hyperVGeneration	HyperVGenerationType	リソースに関連付けられている HyperVGeneration の種類を指定します
isVMInStandbyPool	boolean	[プレビュー機能]VM が現在スタンバイプール内にあるか、スタンバイプール外にあるかを指定します。
maintenanceRedeployStatus	MaintenanceRedeployStatus	仮想マシンのメンテナンス操作の状態。
osName	string	仮想マシンで実行されているオペレーティングシステム。
osVersion	string	仮想マシンで実行されているオペレーティングシステムのバージョン。
patchStatus	VirtualMachinePatchStatus	[プレビュー機能]仮想マシンのパッチ操作の状態。
platformFaultDomain	integer	仮想マシンの障害ドメインを指定します。
platformUpdateDomain	integer	仮想マシンの更新ドメインを指定します。
rdpThumbPrint	string	リモートデスクトップ証明書の拇印。
statuses	InstanceViewStatus[]	リソースの状態情報。
vmAgent	VirtualMachineAgentInstanceView	仮想マシンで実行されている VM エージェント。
vmHealth	VirtualMachineHealthStatus	VM の正常性状態。

VirtualMachinePatchStatus

[プレビュー機能]仮想マシンのパッチ操作の状態。

名前	型	説明
availablePatchSummary	AvailablePatchSummary	仮想マシンの最新の評価操作の利用可能なパッチの概要。
configurationStatuses	InstanceViewStatus[]	指定した patchMode の有効化状態
lastPatchInstallationSummary	LastPatchInstallationSummary	仮想マシンの最新のインストール操作のインストールの概要。

Virtual Machines - Instance View

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

Get instance view of a virtual machine placed on a dedicated host group through automatic placement.

Sample Request

Sample Response

Get Virtual Machine Instance View.

Sample Request

Sample Response

定義

ApiError

ApiErrorBase

AvailablePatchSummary

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGenerationType

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LastPatchInstallationSummary

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

PatchOperationStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineInstanceView

VirtualMachinePatchStatus

その他のリソース