Virtual Machine Scale Set VMs - Get Instance View

Tjänst:

Compute

API-version:

2024-03-01

Hämtar status för en virtuell dator från en VM-skalningsuppsättning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
instanceId	path	True	string	Den virtuella datorns instans-ID.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vmScaleSetName	path	True	string	Namnet på VM-skalningsuppsättningen.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

HTTP

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

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

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/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

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
BootDiagnosticsInstanceView	Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.
CloudError	Ett felsvar från Beräkningstjänsten.
DiskEncryptionSettings	Anger krypteringsinställningarna för OS-disken. Lägsta API-version: 2015-06-15
DiskInstanceView	Diskinformationen.
HyperVGeneration	Hypervisor-genereringen av den virtuella datorn [V1, V2]
InnerError	Inre felinformation.
InstanceViewStatus	Status för instansvy.
KeyVaultKeyReference	Anger platsen för nyckelkrypteringsnyckeln i Key Vault.
KeyVaultSecretReference	Anger platsen för diskkrypteringsnyckeln, som är en Key Vault hemlighet.
MaintenanceOperationResultCodeTypes	Resultatkoden för den senaste underhållsåtgärden.
MaintenanceRedeployStatus	Status för underhållsåtgärd på den virtuella datorn.
StatusLevelTypes	Nivåkoden.
SubResource	Den relativa URL:en för Key Vault som innehåller hemligheten.
VirtualMachineAgentInstanceView	VM-agenten som körs på den virtuella datorn.
VirtualMachineExtensionHandlerInstanceView	Instansvyn för tilläggshanteraren för virtuella datorer.
VirtualMachineExtensionInstanceView	Tilläggsinformationen.
VirtualMachineHealthStatus	Hälsostatus för den virtuella datorn.
VirtualMachineScaleSetVMInstanceView	Instansvyn för en virtuell dators skalningsuppsättnings-VM.

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

BootDiagnosticsInstanceView

Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.

Name	Typ	Description
consoleScreenshotBlobUri	string	Konsolens skärmbild av blob-URI:n. Observera: Detta anges inte om startdiagnostik för närvarande är aktiverat med hanterad lagring.
serialConsoleLogBlobUri	string	Blob-URI:n för seriekonsolloggen. Observera: Detta anges inte om startdiagnostik för närvarande är aktiverat med hanterad lagring.
status	InstanceViewStatus	Statusinformation för startdiagnostik för den virtuella datorn. Observera: Den anges endast om det uppstår fel vid aktivering av startdiagnostik.

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

DiskEncryptionSettings

Anger krypteringsinställningarna för OS-disken.

Lägsta API-version: 2015-06-15

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Anger platsen för diskkrypteringsnyckeln, som är en Key Vault hemlighet.
enabled	boolean	Anger om diskkryptering ska aktiveras på den virtuella datorn.
keyEncryptionKey	KeyVaultKeyReference	Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

DiskInstanceView

Diskinformationen.

Name	Typ	Description
encryptionSettings	DiskEncryptionSettings[]	Anger krypteringsinställningarna för OS-disken. Lägsta API-version: 2015-06-15
name	string	Disknamnet.
statuses	InstanceViewStatus[]	Resursstatusinformationen.

HyperVGeneration

Hypervisor-genereringen av den virtuella datorn [V1, V2]

Name	Typ	Description
V1	string
V2	string

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

InstanceViewStatus

Status för instansvy.

Name	Typ	Description
code	string	Statuskoden.
displayStatus	string	Den korta localizable etiketten för statusen.
level	StatusLevelTypes	Nivåkoden.
message	string	Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden.
time	string	Tiden för statusen.

KeyVaultKeyReference

Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

Name	Typ	Description
keyUrl	string	URL:en som refererar till en nyckelkrypteringsnyckel i Key Vault.
sourceVault	SubResource	Den relativa URL:en för Key Vault som innehåller nyckeln.

KeyVaultSecretReference

Anger platsen för diskkrypteringsnyckeln, som är en Key Vault hemlighet.

Name	Typ	Description
secretUrl	string	URL:en som refererar till en hemlighet i en Key Vault.
sourceVault	SubResource	Den relativa URL:en för Key Vault som innehåller hemligheten.

MaintenanceOperationResultCodeTypes

