Virtual Machine Scale Set VMs - Get Instance View

Služba:

Compute

Verze rozhraní API:

2024-07-01

Získá stav virtuálního počítače ze škálovací sady virtuálních počítačů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
instanceId	path	True	string	ID instance virtuálního počítače.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
vmScaleSetName	path	True	string	Název škálovací sady virtuálních počítačů
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
BootDiagnosticsInstanceView	Diagnostika spouštění je funkce ladění, která umožňuje zobrazit výstup konzoly a snímek obrazovky pro diagnostiku stavu virtuálního počítače. Výstup protokolu konzoly můžete snadno zobrazit. Azure také umožňuje zobrazit snímek obrazovky virtuálního počítače z hypervisoru.
CloudError	Odpověď na chybu z výpočetní služby
DiskEncryptionSettings	Určuje nastavení šifrování disku s operačním systémem. Minimální verze api: 2015-06-15
DiskInstanceView	Informace o discích.
HyperVGeneration	Generace hypervisoru virtuálního počítače [V1, V2]
InnerError	Podrobnosti vnitřní chyby.
InstanceViewStatus	Stav zobrazení instance
KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče ve službě Key Vault.
KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.
MaintenanceOperationResultCodeTypes	Kód výsledku poslední operace údržby.
MaintenanceRedeployStatus	Stav operace údržby na virtuálním počítači.
StatusLevelTypes	Kód úrovně.
SubResource	Relativní adresa URL služby Key Vault obsahující tajný klíč.
VirtualMachineAgentInstanceView	Agent virtuálního počítače spuštěný na virtuálním počítači.
VirtualMachineExtensionHandlerInstanceView	Zobrazení instance instance obslužné rutiny rozšíření virtuálního počítače.
VirtualMachineExtensionInstanceView	Informace o rozšířeních.
VirtualMachineHealthStatus	Stav virtuálního počítače
VirtualMachineScaleSetVMInstanceView	Zobrazení instance virtuálního počítače škálovací sady virtuálních počítačů

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

BootDiagnosticsInstanceView

Diagnostika spouštění je funkce ladění, která umožňuje zobrazit výstup konzoly a snímek obrazovky pro diagnostiku stavu virtuálního počítače. Výstup protokolu konzoly můžete snadno zobrazit. Azure také umožňuje zobrazit snímek obrazovky virtuálního počítače z hypervisoru.

Name	Typ	Description
consoleScreenshotBlobUri	string	Identifikátor URI objektu blob v konzole Poznámka: Tato možnost se nebude nastavena, pokud je u spravovaného úložiště aktuálně povolená diagnostika spouštění.
serialConsoleLogBlobUri	string	Identifikátor URI objektu blob protokolu sériové konzoly. Poznámka: Tato možnost se nebude nastavena, pokud je u spravovaného úložiště aktuálně povolená diagnostika spouštění.
status	InstanceViewStatus	Informace o stavu diagnostiky spouštění pro virtuální počítač. Poznámka: Bude nastavena pouze v případě, že při povolování diagnostiky spouštění dojde k chybám.

CloudError

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

DiskEncryptionSettings

Určuje nastavení šifrování disku s operačním systémem.

Minimální verze api: 2015-06-15

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.
enabled	boolean	Určuje, jestli má být na virtuálním počítači povolené šifrování disku.
keyEncryptionKey	KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče ve službě Key Vault.

DiskInstanceView

Informace o discích.

Name	Typ	Description
encryptionSettings	DiskEncryptionSettings[]	Určuje nastavení šifrování disku s operačním systémem. Minimální verze api: 2015-06-15
name	string	Název disku.
statuses	InstanceViewStatus[]	Informace o stavu zdroje

HyperVGeneration

Generace hypervisoru virtuálního počítače [V1, V2]

Name	Typ	Description
V1	string
V2	string

InnerError

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

InstanceViewStatus

Stav zobrazení instance

Name	Typ	Description
code	string	Stavový kód.
displayStatus	string	Krátký lokalizovatelný popisek stavu.
level	StatusLevelTypes	Kód úrovně.
message	string	Podrobná stavová zpráva, včetně výstrah a chybových zpráv.
time	string	Čas stavu.

KeyVaultKeyReference

Určuje umístění šifrovacího klíče klíče ve službě Key Vault.

Name	Typ	Description
keyUrl	string	Adresa URL odkazující na šifrovací klíč klíče ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující klíč.

