Virtual Machine Scale Set VMs - Get Instance View

Service:

Compute

API-versie:

2024-07-01

Hiermee haalt u de status van een virtuele machine op uit een VM-schaalset.

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

URI-parameters

Name	In	Vereist	Type	Description
instanceId	path	True	string	De exemplaar-id van de virtuele machine.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
vmScaleSetName	path	True	string	De naam van de VM-schaalset.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ApiError	Api-fout.
ApiErrorBase	Api-foutbasis.
BootDiagnosticsInstanceView	Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.
CloudError	Een foutreactie van de Compute-service.
DiskEncryptionSettings	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15
DiskInstanceView	De gegevens van de schijven.
HyperVGeneration	De hypervisorgeneratie van de virtuele machine [V1, V2]
InnerError	Interne foutdetails.
InstanceViewStatus	Status van exemplaarweergave.
KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.
KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel, een Sleutelkluisgeheim.
MaintenanceOperationResultCodeTypes	De resultaatcode van de laatste onderhoudsbewerking.
MaintenanceRedeployStatus	De onderhoudsbewerkingsstatus op de virtuele machine.
StatusLevelTypes	De niveaucode.
SubResource	De relatieve URL van de sleutelkluis die het geheim bevat.
VirtualMachineAgentInstanceView	De VM-agent die wordt uitgevoerd op de virtuele machine.
VirtualMachineExtensionHandlerInstanceView	De instantieweergave van de extensie-handler van de virtuele machine.
VirtualMachineExtensionInstanceView	De uitbreidingsgegevens.
VirtualMachineHealthStatus	De status van de VIRTUELE machine.
VirtualMachineScaleSetVMInstanceView	De exemplaarweergave van een virtuele-machineschaalset-VM.

ApiError

Api-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	Details van de API-fout
innererror	InnerError	De interne API-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

Api-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

BootDiagnosticsInstanceView

Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.

Name	Type	Description
consoleScreenshotBlobUri	string	De schermafbeelding van de blob-URI van de console. Opmerking: Dit niet worden ingesteld als diagnostische gegevens over opstarten momenteel zijn ingeschakeld met beheerde opslag.
serialConsoleLogBlobUri	string	De blob-URI van het seriële consolelogboek. Opmerking: Dit niet worden ingesteld als diagnostische gegevens over opstarten momenteel zijn ingeschakeld met beheerde opslag.
status	InstanceViewStatus	De statusinformatie over diagnostische gegevens over opstarten voor de virtuele machine. Opmerking: Deze wordt alleen ingesteld als er fouten zijn opgetreden bij het inschakelen van diagnostische gegevens over opstarten.

CloudError

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	Api-fout.

DiskEncryptionSettings

Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf.

Minimale API-versie: 2015-06-15

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel, een Sleutelkluisgeheim.
enabled	boolean	Hiermee geeft u op of schijfversleuteling moet worden ingeschakeld op de virtuele machine.
keyEncryptionKey	KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

DiskInstanceView

De gegevens van de schijven.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15
name	string	De naam van de schijf.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.

HyperVGeneration

De hypervisorgeneratie van de virtuele machine [V1, V2]

Name	Type	Description
V1	string
V2	string

InnerError

Interne foutdetails.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

InstanceViewStatus

Status van exemplaarweergave.

Name	Type	Description
code	string	De statuscode.
displayStatus	string	Het korte lokaliseerbare label voor de status.
level	StatusLevelTypes	De niveaucode.
message	string	Het gedetailleerde statusbericht, inclusief voor waarschuwingen en foutberichten.
time	string	Het tijdstip van de status.

KeyVaultKeyReference

Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

Name	Type	Description
keyUrl	string	De URL die verwijst naar een sleutelversleutelingssleutel in Key Vault.
sourceVault	SubResource	De relatieve URL van de sleutelkluis die de sleutel bevat.

KeyVaultSecretReference

Hiermee geeft u de locatie van de schijfversleutelingssleutel, een Sleutelkluisgeheim.

Name	Type	Description
secretUrl	string	De URL die verwijst naar een geheim in een Sleutelkluis.
sourceVault	SubResource	De relatieve URL van de sleutelkluis die het geheim bevat.

MaintenanceOperationResultCodeTypes

De resultaatcode van de laatste onderhoudsbewerking.

Name	Type	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

De onderhoudsbewerkingsstatus op de virtuele machine.

