Virtual Machine Scale Set VMs - Get Instance View

Referensi

Service:: Compute

API Version:: 2022-03-01

Mendapatkan status komputer virtual dari set skala VM.

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

Parameter URI

Name	In	Required	Type	Description
instanceId	path	True	string	ID instans komputer virtual.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmScaleSetName	path	True	string	Nama set skala VM.
api-version	query	True	string	Versi Api Klien.

Respons

Name	Type	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

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-03-01

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/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()
	client, err := armcompute.NewVirtualMachineScaleSetVMsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetInstanceView(ctx,
		"myResourceGroup",
		"myVirtualMachineScaleSet",
		"0",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "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);
}

getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement().catch(
  console.error
);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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": "2022-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": "2022-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
    }
  ]
}

Definisi

ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
BootDiagnosticsInstanceView	Tampilan instans diagnostik boot komputer virtual.
CloudError	Respons kesalahan dari layanan Komputasi.
DiskEncryptionSettings	Menjelaskan Pengaturan Enkripsi untuk Disk
DiskInstanceView	Tampilan instans disk.
InnerError	Detail kesalahan dalam.
InstanceViewStatus	Status tampilan instans.
KeyVaultKeyReference	Menjelaskan referensi ke Kunci Key Vault
KeyVaultSecretReference	Menjelaskan referensi ke Rahasia Key Vault
MaintenanceOperationResultCodeTypes	Kode Hasil Operasi Pemeliharaan Terakhir.
MaintenanceRedeployStatus	Status Operasi Pemeliharaan.
StatusLevelTypes	Kode tingkat.
SubResource
VirtualMachineAgentInstanceView	Tampilan instans Agen VM yang berjalan pada komputer virtual.
VirtualMachineExtensionHandlerInstanceView	Tampilan instans handler ekstensi komputer virtual.
VirtualMachineExtensionInstanceView	Tampilan instans ekstensi komputer virtual.
VirtualMachineHealthStatus	Status kesehatan VM.
VirtualMachineScaleSetVMInstanceView	Tampilan instans VM set skala komputer virtual.

ApiError

Kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

BootDiagnosticsInstanceView

Tampilan instans diagnostik boot komputer virtual.

Name	Type	Description
consoleScreenshotBlobUri	string	URI blob cuplikan layar konsol. CATATAN: Ini tidak akan diatur jika diagnostik boot saat ini diaktifkan dengan penyimpanan terkelola.
serialConsoleLogBlobUri	string	Uri blob log konsol serial. CATATAN: Ini tidak akan diatur jika diagnostik boot saat ini diaktifkan dengan penyimpanan terkelola.
status	InstanceViewStatus	Informasi status diagnostik boot untuk VM. CATATAN: Ini akan diatur hanya jika ada kesalahan yang ditemui dalam mengaktifkan diagnostik boot.

CloudError

Respons kesalahan dari layanan Komputasi.

Name	Type	Description
error	ApiError	Kesalahan api.

DiskEncryptionSettings

Menjelaskan Pengaturan Enkripsi untuk Disk

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.
enabled	boolean	Menentukan apakah enkripsi disk harus diaktifkan pada komputer virtual.
keyEncryptionKey	KeyVaultKeyReference	Menentukan lokasi kunci enkripsi kunci di Key Vault.

DiskInstanceView

Tampilan instans disk.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Menentukan pengaturan enkripsi untuk Disk OS. Versi api minimum: 2015-06-15
name	string	Nama disk.
statuses	InstanceViewStatus[]	Informasi status sumber daya.

InnerError

Detail kesalahan dalam.

Name	Type	Description
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

InstanceViewStatus

Status tampilan instans.

Name	Type	Description
code	string	Kode status.
displayStatus	string	Label pendek yang dapat dilokalkan untuk status tersebut.
level	StatusLevelTypes	Kode tingkat.
message	string	Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan.
time	string	Waktu status.

KeyVaultKeyReference

Menjelaskan referensi ke Kunci Key Vault

Name	Type	Description
keyUrl	string	URL yang mereferensikan kunci enkripsi kunci di Key Vault.
sourceVault	SubResource	URL relatif Key Vault yang berisi kunci.

