Virtual Machine Scale Set VMs - Get Instance View

Serviço:

Compute

Versão da API:

2024-07-01

Obtém o status de uma máquina virtual de um conjunto de dimensionamento de VM.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
instanceId	path	True	string	A ID da instância da máquina virtual.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
vmScaleSetName	path	True	string	O nome do conjunto de dimensionamento da VM.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OKEY
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros de API.
BootDiagnosticsInstanceView	O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.
CloudError	Uma resposta de erro do serviço de computação.
DiskEncryptionSettings	Especifica as configurações de criptografia para o disco do sistema operacional. Versão mínima da API: 2015-06-15
DiskInstanceView	As informações dos discos.
HyperVGeneration	A geração do hipervisor da Máquina Virtual [V1, V2]
InnerError	Detalhes do erro interno.
InstanceViewStatus	Status da exibição da instância.
KeyVaultKeyReference	Especifica o local da chave de criptografia de chave no Key Vault.
KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um Segredo do Key Vault.
MaintenanceOperationResultCodeTypes	O último código de resultado da operação de manutenção.
MaintenanceRedeployStatus	O status da Operação de Manutenção na máquina virtual.
StatusLevelTypes	O código de nível.
SubResource	A URL relativa do Key Vault que contém o segredo.
VirtualMachineAgentInstanceView	O Agente de VM em execução na máquina virtual.
VirtualMachineExtensionHandlerInstanceView	A exibição da instância do manipulador de extensão da máquina virtual.
VirtualMachineExtensionInstanceView	As informações de extensões.
VirtualMachineHealthStatus	O status de integridade da VM.
VirtualMachineScaleSetVMInstanceView	A exibição de instância de uma VM do conjunto de dimensionamento de máquinas virtuais.

ApiError

Erro de API.

Nome	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

BootDiagnosticsInstanceView

O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

Nome	Tipo	Description
consoleScreenshotBlobUri	string	O URI do blob de captura de tela do console. Observação: Isso não ser definido se o diagnóstico de inicialização estiver habilitado no momento com o armazenamento gerenciado.
serialConsoleLogBlobUri	string	O Uri do blob de log do console serial. Observação: Isso não ser definido se o diagnóstico de inicialização estiver habilitado no momento com o armazenamento gerenciado.
status	InstanceViewStatus	As informações de status de diagnóstico de inicialização para a VM. Observação: Ele será definido somente se houver erros encontrados na habilitação do diagnóstico de inicialização.

CloudError

Uma resposta de erro do serviço de computação.

Nome	Tipo	Description
error	ApiError	Erro de API.

DiskEncryptionSettings

Especifica as configurações de criptografia para o disco do sistema operacional.

Versão mínima da API: 2015-06-15

Nome	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um Segredo do Key Vault.
enabled	boolean	Especifica se a criptografia de disco deve ser habilitada na máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica o local da chave de criptografia de chave no Key Vault.

DiskInstanceView

As informações dos discos.

Nome	Tipo	Description
encryptionSettings	DiskEncryptionSettings[]	Especifica as configurações de criptografia para o disco do sistema operacional. Versão mínima da API: 2015-06-15
name	string	O nome do disco.
statuses	InstanceViewStatus[]	As informações de status do recurso.

HyperVGeneration

A geração do hipervisor da Máquina Virtual [V1, V2]

Nome	Tipo	Description
V1	string
V2	string

InnerError

Detalhes do erro interno.

Nome	Tipo	Description
errordetail	string	A mensagem de erro interna ou o despejo de exceção.
exceptiontype	string	O tipo de exceção.

InstanceViewStatus

Status da exibição da instância.

Nome	Tipo	Description
code	string	O código de status.
displayStatus	string	O rótulo localizável curto para o status.
level	StatusLevelTypes	O código de nível.
message	string	A mensagem de status detalhada, inclusive para alertas e mensagens de erro.
time	string	A hora do status.

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Key Vault.

Nome	Tipo	Description
keyUrl	string	A URL que faz referência a uma chave de criptografia de chave no Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault que contém a chave.

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um Segredo do Key Vault.

