Virtual Machine Scale Set VMs - Get Instance View

Dienst:

Compute

API-Version:

2024-03-01

Ruft den Status eines virtuellen Computers aus einem VM-Skalierungssatz ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die Instanz-ID des virtuellen Computers.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmScaleSetName	path	True	string	Der Name des VM-Skalierungssatzes.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineScaleSetVMInstanceView	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispielanforderung

HTTP

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

Python

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

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

JavaScript

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
// this example is just showing the usage of "VirtualMachineScaleSetVMs_GetInstanceView" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineScaleSetVmResource created on azure
// for more information of creating VirtualMachineScaleSetVmResource, please refer to the document of VirtualMachineScaleSetVmResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string virtualMachineScaleSetName = "myVirtualMachineScaleSet";
string instanceId = "0";
ResourceIdentifier virtualMachineScaleSetVmResourceId = VirtualMachineScaleSetVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName, instanceId);
VirtualMachineScaleSetVmResource virtualMachineScaleSetVm = client.GetVirtualMachineScaleSetVmResource(virtualMachineScaleSetVmResourceId);

// invoke the operation
VirtualMachineScaleSetVmInstanceView result = await virtualMachineScaleSetVm.GetInstanceViewAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
BootDiagnosticsInstanceView	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.
CloudError	Eine Fehlerantwort des Computediensts.
DiskEncryptionSettings	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Mindest-API-Version: 2015-06-15
DiskInstanceView	Die Datenträgerinformationen.
HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansichtsstatus.
KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.
KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.
MaintenanceOperationResultCodeTypes	Der letzte Ergebniscode des Wartungsvorgangs.
MaintenanceRedeployStatus	Der Wartungsvorgangsstatus auf dem virtuellen Computer.
StatusLevelTypes	Der Ebenencode.
SubResource	Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.
VirtualMachineAgentInstanceView	Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
VirtualMachineExtensionHandlerInstanceView	Die Instanzansicht der Erweiterungshandler für virtuelle Computer.
VirtualMachineExtensionInstanceView	Die Erweiterungsinformationen.
VirtualMachineHealthStatus	Der Integritätsstatus für den virtuellen Computer.
VirtualMachineScaleSetVMInstanceView	Die Instanzansicht eines VM-Skalierungssatzes für virtuelle Computer.

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

BootDiagnosticsInstanceView

Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.

Name	Typ	Beschreibung
consoleScreenshotBlobUri	string	Der Blob-URI des Konsolenfotos. Hinweis: Dies wird nicht festgelegt, wenn die Startdiagnose derzeit mit verwaltetem Speicher aktiviert ist.
serialConsoleLogBlobUri	string	Der BLOB-Uri der seriellen Konsole. Hinweis: Dies wird nicht festgelegt, wenn die Startdiagnose derzeit mit verwaltetem Speicher aktiviert ist.
status	InstanceViewStatus	Die Statusinformationen zur Startdiagnose für den virtuellen Computer. Hinweis: Es wird nur festgelegt, wenn Fehler beim Aktivieren der Startdiagnose aufgetreten sind.

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an.

Mindest-API-Version: 2015-06-15

Name	Typ	Beschreibung
diskEncryptionKey	KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.
enabled	boolean	Gibt an, ob die Datenträgerverschlüsselung auf dem virtuellen Computer aktiviert werden soll.
keyEncryptionKey	KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.

DiskInstanceView

Die Datenträgerinformationen.

Name	Typ	Beschreibung
encryptionSettings	DiskEncryptionSettings[]	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Mindest-API-Version: 2015-06-15
name	string	Der Datenträgername.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.

HyperVGeneration

Die Hypervisorgenerierung des virtuellen Computers [V1, V2]

Name	Typ	Beschreibung
V1	string
V2	string

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Instanzansichtsstatus.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für den Status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte Statusmeldung, einschließlich warnungen und Fehlermeldungen.
time	string	Die Uhrzeit des Status.

KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels im Key Vault an.

Name	Typ	Beschreibung
keyUrl	string	Die URL, die auf einen Schlüsselverschlüsselungsschlüssel im Key Vault verweist.
sourceVault	SubResource	Die relative URL des Schlüsseltresors, der den Schlüssel enthält.

KeyVaultSecretReference

Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, bei dem es sich um einen Schlüsseltresorschlüssel handelt.

Name	Typ	Beschreibung
secretUrl	string	Die URL, die auf einen geheimen Schlüssel in einem Key Vault verweist.
sourceVault	SubResource	Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.

MaintenanceOperationResultCodeTypes

Der letzte Ergebniscode des Wartungsvorgangs.

