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 매개 변수

Name	In(다음 안에)	필수	형식	Description
instanceId	path	True	string	가상 머신의 instance 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	형식	Description
200 OK	VirtualMachineScaleSetVMInstanceView	정상
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 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=2024-03-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_instance_view_auto_placed_on_dedicated_host_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machine_scale_set_vms.get_instance_view(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
if __name__ == "__main__":
    main()

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/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

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the status of a virtual machine from a VM scale set.
 *
 * @summary Gets the status of a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  console.log(result);
}

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
    }
  ]
}

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
BootDiagnosticsInstanceView	부팅 진단은 콘솔 출력 및 스크린샷을 보고 VM 상태 진단할 수 있는 디버깅 기능입니다. 콘솔 로그의 출력을 쉽게 볼 수 있습니다. 또한 Azure를 사용하면 하이퍼바이저에서 VM의 스크린샷을 볼 수 있습니다.
CloudError	Compute 서비스의 오류 응답입니다.
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	가상 머신 확장 처리기는 보기를 instance.
VirtualMachineExtensionInstanceView	확장 정보입니다.
VirtualMachineHealthStatus	VM에 대한 상태 상태.
VirtualMachineScaleSetVMInstanceView	가상 머신 확장 집합 VM의 instance 보기입니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

BootDiagnosticsInstanceView

부팅 진단은 콘솔 출력 및 스크린샷을 보고 VM 상태 진단할 수 있는 디버깅 기능입니다. 콘솔 로그의 출력을 쉽게 볼 수 있습니다. 또한 Azure를 사용하면 하이퍼바이저에서 VM의 스크린샷을 볼 수 있습니다.

Name	형식	Description
consoleScreenshotBlobUri	string	콘솔 스크린샷 Blob URI. 참고: 부팅 진단 현재 관리 스토리지에서 사용하도록 설정된 경우에는 설정되지 않습니다.
serialConsoleLogBlobUri	string	직렬 콘솔 로그 Blob Uri입니다. 참고: 부팅 진단 현재 관리 스토리지에서 사용하도록 설정된 경우에는 설정되지 않습니다.
status	InstanceViewStatus	부팅 진단 상태 VM에 대한 정보입니다. 참고: 부팅 진단 사용하도록 설정할 때 오류가 발생한 경우에만 설정됩니다.

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

DiskEncryptionSettings

OS 디스크에 대한 암호화 설정을 지정합니다.

최소 api-version: 2015-06-15

Name	형식	Description
diskEncryptionKey	KeyVaultSecretReference	Key Vault 비밀인 디스크 암호화 키의 위치를 지정합니다.
enabled	boolean	가상 머신에서 디스크 암호화를 사용하도록 설정할지 여부를 지정합니다.
keyEncryptionKey	KeyVaultKeyReference	Key Vault 키 암호화 키의 위치를 지정합니다.

DiskInstanceView

디스크 정보입니다.

Name	형식	Description
encryptionSettings	DiskEncryptionSettings[]	OS 디스크에 대한 암호화 설정을 지정합니다. 최소 api-version: 2015-06-15
name	string	디스크 이름.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.

HyperVGeneration

가상 머신의 하이퍼바이저 생성 [V1, V2]

Name	형식	Description
V1	string
V2	string

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

InstanceViewStatus

인스턴스 보기 상태.

Name	형식	Description
code	string	상태 코드입니다.
displayStatus	string	상태 대한 짧은 지역화 가능 레이블입니다.
level	StatusLevelTypes	수준 코드입니다.
message	string	경고 및 오류 메시지를 포함하여 자세한 상태 메시지입니다.
time	string	상태 시간입니다.

KeyVaultKeyReference

Key Vault 키 암호화 키의 위치를 지정합니다.

Name	형식	Description
keyUrl	string	Key Vault 키 암호화 키를 참조하는 URL입니다.
sourceVault	SubResource	키를 포함하는 Key Vault 상대 URL입니다.

KeyVaultSecretReference

Key Vault 비밀인 디스크 암호화 키의 위치를 지정합니다.

Name	형식	Description
secretUrl	string	Key Vault 비밀을 참조하는 URL입니다.
sourceVault	SubResource	비밀을 포함하는 Key Vault 상대 URL입니다.

MaintenanceOperationResultCodeTypes

마지막 유지 관리 작업 결과 코드입니다.

Name	형식	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

유지 관리 작업은 가상 머신에서 상태.

Name	형식	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True이면 고객이 유지 관리를 수행할 수 있습니다.
lastOperationMessage	string	마지막 유지 관리 작업에 대해 반환된 메시지입니다.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	마지막 유지 관리 작업 결과 코드입니다.
maintenanceWindowEndTime	string	유지 관리 기간의 종료 시간입니다.
maintenanceWindowStartTime	string	유지 관리 기간의 시작 시간입니다.
preMaintenanceWindowEndTime	string	사전 유지 관리 기간의 종료 시간입니다.
preMaintenanceWindowStartTime	string	사전 유지 관리 기간의 시작 시간입니다.

StatusLevelTypes

수준 코드입니다.

Name	형식	Description
Error	string
Info	string
Warning	string

SubResource

비밀을 포함하는 Key Vault 상대 URL입니다.

Name	형식	Description
id	string	리소스 ID

VirtualMachineAgentInstanceView

가상 머신에서 실행되는 VM 에이전트입니다.

Name	형식	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	가상 머신 확장 처리기는 보기를 instance.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.
vmAgentVersion	string	VM 에이전트 전체 버전입니다.

VirtualMachineExtensionHandlerInstanceView

가상 머신 확장 처리기는 보기를 instance.

Name	형식	Description
status	InstanceViewStatus	확장 처리기가 상태.
type	string	확장의 형식을 지정합니다. 예를 들어 "CustomScriptExtension"이 있습니다.
typeHandlerVersion	string	스크립트 처리기의 버전을 지정합니다.

VirtualMachineExtensionInstanceView

확장 정보입니다.

Name	형식	Description
name	string	가상 머신 확장 이름입니다.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.
substatuses	InstanceViewStatus[]	리소스 상태 정보입니다.
type	string	확장의 형식을 지정합니다. 예를 들어 "CustomScriptExtension"이 있습니다.
typeHandlerVersion	string	스크립트 처리기의 버전을 지정합니다.

VirtualMachineHealthStatus

VM에 대한 상태 상태.

Name	형식	Description
status	InstanceViewStatus	VM에 대한 상태 상태 정보입니다.

VirtualMachineScaleSetVMInstanceView

가상 머신 확장 집합 VM의 instance 보기입니다.

Name	형식	Description
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에 대한 상태 상태.

Virtual Machine Scale Set VMs - Get Instance View

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

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

Sample Request

Sample Response

정의

ApiError

ApiErrorBase

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGeneration

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineScaleSetVMInstanceView

추가 리소스