Nome	Tipo	Description
secretUrl	string	A URL que faz referência a um segredo em um Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault que contém o segredo.

MaintenanceOperationResultCodeTypes

O último código de resultado da operação de manutenção.

Nome	Tipo	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

O status da Operação de Manutenção na máquina virtual.

Nome	Tipo	Description
isCustomerInitiatedMaintenanceAllowed	boolean	True, se o cliente tiver permissão para executar a Manutenção.
lastOperationMessage	string	Mensagem retornada para a última Operação de Manutenção.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	O último código de resultado da operação de manutenção.
maintenanceWindowEndTime	string	Hora de término para a janela de manutenção.
maintenanceWindowStartTime	string	Hora de início da janela de manutenção.
preMaintenanceWindowEndTime	string	Hora de término para a janela de pré-manutenção.
preMaintenanceWindowStartTime	string	Hora de início da janela de pré-manutenção.

StatusLevelTypes

O código de nível.

Nome	Tipo	Description
Error	string
Info	string
Warning	string

SubResource

A URL relativa do Key Vault que contém o segredo.

Nome	Tipo	Description
id	string	ID do recurso

VirtualMachineAgentInstanceView

O Agente de VM em execução na máquina virtual.

Nome	Tipo	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	A exibição da instância do manipulador de extensão da máquina virtual.
statuses	InstanceViewStatus[]	As informações de status do recurso.
vmAgentVersion	string	A versão completa do Agente de VM.

VirtualMachineExtensionHandlerInstanceView

A exibição da instância do manipulador de extensão da máquina virtual.

Nome	Tipo	Description
status	InstanceViewStatus	O status do manipulador de extensão.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do manipulador de script.

VirtualMachineExtensionInstanceView

As informações de extensões.

Nome	Tipo	Description
name	string	O nome da extensão da máquina virtual.
statuses	InstanceViewStatus[]	As informações de status do recurso.
substatuses	InstanceViewStatus[]	As informações de status do recurso.
type	string	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".
typeHandlerVersion	string	Especifica a versão do manipulador de script.

VirtualMachineHealthStatus

O status de integridade da VM.

Nome	Tipo	Description
status	InstanceViewStatus	As informações de status de integridade da VM.

VirtualMachineScaleSetVMInstanceView

A exibição de instância de uma VM do conjunto de dimensionamento de máquinas virtuais.

Nome	Tipo	Description
assignedHost	string	ID de recurso do host dedicado, no qual a máquina virtual é alocada por meio do posicionamento automático, quando a máquina virtual é associada a um grupo de hosts dedicado que tem o posicionamento automático habilitado. Versão mínima da API: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.
computerName	string	Especifica o nome do sistema operacional do host da máquina virtual. Esse nome não pode ser atualizado após a criação da VM. tamanho máximo (Windows): 15 caracteres Comprimento máximo (Linux): 64 caracteres. Para convenções e restrições de nomenclatura, consulte diretrizes de implementação de serviços de infraestrutura do Azure.
disks	DiskInstanceView[]	As informações dos discos.
extensions	VirtualMachineExtensionInstanceView[]	As informações de extensões.
hyperVGeneration	HyperVGeneration	A geração do hipervisor da Máquina Virtual [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	O status da Operação de Manutenção na máquina virtual.
osName	string	O sistema operacional em execução no computador híbrido.
osVersion	string	A versão do Sistema Operacional em execução no computador híbrido.
placementGroupId	string	O grupo de posicionamento no qual a VM está em execução. Se a VM for desalocada, ela não terá um placementGroupId.
platformFaultDomain	integer	A contagem de domínios de falha.
platformUpdateDomain	integer	A contagem de domínios de atualização.
rdpThumbPrint	string	A impressão digital do certificado da área de trabalho remota.
statuses	InstanceViewStatus[]	As informações de status do recurso.
vmAgent	VirtualMachineAgentInstanceView	O Agente de VM em execução na máquina virtual.
vmHealth	VirtualMachineHealthStatus	O status de integridade da VM.