Name	Type	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Waar, als de klant onderhoud mag uitvoeren.
lastOperationMessage	string	Bericht geretourneerd voor de laatste onderhoudsbewerking.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	De resultaatcode van de laatste onderhoudsbewerking.
maintenanceWindowEndTime	string	Eindtijd voor het onderhoudsvenster.
maintenanceWindowStartTime	string	Begintijd voor het onderhoudsvenster.
preMaintenanceWindowEndTime	string	Eindtijd voor het venster Voor onderhoud.
preMaintenanceWindowStartTime	string	Begintijd voor het venster Voor onderhoud.

StatusLevelTypes

De niveaucode.

Name	Type	Description
Error	string
Info	string
Warning	string

SubResource

De relatieve URL van de sleutelkluis die het geheim bevat.

Name	Type	Description
id	string	Resource-id

VirtualMachineAgentInstanceView

De VM-agent die wordt uitgevoerd op de virtuele machine.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	De instantieweergave van de extensie-handler van de virtuele machine.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
vmAgentVersion	string	De volledige versie van de VM-agent.

VirtualMachineExtensionHandlerInstanceView

De instantieweergave van de extensie-handler van de virtuele machine.

Name	Type	Description
status	InstanceViewStatus	De status van de extensie-handler.
type	string	Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.
typeHandlerVersion	string	Hiermee geeft u de versie van de scripthandler.

VirtualMachineExtensionInstanceView

De uitbreidingsgegevens.

Name	Type	Description
name	string	De naam van de extensie van de virtuele machine.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
substatuses	InstanceViewStatus[]	De informatie over de resourcestatus.
type	string	Hiermee geeft u het type van de extensie; een voorbeeld is CustomScriptExtension.
typeHandlerVersion	string	Hiermee geeft u de versie van de scripthandler.

VirtualMachineHealthStatus

De status van de VIRTUELE machine.

Name	Type	Description
status	InstanceViewStatus	De statusinformatie voor de VIRTUELE machine.

VirtualMachineScaleSetVMInstanceView

De exemplaarweergave van een virtuele-machineschaalset-VM.

Name	Type	Description
assignedHost	string	Resource-id van de toegewezen host, waarop de virtuele machine wordt toegewezen via automatische plaatsing, wanneer de virtuele machine is gekoppeld aan een toegewezen hostgroep waarvoor automatische plaatsing is ingeschakeld. Minimale API-versie: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Diagnostische gegevens over opstarten is een functie voor foutopsporing waarmee u console-uitvoer en schermopname kunt bekijken om de VM-status te diagnosticeren. U kunt eenvoudig de uitvoer van uw consolelogboek bekijken. Met Azure kunt u ook een schermopname van de virtuele machine bekijken vanuit de hypervisor.
computerName	string	Hiermee geeft u de naam van het host-besturingssysteem van de virtuele machine. Deze naam kan niet worden bijgewerkt nadat de virtuele machine is gemaakt. Maximale lengte (Windows): 15 tekens Maximale lengte (Linux): 64 tekens. Zie implementatierichtlijnen voor Azure-infrastructuurservicesvoor naamconventies en -beperkingen.
disks	DiskInstanceView[]	De gegevens van de schijven.
extensions	VirtualMachineExtensionInstanceView[]	De uitbreidingsgegevens.
hyperVGeneration	HyperVGeneration	De hypervisorgeneratie van de virtuele machine [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	De onderhoudsbewerkingsstatus op de virtuele machine.
osName	string	Het besturingssysteem dat wordt uitgevoerd op de hybride machine.
osVersion	string	De versie van het besturingssysteem die wordt uitgevoerd op de hybride machine.
placementGroupId	string	De plaatsingsgroep waarin de VIRTUELE machine wordt uitgevoerd. Als de toewijzing van de VIRTUELE machine ongedaan is gemaakt, heeft deze geen placementGroupId.
platformFaultDomain	integer	Het aantal foutdomeinen.
platformUpdateDomain	integer	Het aantal updatedomeinen.
rdpThumbPrint	string	De vingerafdruk van het extern bureaublad-certificaat.
statuses	InstanceViewStatus[]	De informatie over de resourcestatus.
vmAgent	VirtualMachineAgentInstanceView	De VM-agent die wordt uitgevoerd op de virtuele machine.
vmHealth	VirtualMachineHealthStatus	De status van de VIRTUELE machine.