Virtual Machine Scale Set VMs - Get Instance View

Reference

Service:: Compute

API Version:: 2024-03-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-03-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 je 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

Tok Azure Active Directory OAuth2

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

Scopes

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.

Sample Request

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

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

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

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

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

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 a diagnostikovat stav 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	Chybová odpověď ze služby Compute.
DiskEncryptionSettings	Určuje nastavení šifrování disku s operačním systémem. Minimální verze rozhraní API: 2015-06-15
DiskInstanceView	Informace o discích.
HyperVGeneration	Generování hypervisoru virtuálního počítače [V1, V2]
InnerError	Podrobnosti o vnitřní chybě.
InstanceViewStatus	Stav zobrazení instance.
KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče v Key Vault.
KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč 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 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 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 a diagnostikovat stav 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 na snímku obrazovky konzoly Poznámka: Tato možnost se nenastaví , pokud je diagnostika spouštění aktuálně povolená se spravovaným úložištěm.
serialConsoleLogBlobUri	string	Identifikátor URI protokolu protokolu sériové konzoly. Poznámka: Tato možnost se nenastaví , pokud je diagnostika spouštění aktuálně povolená se spravovaným úložištěm.
status	InstanceViewStatus	Informace o stavu diagnostiky spouštění virtuálního počítače Poznámka: Nastaví se pouze v případě, že při povolování diagnostiky spouštění dojde k chybám.

CloudError

Chybová odpověď ze služby Compute.

Name	Typ	Description
error	ApiError	Chyba rozhraní API

DiskEncryptionSettings

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

Minimální verze rozhraní API: 2015-06-15

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč 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 v 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 rozhraní API: 2015-06-15
name	string	Název disku.
statuses	InstanceViewStatus[]	Informace o stavu prostředku.

HyperVGeneration

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

Name	Typ	Description
V1	string
V2	string

InnerError

Podrobnosti o vnitřní chybě.

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ě upozornění a chybových zpráv.
time	string	Čas stavu.

KeyVaultKeyReference

Určuje umístění šifrovacího klíče klíče v Key Vault.

Name	Typ	Description
keyUrl	string	Adresa URL odkazující na šifrovací klíč klíče v Key Vault.
sourceVault	SubResource	Relativní adresa URL Key Vault obsahující klíč.

KeyVaultSecretReference

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

Name	Typ	Description
secretUrl	string	Adresa URL odkazující na tajný kód v Key Vault.
sourceVault	SubResource	Relativní adresa URL 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 zákazník může 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 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 obslužné rutiny rozšíření virtuálního počítače
statuses	InstanceViewStatus[]	Informace o stavu prostředku.
vmAgentVersion	string	Plná verze agenta virtuálního počítače.

VirtualMachineExtensionHandlerInstanceView

Zobrazení 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 prostředku.
substatuses	InstanceViewStatus[]	Informace o stavu prostředku.
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, kterému 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 rozhraní API: 1. 6. 2020.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostika spouštění je funkce ladění, která umožňuje zobrazit výstup konzoly a snímek obrazovky a diagnostikovat stav 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 operačního systému hostitele 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 a omezení vytváření názvů najdete v pokynech k implementaci služeb infrastruktury Azure.
disks	DiskInstanceView[]	Informace o discích.
extensions	VirtualMachineExtensionInstanceView[]	Informace o rozšířeních.
hyperVGeneration	HyperVGeneration	Generování 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á 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 hodnotu placementGroupId.
platformFaultDomain	integer	Počet domén selhání.
platformUpdateDomain	integer	Aktualizovat počet domén.
rdpThumbPrint	string	Kryptografický otisk certifikátu vzdálené plochy.
statuses	InstanceViewStatus[]	Informace o stavu prostředku.
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.

Sdílet prostřednictvím

Virtual Machine Scale Set VMs - Get Instance View

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

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

Sample Request

Sample Response

Definice

ApiError

ApiErrorBase

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGeneration

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineScaleSetVMInstanceView

Další materiály