KeyVaultSecretReference

Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.

Name	Typ	Description
secretUrl	string	Adresa URL odkazující na tajný kód ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující tajný klíč.

MaintenanceOperationResultCodeTypes

Kód výsledku poslední operace údržby.

Name	Typ	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Stav operace údržby na virtuálním počítači.

Name	Typ	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Pravda, pokud má zákazník povoleno provádět údržbu.
lastOperationMessage	string	Zpráva vrácená pro poslední operaci údržby.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Kód výsledku poslední operace údržby.
maintenanceWindowEndTime	string	Koncový čas časového období údržby.
maintenanceWindowStartTime	string	Čas spuštění časového období údržby
preMaintenanceWindowEndTime	string	Čas ukončení časového období před údržbou.
preMaintenanceWindowStartTime	string	Čas spuštění časového období před údržbou.

StatusLevelTypes

Kód úrovně.

Name	Typ	Description
Error	string
Info	string
Warning	string

SubResource

Relativní adresa URL služby Key Vault obsahující tajný klíč.

Name	Typ	Description
id	string	ID prostředku

VirtualMachineAgentInstanceView

Agent virtuálního počítače spuštěný na virtuálním počítači.

Name	Typ	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Zobrazení instance instance obslužné rutiny rozšíření virtuálního počítače.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
vmAgentVersion	string	Úplná verze agenta virtuálního počítače.

VirtualMachineExtensionHandlerInstanceView

Zobrazení instance instance obslužné rutiny rozšíření virtuálního počítače.

Name	Typ	Description
status	InstanceViewStatus	Stav obslužné rutiny rozšíření.
type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.

VirtualMachineExtensionInstanceView

Informace o rozšířeních.

Name	Typ	Description
name	string	Název rozšíření virtuálního počítače.
statuses	InstanceViewStatus[]	Informace o stavu zdroje
substatuses	InstanceViewStatus[]	Informace o stavu zdroje
type	string	Určuje typ rozšíření; Příkladem je CustomScriptExtension.
typeHandlerVersion	string	Určuje verzi obslužné rutiny skriptu.

VirtualMachineHealthStatus

Stav virtuálního počítače

Name	Typ	Description
status	InstanceViewStatus	Informace o stavu virtuálního počítače

VirtualMachineScaleSetVMInstanceView

Zobrazení instance virtuálního počítače škálovací sady virtuálních počítačů

Name	Typ	Description
assignedHost	string	ID prostředku vyhrazeného hostitele, na kterém je virtuální počítač přidělen prostřednictvím automatického umístění, když je virtuální počítač přidružený k vyhrazené skupině hostitelů s povoleným automatickým umístěním. Minimální verze api: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostika spouštění je funkce ladění, která umožňuje zobrazit výstup konzoly a snímek obrazovky pro diagnostiku stavu virtuálního počítače. Výstup protokolu konzoly můžete snadno zobrazit. Azure také umožňuje zobrazit snímek obrazovky virtuálního počítače z hypervisoru.
computerName	string	Určuje název hostitelského operačního systému virtuálního počítače. Tento název nelze po vytvoření virtuálního počítače aktualizovat. Maximální délka (Windows): 15 znaků Maximální délka (Linux): 64 znaků. Zásady vytváření názvů a omezení najdete v tématu pokyny pro implementaci služeb infrastruktury Azure.
disks	DiskInstanceView[]	Informace o discích.
extensions	VirtualMachineExtensionInstanceView[]	Informace o rozšířeních.
hyperVGeneration	HyperVGeneration	Generace hypervisoru virtuálního počítače [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Stav operace údržby na virtuálním počítači.
osName	string	Operační systém spuštěný na hybridním počítači.
osVersion	string	Verze operačního systému spuštěného na hybridním počítači.
placementGroupId	string	Skupina umístění, ve které je virtuální počítač spuštěný. Pokud je virtuální počítač uvolněný, nebude mít id placementGroupId.
platformFaultDomain	integer	Počet domén selhání.
platformUpdateDomain	integer	Počet aktualizačních domén.
rdpThumbPrint	string	Kryptografický otisk certifikátu vzdálené plochy
statuses	InstanceViewStatus[]	Informace o stavu zdroje
vmAgent	VirtualMachineAgentInstanceView	Agent virtuálního počítače spuštěný na virtuálním počítači.
vmHealth	VirtualMachineHealthStatus	Stav virtuálního počítače