KeyVaultSecretReference

Menjelaskan referensi ke Rahasia Key Vault

Name	Type	Description
secretUrl	string	URL yang merujuk rahasia dalam Key Vault.
sourceVault	SubResource	URL relatif Key Vault yang berisi rahasia.

MaintenanceOperationResultCodeTypes

Kode Hasil Operasi Pemeliharaan Terakhir.

Name	Type	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Status Operasi Pemeliharaan.

Name	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Benar, jika pelanggan diizinkan untuk melakukan Pemeliharaan.
lastOperationMessage	string	Pesan dikembalikan untuk Operasi Pemeliharaan terakhir.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Kode Hasil Operasi Pemeliharaan Terakhir.
maintenanceWindowEndTime	string	Waktu Selesai untuk Jendela Pemeliharaan.
maintenanceWindowStartTime	string	Waktu Mulai untuk Jendela Pemeliharaan.
preMaintenanceWindowEndTime	string	Waktu Selesai untuk Jendela Pra-Pemeliharaan.
preMaintenanceWindowStartTime	string	Waktu Mulai untuk Jendela Pra-Pemeliharaan.

StatusLevelTypes

Kode tingkat.

Name	Type	Description
Error	string
Info	string
Warning	string

SubResource

Name	Type	Description
id	string	ID sumber daya

VirtualMachineAgentInstanceView

Tampilan instans Agen VM yang berjalan pada komputer virtual.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Tampilan instans handler ekstensi komputer virtual.
statuses	InstanceViewStatus[]	Informasi status sumber daya.
vmAgentVersion	string	Versi lengkap Agen VM.

VirtualMachineExtensionHandlerInstanceView

Tampilan instans handler ekstensi komputer virtual.

Name	Type	Description
status	InstanceViewStatus	Status handler ekstensi.
type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
typeHandlerVersion	string	Menentukan versi handler skrip.

VirtualMachineExtensionInstanceView

Tampilan instans ekstensi komputer virtual.

Name	Type	Description
name	string	Nama ekstensi komputer virtual.
statuses	InstanceViewStatus[]	Informasi status sumber daya.
substatuses	InstanceViewStatus[]	Informasi status sumber daya.
type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
typeHandlerVersion	string	Menentukan versi handler skrip.

VirtualMachineHealthStatus

Status kesehatan VM.

Name	Type	Description
status	InstanceViewStatus	Informasi status kesehatan untuk VM.

VirtualMachineScaleSetVMInstanceView

Tampilan instans VM set skala komputer virtual.

Name	Type	Description
assignedHost	string	Id sumber daya host khusus, tempat komputer virtual dialokasikan melalui penempatan otomatis, ketika komputer virtual dikaitkan dengan grup host khusus yang mengaktifkan penempatan otomatis. Versi api minimum: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostik Boot adalah fitur penelusuran kesalahan yang memungkinkan Anda melihat Output Konsol dan Cuplikan Layar untuk mendiagnosis status VM. Anda dapat dengan mudah melihat output log konsol Anda. Azure juga memungkinkan Anda melihat cuplikan layar VM dari hypervisor.
disks	DiskInstanceView[]	Informasi disk.
extensions	VirtualMachineExtensionInstanceView[]	Informasi ekstensi.
maintenanceRedeployStatus	MaintenanceRedeployStatus	Status Operasi Pemeliharaan pada komputer virtual.
placementGroupId	string	Grup penempatan tempat VM berjalan. Jika VM dibatalkan alokasinya, VM tidak akan memiliki placementGroupId.
platformFaultDomain	integer	Jumlah Domain Kesalahan.
platformUpdateDomain	integer	Jumlah Perbarui Domain.
rdpThumbPrint	string	Thumbprint sertifikat desktop jarak jauh.
statuses	InstanceViewStatus[]	Informasi status sumber daya.
vmAgent	VirtualMachineAgentInstanceView	Agen VM yang berjalan pada komputer virtual.
vmHealth	VirtualMachineHealthStatus	Status kesehatan untuk VM.