Virtual Machine Scale Set VMs - Get Instance View

Servizio:

Compute

Versione API:

2024-07-01

Ottiene lo stato di una macchina virtuale da un set di scalabilità di macchine virtuali.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
instanceId	path	True	string	ID istanza della macchina virtuale.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
vmScaleSetName	path	True	string	Nome del set di scalabilità di macchine virtuali.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Esempio di richiesta

HTTP

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

Java

/**
 * Samples for VirtualMachineScaleSetVMs GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
     */
    /**
     * Sample code: Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through
     * automatic placement.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement(
            com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().getInstanceViewWithResponse(
            "myResourceGroup", "myVirtualMachineScaleSet", "0", 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

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-07-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-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-07-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-07-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-07-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-07-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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base degli errori api.
BootDiagnosticsInstanceView	Diagnostica di avvio è una funzionalità di debug che consente di visualizzare l'output e lo screenshot della console per diagnosticare lo stato della macchina virtuale. È possibile visualizzare facilmente l'output del log della console. Azure consente anche di visualizzare uno screenshot della macchina virtuale dall'hypervisor.
CloudError	Risposta di errore dal servizio di calcolo.
DiskEncryptionSettings	Specifica le impostazioni di crittografia per il disco del sistema operativo. Versione minima api: 2015-06-15
DiskInstanceView	Informazioni sui dischi.
HyperVGeneration	Generazione dell'hypervisor della macchina virtuale [V1, V2]
InnerError	Dettagli dell'errore interno.
InstanceViewStatus	Stato di visualizzazione dell'istanza.
KeyVaultKeyReference	Specifica il percorso della chiave di crittografia della chiave in Key Vault.
KeyVaultSecretReference	Specifica il percorso della chiave di crittografia del disco, ovvero un segreto dell'insieme di credenziali delle chiavi.
MaintenanceOperationResultCodeTypes	Codice risultato dell'ultima operazione di manutenzione.
MaintenanceRedeployStatus	Stato dell'operazione di manutenzione nella macchina virtuale.
StatusLevelTypes	Codice a livello.
SubResource	URL relativo dell'insieme di credenziali delle chiavi contenente il segreto.
VirtualMachineAgentInstanceView	Agente di macchine virtuali in esecuzione nella macchina virtuale.
VirtualMachineExtensionHandlerInstanceView	Visualizzazione dell'istanza del gestore dell'estensione macchina virtuale.
VirtualMachineExtensionInstanceView	Informazioni sulle estensioni.
VirtualMachineHealthStatus	Stato di integrità per la macchina virtuale.
VirtualMachineScaleSetVMInstanceView	Visualizzazione dell'istanza di una macchina virtuale del set di scalabilità di macchine virtuali.

ApiError

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Base degli errori api.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

BootDiagnosticsInstanceView

Diagnostica di avvio è una funzionalità di debug che consente di visualizzare l'output e lo screenshot della console per diagnosticare lo stato della macchina virtuale. È possibile visualizzare facilmente l'output del log della console. Azure consente anche di visualizzare uno screenshot della macchina virtuale dall'hypervisor.

Nome	Tipo	Descrizione
consoleScreenshotBlobUri	string	Screenshot dell'URI BLOB della console. Nota: Questa impostazione non se la diagnostica di avvio è attualmente abilitata con l'archiviazione gestita.
serialConsoleLogBlobUri	string	Uri BLOB del log della console seriale. Nota: Questa impostazione non se la diagnostica di avvio è attualmente abilitata con l'archiviazione gestita.
status	InstanceViewStatus	Informazioni sullo stato di diagnostica di avvio per la macchina virtuale. Nota: Verrà impostato solo se si verificano errori durante l'abilitazione della diagnostica di avvio.

CloudError

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

DiskEncryptionSettings

Specifica le impostazioni di crittografia per il disco del sistema operativo.

Versione minima api: 2015-06-15

Nome	Tipo	Descrizione
diskEncryptionKey	KeyVaultSecretReference	Specifica il percorso della chiave di crittografia del disco, ovvero un segreto dell'insieme di credenziali delle chiavi.
enabled	boolean	Specifica se la crittografia del disco deve essere abilitata nella macchina virtuale.
keyEncryptionKey	KeyVaultKeyReference	Specifica il percorso della chiave di crittografia della chiave in Key Vault.

DiskInstanceView

Informazioni sui dischi.

Nome	Tipo	Descrizione
encryptionSettings	DiskEncryptionSettings[]	Specifica le impostazioni di crittografia per il disco del sistema operativo. Versione minima api: 2015-06-15
name	string	Nome del disco.
statuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.

HyperVGeneration

Generazione dell'hypervisor della macchina virtuale [V1, V2]

Nome	Tipo	Descrizione
V1	string
V2	string

InnerError

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump delle eccezioni.
exceptiontype	string	Tipo di eccezione.

InstanceViewStatus

Stato di visualizzazione dell'istanza.

Nome	Tipo	Descrizione
code	string	Codice di stato.
displayStatus	string	Etichetta localizzabile breve per lo stato.
level	StatusLevelTypes	Codice a livello.
message	string	Messaggio di stato dettagliato, inclusi gli avvisi e i messaggi di errore.
time	string	Ora dello stato.

KeyVaultKeyReference

Specifica il percorso della chiave di crittografia della chiave in Key Vault.

Nome	Tipo	Descrizione
keyUrl	string	URL che fa riferimento a una chiave di crittografia della chiave in Key Vault.
sourceVault	SubResource	URL relativo dell'insieme di credenziali delle chiavi contenente la chiave.

KeyVaultSecretReference

Specifica il percorso della chiave di crittografia del disco, ovvero un segreto dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
secretUrl	string	URL che fa riferimento a un segreto in un insieme di credenziali delle chiavi.
sourceVault	SubResource	URL relativo dell'insieme di credenziali delle chiavi contenente il segreto.

MaintenanceOperationResultCodeTypes

Codice risultato dell'ultima operazione di manutenzione.

Nome	Tipo	Descrizione
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Stato dell'operazione di manutenzione nella macchina virtuale.

Nome	Tipo	Descrizione
isCustomerInitiatedMaintenanceAllowed	boolean	True, se il cliente è autorizzato a eseguire la manutenzione.
lastOperationMessage	string	Messaggio restituito per l'ultima operazione di manutenzione.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Codice risultato dell'ultima operazione di manutenzione.
maintenanceWindowEndTime	string	Ora di fine per la finestra di manutenzione.
maintenanceWindowStartTime	string	Ora di inizio per la finestra di manutenzione.
preMaintenanceWindowEndTime	string	Ora di fine per la finestra di manutenzione preliminare.
preMaintenanceWindowStartTime	string	Ora di inizio per la finestra di manutenzione preliminare.

StatusLevelTypes

Codice a livello.

Nome	Tipo	Descrizione
Error	string
Info	string
Warning	string

SubResource

URL relativo dell'insieme di credenziali delle chiavi contenente il segreto.

Nome	Tipo	Descrizione
id	string	ID risorsa

VirtualMachineAgentInstanceView

Agente di macchine virtuali in esecuzione nella macchina virtuale.

Nome	Tipo	Descrizione
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Visualizzazione dell'istanza del gestore dell'estensione macchina virtuale.
statuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.
vmAgentVersion	string	Versione completa dell'agente di macchine virtuali.

VirtualMachineExtensionHandlerInstanceView

Visualizzazione dell'istanza del gestore dell'estensione macchina virtuale.

Nome	Tipo	Descrizione
status	InstanceViewStatus	Stato del gestore dell'estensione.
type	string	Specifica il tipo di estensione; un esempio è "CustomScriptExtension".
typeHandlerVersion	string	Specifica la versione del gestore di script.

VirtualMachineExtensionInstanceView

Informazioni sulle estensioni.

Nome	Tipo	Descrizione
name	string	Nome dell'estensione della macchina virtuale.
statuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.
substatuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.
type	string	Specifica il tipo di estensione; un esempio è "CustomScriptExtension".
typeHandlerVersion	string	Specifica la versione del gestore di script.

VirtualMachineHealthStatus

Stato di integrità per la macchina virtuale.

Nome	Tipo	Descrizione
status	InstanceViewStatus	Informazioni sullo stato di integrità per la macchina virtuale.

VirtualMachineScaleSetVMInstanceView

Visualizzazione dell'istanza di una macchina virtuale del set di scalabilità di macchine virtuali.

Nome	Tipo	Descrizione
assignedHost	string	ID risorsa dell'host dedicato, in cui la macchina virtuale viene allocata tramite posizionamento automatico, quando la macchina virtuale è associata a un gruppo host dedicato con posizionamento automatico abilitato. Versione minima api: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostica di avvio è una funzionalità di debug che consente di visualizzare l'output e lo screenshot della console per diagnosticare lo stato della macchina virtuale. È possibile visualizzare facilmente l'output del log della console. Azure consente anche di visualizzare uno screenshot della macchina virtuale dall'hypervisor.
computerName	string	Specifica il nome del sistema operativo host della macchina virtuale. Questo nome non può essere aggiornato dopo la creazione della macchina virtuale. Lunghezza massima (Windows): 15 caratteri Lunghezza massima (Linux): 64 caratteri. Per le convenzioni di denominazione e le restrizioni, vedere linee guida per l'implementazione dei servizi dell'infrastruttura di Azure.
disks	DiskInstanceView[]	Informazioni sui dischi.
extensions	VirtualMachineExtensionInstanceView[]	Informazioni sulle estensioni.
hyperVGeneration	HyperVGeneration	Generazione dell'hypervisor della macchina virtuale [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stato dell'operazione di manutenzione nella macchina virtuale.
osName	string	Sistema operativo in esecuzione nel computer ibrido.
osVersion	string	Versione del sistema operativo in esecuzione nel computer ibrido.
placementGroupId	string	Gruppo di posizionamento in cui è in esecuzione la macchina virtuale. Se la macchina virtuale viene deallocata, non avrà un placementGroupId.
platformFaultDomain	integer	Numero di domini di errore.
platformUpdateDomain	integer	Numero di domini di aggiornamento.
rdpThumbPrint	string	Identificazione personale del certificato desktop remoto.
statuses	InstanceViewStatus[]	Informazioni sullo stato della risorsa.
vmAgent	VirtualMachineAgentInstanceView	Agente di macchine virtuali in esecuzione nella macchina virtuale.
vmHealth	VirtualMachineHealthStatus	Stato di integrità per la macchina virtuale.