Virtual Machine Scale Set VMs - Get Instance View

Service:

Compute

API Version:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
instanceId	path	True	string	ID instans komputer virtual.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial 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

Nama	Jenis	Deskripsi
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
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

HTTP

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

Go

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

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

Definisi

Nama	Deskripsi
ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
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.
CloudError	Respons kesalahan dari layanan Komputasi.
DiskEncryptionSettings	Menentukan pengaturan enkripsi untuk Disk OS. Versi api minimum: 2015-06-15
DiskInstanceView	Informasi disk.
HyperVGeneration	Generasi hypervisor Komputer Virtual [V1, V2]
InnerError	Detail kesalahan dalam.
InstanceViewStatus	Status tampilan instans.
KeyVaultKeyReference	Menentukan lokasi kunci enkripsi kunci di Key Vault.
KeyVaultSecretReference	Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.
MaintenanceOperationResultCodeTypes	Kode Hasil Operasi Pemeliharaan Terakhir.
MaintenanceRedeployStatus	Status Operasi Pemeliharaan pada komputer virtual.
StatusLevelTypes	Kode tingkat.
SubResource	URL relatif dari Key Vault yang berisi rahasia.
VirtualMachineAgentInstanceView	Agen VM yang berjalan pada komputer virtual.
VirtualMachineExtensionHandlerInstanceView	Tampilan instans handler ekstensi komputer virtual.
VirtualMachineExtensionInstanceView	Informasi ekstensi.
VirtualMachineHealthStatus	Status kesehatan untuk VM.
VirtualMachineScaleSetVMInstanceView	Tampilan instans VM set skala komputer virtual.

ApiError

Kesalahan api.

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

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.

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan api.

DiskEncryptionSettings

Menentukan pengaturan enkripsi untuk Disk OS.

Versi api minimum: 2015-06-15

Nama	Jenis	Deskripsi
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

Informasi disk.

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

HyperVGeneration

Generasi hypervisor Komputer Virtual [V1, V2]

Nama	Jenis	Deskripsi
V1	string
V2	string

InnerError

Detail kesalahan dalam.

Nama	Jenis	Deskripsi
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

InstanceViewStatus

Status tampilan instans.

Nama	Jenis	Deskripsi
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

Menentukan lokasi kunci enkripsi kunci di Key Vault.

Nama	Jenis	Deskripsi
keyUrl	string	URL yang mereferensikan kunci enkripsi kunci di Key Vault.
sourceVault	SubResource	URL relatif dari Key Vault yang berisi kunci.

KeyVaultSecretReference

Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.

Nama	Jenis	Deskripsi
secretUrl	string	URL yang mereferensikan rahasia dalam Key Vault.
sourceVault	SubResource	URL relatif dari Key Vault yang berisi rahasia.

MaintenanceOperationResultCodeTypes

Kode Hasil Operasi Pemeliharaan Terakhir.

Nama	Jenis	Deskripsi
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Status Operasi Pemeliharaan pada komputer virtual.

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
Error	string
Info	string
Warning	string

SubResource

URL relatif dari Key Vault yang berisi rahasia.

Nama	Jenis	Deskripsi
id	string	ID sumber daya

VirtualMachineAgentInstanceView

Agen VM yang berjalan pada komputer virtual.

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
status	InstanceViewStatus	Status handler ekstensi.
type	string	Menentukan jenis ekstensi; contohnya adalah "CustomScriptExtension".
typeHandlerVersion	string	Menentukan versi handler skrip.

VirtualMachineExtensionInstanceView

Informasi ekstensi.

Nama	Jenis	Deskripsi
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 untuk VM.

Nama	Jenis	Deskripsi
status	InstanceViewStatus	Informasi status kesehatan untuk VM.

VirtualMachineScaleSetVMInstanceView

Tampilan instans VM set skala komputer virtual.

Nama	Jenis	Deskripsi
assignedHost	string	Id sumber daya dari 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.
computerName	string	Menentukan nama OS host komputer virtual. Nama ini tidak dapat diperbarui setelah VM dibuat. Panjang maksimum (Windows): 15 karakter Panjang maksimum (Linux): 64 karakter. Untuk konvensi penamaan dan pembatasan, lihat Pedoman implementasi layanan infrastruktur Azure.
disks	DiskInstanceView[]	Informasi disk.
extensions	VirtualMachineExtensionInstanceView[]	Informasi ekstensi.
hyperVGeneration	HyperVGeneration	Generasi hypervisor Komputer Virtual [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Status Operasi Pemeliharaan pada komputer virtual.
osName	string	Sistem Operasi yang berjalan pada komputer hibrid.
osVersion	string	Versi Sistem Operasi yang berjalan pada komputer hibrid.
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.