Resultatkoden för den senaste underhållsåtgärden.

Name	Typ	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Status för underhållsåtgärd på den virtuella datorn.

Name	Typ	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Sant, om kunden får utföra underhåll.
lastOperationMessage	string	Meddelande som returnerades för den senaste underhållsåtgärden.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Resultatkoden för den senaste underhållsåtgärden.
maintenanceWindowEndTime	string	Sluttid för underhållsfönstret.
maintenanceWindowStartTime	string	Starttid för underhållsfönstret.
preMaintenanceWindowEndTime	string	Sluttid för fönstret Förunderhåll.
preMaintenanceWindowStartTime	string	Starttid för fönstret Förunderhåll.

StatusLevelTypes

Nivåkoden.

Name	Typ	Description
Error	string
Info	string
Warning	string

SubResource

Den relativa URL:en för Key Vault som innehåller hemligheten.

Name	Typ	Description
id	string	Resurs-ID

VirtualMachineAgentInstanceView

VM-agenten som körs på den virtuella datorn.

Name	Typ	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Instansvyn för tilläggshanteraren för virtuella datorer.
statuses	InstanceViewStatus[]	Resursstatusinformationen.
vmAgentVersion	string	Vm-agentens fullständiga version.

VirtualMachineExtensionHandlerInstanceView

Instansvyn för tilläggshanteraren för virtuella datorer.

Name	Typ	Description
status	InstanceViewStatus	Status för tilläggshanteraren.
type	string	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".
typeHandlerVersion	string	Anger versionen av skripthanteraren.

VirtualMachineExtensionInstanceView

Tilläggsinformationen.

Name	Typ	Description
name	string	Namnet på det virtuella datortillägget.
statuses	InstanceViewStatus[]	Resursstatusinformationen.
substatuses	InstanceViewStatus[]	Resursstatusinformationen.
type	string	Anger filnamnstilläggets typ. ett exempel är "CustomScriptExtension".
typeHandlerVersion	string	Anger versionen av skripthanteraren.

VirtualMachineHealthStatus

Hälsostatus för den virtuella datorn.

Name	Typ	Description
status	InstanceViewStatus	Hälsostatusinformationen för den virtuella datorn.

VirtualMachineScaleSetVMInstanceView

Instansvyn för en virtuell dators skalningsuppsättnings-VM.

Name	Typ	Description
assignedHost	string	Resurs-ID för den dedikerade värden, där den virtuella datorn allokeras via automatisk placering, när den virtuella datorn är associerad med en dedikerad värdgrupp som har automatisk placering aktiverad. Lägsta API-version: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Startdiagnostik är en felsökningsfunktion som gör att du kan visa konsolutdata och skärmbild för att diagnostisera VM-status. Du kan enkelt visa utdata från konsolloggen. Med Azure kan du också se en skärmbild av den virtuella datorn från hypervisor-programmet.
computerName	string	Anger värdoperativsystemets namn på den virtuella datorn. Det går inte att uppdatera det här namnet när den virtuella datorn har skapats. Maxlängd (Windows): 15 tecken Maxlängd (Linux): 64 tecken. Namngivningskonventioner och begränsningar finns i Implementeringsriktlinjer för Azure-infrastrukturtjänster.
disks	DiskInstanceView[]	Diskinformationen.
extensions	VirtualMachineExtensionInstanceView[]	Tilläggsinformationen.
hyperVGeneration	HyperVGeneration	Hypervisor-genereringen av den virtuella datorn [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Status för underhållsåtgärd på den virtuella datorn.
osName	string	Operativsystemet som körs på hybriddatorn.
osVersion	string	Den version av operativsystemet som körs på hybriddatorn.
placementGroupId	string	Placeringsgruppen där den virtuella datorn körs. Om den virtuella datorn frigörs har den inget placementGroupId.
platformFaultDomain	integer	Antal feldomäner.
platformUpdateDomain	integer	Antalet uppdateringsdomäner.
rdpThumbPrint	string	Tumavtrycket fjärrskrivbordscertifikat.
statuses	InstanceViewStatus[]	Resursstatusinformationen.
vmAgent	VirtualMachineAgentInstanceView	VM-agenten som körs på den virtuella datorn.
vmHealth	VirtualMachineHealthStatus	Hälsostatus för den virtuella datorn.