Name	Typ	Beschreibung
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Der Wartungsvorgangsstatus auf dem virtuellen Computer.

Name	Typ	Beschreibung
isCustomerInitiatedMaintenanceAllowed	boolean	True, wenn der Kunde Wartungsvorgänge durchführen darf.
lastOperationMessage	string	Die Nachricht, die für den letzten Wartungsvorgang zurückgegeben wurde.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Der letzte Ergebniscode des Wartungsvorgangs.
maintenanceWindowEndTime	string	Endzeit für das Wartungsfenster.
maintenanceWindowStartTime	string	Startzeit für das Wartungsfenster.
preMaintenanceWindowEndTime	string	Endzeit für das Fenster vor der Wartung.
preMaintenanceWindowStartTime	string	Startzeit für das Fenster vor der Wartung.

StatusLevelTypes

Der Ebenencode.

Name	Typ	Beschreibung
Error	string
Info	string
Warning	string

SubResource

Die relative URL des Schlüsseltresors, der den geheimen Schlüssel enthält.

Name	Typ	Beschreibung
id	string	Ressourcen-ID

VirtualMachineAgentInstanceView

Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.

Name	Typ	Beschreibung
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Die Instanzansicht der Erweiterungshandler für virtuelle Computer.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
vmAgentVersion	string	Die Vollversion des VM-Agents.

VirtualMachineExtensionHandlerInstanceView

Die Instanzansicht der Erweiterungshandler für virtuelle Computer.

Name	Typ	Beschreibung
status	InstanceViewStatus	Der Erweiterungshandlerstatus.
type	string	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion	string	Gibt die Version des Skripthandlers an.

VirtualMachineExtensionInstanceView

Die Erweiterungsinformationen.

Name	Typ	Beschreibung
name	string	Der Erweiterungsname des virtuellen Computers.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
substatuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
type	string	Gibt den Typ der Erweiterung an; Ein Beispiel ist "CustomScriptExtension".
typeHandlerVersion	string	Gibt die Version des Skripthandlers an.

VirtualMachineHealthStatus

Der Integritätsstatus für den virtuellen Computer.

Name	Typ	Beschreibung
status	InstanceViewStatus	Die Integritätsstatusinformationen für den virtuellen Computer.

VirtualMachineScaleSetVMInstanceView

Die Instanzansicht eines VM-Skalierungssatzes für virtuelle Computer.

Name	Typ	Beschreibung
assignedHost	string	Ressourcen-ID des dedizierten Hosts, auf dem der virtuelle Computer über die automatische Platzierung zugewiesen wird, wenn der virtuelle Computer einer dedizierten Hostgruppe zugeordnet ist, für die die automatische Platzierung aktiviert ist. Mindest-API-Version: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Die Startdiagnose ist ein Debugfeature, mit dem Sie die Konsolenausgabe und den Screenshot anzeigen können, um den VM-Status zu diagnostizieren. Sie können die Ausgabe ihres Konsolenprotokolls ganz einfach anzeigen. Azure ermöglicht ihnen auch das Anzeigen eines Screenshots des virtuellen Computers vom Hypervisor.
computerName	string	Gibt den Hostnamen des virtuellen Computers an. Dieser Name kann nicht aktualisiert werden, nachdem der virtuelle Computer erstellt wurde. Max. Länge (Windows): 15 Zeichen Max-Length (Linux): 64 Zeichen. Benennungskonventionen und Einschränkungen finden Sie in Implementierungsrichtlinien für Azure-Infrastrukturdienste.
disks	DiskInstanceView[]	Die Datenträgerinformationen.
extensions	VirtualMachineExtensionInstanceView[]	Die Erweiterungsinformationen.
hyperVGeneration	HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Der Wartungsvorgangsstatus auf dem virtuellen Computer.
osName	string	Das Betriebssystem, das auf dem Hybridcomputer ausgeführt wird.
osVersion	string	Die Version des Betriebssystems, das auf dem Hybridcomputer ausgeführt wird.
placementGroupId	string	Die Platzierungsgruppe, in der der virtuelle Computer ausgeführt wird. Wenn der virtuelle Computer deallocated ist, verfügt er nicht über eine placementGroupId.
platformFaultDomain	integer	Die Anzahl der Fehlerdomänen.
platformUpdateDomain	integer	Die Anzahl der Updatedomänen.
rdpThumbPrint	string	Fingerabdruck des Remotedesktopzertifikats.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
vmAgent	VirtualMachineAgentInstanceView	Der VM-Agent, der auf dem virtuellen Computer ausgeführt wird.
vmHealth	VirtualMachineHealthStatus	Der Integritätsstatus für den virtuellen Computer.