Virtual Machine Scale Set VMs - Get Instance View

Referencia

Service:: Compute

API Version:: 2024-03-01

Lekéri egy virtuális gép állapotát egy virtuálisgép-méretezési csoportból.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
instanceId	path	True	string	A virtuális gép példányazonosítója.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
vmScaleSetName	path	True	string	A virtuálisgép-méretezési csoport neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	VirtualMachineScaleSetVMInstanceView	OK
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
ApiError	Api-hiba.
ApiErrorBase	Api-hibabázis.
BootDiagnosticsInstanceView	A rendszerindítási diagnosztika egy hibakeresési funkció, amely lehetővé teszi a konzol kimenetének és képernyőképének megtekintését a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.
CloudError	Hibaválasz a Számítási szolgáltatástól.
DiskEncryptionSettings	Megadja az operációsrendszer-lemez titkosítási beállításait. Minimális API-verzió: 2015-06-15
DiskInstanceView	A lemezek adatai.
HyperVGeneration	A virtuális gép hipervizor-generációja [V1, V2]
InnerError	Belső hiba részletei.
InstanceViewStatus	Példánynézet állapota.
KeyVaultKeyReference	Meghatározza a kulcstitkosítási kulcs helyét a Key Vault.
KeyVaultSecretReference	Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault titkos kód.
MaintenanceOperationResultCodeTypes	Az utolsó karbantartási művelet eredménykódja.
MaintenanceRedeployStatus	A karbantartási művelet állapota a virtuális gépen.
StatusLevelTypes	A szintkód.
SubResource	A titkos kulcsot tartalmazó Key Vault relatív URL-címe.
VirtualMachineAgentInstanceView	A virtuális gépen futó virtuálisgép-ügynök.
VirtualMachineExtensionHandlerInstanceView	A virtuálisgép-bővítménykezelő példánynézete.
VirtualMachineExtensionInstanceView	A bővítmények adatai.
VirtualMachineHealthStatus	A virtuális gép állapota.
VirtualMachineScaleSetVMInstanceView	Virtuálisgép-méretezési csoport virtuális gépének példánynézete.

ApiError

Api-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az API belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

Api-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

BootDiagnosticsInstanceView

A rendszerindítási diagnosztika egy hibakeresési funkció, amely lehetővé teszi a konzol kimenetének és képernyőképének megtekintését a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.

Name	Típus	Description
consoleScreenshotBlobUri	string	A konzol képernyőképe blob URI-ja. Megjegyzés: Ez nem lesz beállítva, ha a rendszerindítási diagnosztika jelenleg engedélyezve van a felügyelt tárterületen.
serialConsoleLogBlobUri	string	A soros konzol naplójának blob URI-ja. Megjegyzés: Ez nem lesz beállítva, ha a rendszerindítási diagnosztika jelenleg engedélyezve van a felügyelt tárterületen.
status	InstanceViewStatus	A virtuális gép rendszerindítási diagnosztikai állapotadatai. Megjegyzés: Csak akkor lesz beállítva, ha a rendszerindítási diagnosztikák engedélyezése során hibák léptek fel.

CloudError

Hibaválasz a Számítási szolgáltatástól.

Name	Típus	Description
error	ApiError	Api-hiba.

DiskEncryptionSettings

Megadja az operációsrendszer-lemez titkosítási beállításait.

Minimális API-verzió: 2015-06-15

Name	Típus	Description
diskEncryptionKey	KeyVaultSecretReference	Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault titkos kód.
enabled	boolean	Megadja, hogy engedélyezve legyen-e a lemeztitkosítás a virtuális gépen.
keyEncryptionKey	KeyVaultKeyReference	Meghatározza a kulcstitkosítási kulcs helyét a Key Vault.

DiskInstanceView

A lemezek adatai.

Name	Típus	Description
encryptionSettings	DiskEncryptionSettings[]	Megadja az operációsrendszer-lemez titkosítási beállításait. Minimális API-verzió: 2015-06-15
name	string	A lemez neve.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.

HyperVGeneration

A virtuális gép hipervizor-generációja [V1, V2]

Name	Típus	Description
V1	string
V2	string

InnerError

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

InstanceViewStatus

Példánynézet állapota.

Name	Típus	Description
code	string	Az állapotkód.
displayStatus	string	Az állapot rövid honosítható címkéje.
level	StatusLevelTypes	A szintkód.
message	string	A részletes állapotüzenet, beleértve a riasztásokat és a hibaüzeneteket is.
time	string	Az állapot időpontja.

KeyVaultKeyReference

Meghatározza a kulcstitkosítási kulcs helyét a Key Vault.

Name	Típus	Description
keyUrl	string	A kulcstitkosítási kulcsra hivatkozó URL-cím Key Vault.
sourceVault	SubResource	A kulcsot tartalmazó Key Vault relatív URL-címe.

KeyVaultSecretReference

Megadja a lemeztitkosítási kulcs helyét, amely egy Key Vault titkos kód.

Name	Típus	Description
secretUrl	string	Az URL-cím egy titkos kódra hivatkozik egy Key Vault.
sourceVault	SubResource	A titkos kulcsot tartalmazó Key Vault relatív URL-címe.

MaintenanceOperationResultCodeTypes

Az utolsó karbantartási művelet eredménykódja.

Name	Típus	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

A karbantartási művelet állapota a virtuális gépen.

Name	Típus	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Igaz, ha az ügyfél jogosult karbantartást végezni.
lastOperationMessage	string	Az utolsó karbantartási művelethez visszaadott üzenet.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Az utolsó karbantartási művelet eredménykódja.
maintenanceWindowEndTime	string	A karbantartási időszak befejezési ideje.
maintenanceWindowStartTime	string	A karbantartási időszak kezdési időpontja.
preMaintenanceWindowEndTime	string	A karbantartás előtti időszak befejezési ideje.
preMaintenanceWindowStartTime	string	A karbantartás előtti időszak kezdési időpontja.

StatusLevelTypes

A szintkód.

Name	Típus	Description
Error	string
Info	string
Warning	string

SubResource

A titkos kulcsot tartalmazó Key Vault relatív URL-címe.

Name	Típus	Description
id	string	Erőforrás-azonosító

VirtualMachineAgentInstanceView

A virtuális gépen futó virtuálisgép-ügynök.

Name	Típus	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	A virtuálisgép-bővítménykezelő példánynézete.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
vmAgentVersion	string	A virtuálisgép-ügynök teljes verziója.

VirtualMachineExtensionHandlerInstanceView

A virtuálisgép-bővítménykezelő példánynézete.

Name	Típus	Description
status	InstanceViewStatus	A bővítménykezelő állapota.
type	string	Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".
typeHandlerVersion	string	A szkriptkezelő verzióját adja meg.

VirtualMachineExtensionInstanceView

A bővítmények adatai.

Name	Típus	Description
name	string	A virtuálisgép-bővítmény neve.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
substatuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
type	string	Megadja a bővítmény típusát; Ilyen például a "CustomScriptExtension".
typeHandlerVersion	string	A szkriptkezelő verzióját adja meg.

VirtualMachineHealthStatus

A virtuális gép állapota.

Name	Típus	Description
status	InstanceViewStatus	A virtuális gép állapotadatai.

VirtualMachineScaleSetVMInstanceView

Virtuálisgép-méretezési csoport virtuális gépének példánynézete.

Name	Típus	Description
assignedHost	string	Annak a dedikált gazdagépnek az erőforrás-azonosítója, amelyen a virtuális gép automatikus elhelyezéssel van lefoglalva, ha a virtuális gép egy olyan dedikált gazdagépcsoporthoz van társítva, amelyen engedélyezve van az automatikus elhelyezés. Minimális API-verzió: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	A rendszerindítási diagnosztika egy hibakeresési funkció, amely lehetővé teszi a konzol kimenetének és képernyőképének megtekintését a virtuális gép állapotának diagnosztizálásához. A konzolnapló kimenetét egyszerűen megtekintheti. Az Azure lehetővé teszi a virtuális gép képernyőképének megtekintését is a hipervizorból.
computerName	string	Megadja a virtuális gép gazda operációs rendszerének nevét. Ez a név nem frissíthető a virtuális gép létrehozása után. Maximális hossz (Windows): 15 karakter Maximális hossz (Linux): 64 karakter. Az elnevezési konvenciókról és korlátozásokról az Azure infrastruktúra-szolgáltatások implementálási irányelvei című témakörben olvashat.
disks	DiskInstanceView[]	A lemezek adatai.
extensions	VirtualMachineExtensionInstanceView[]	A bővítmények adatai.
hyperVGeneration	HyperVGeneration	A virtuális gép hipervizor-generációja [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	A karbantartási művelet állapota a virtuális gépen.
osName	string	A hibrid gépen futó operációs rendszer.
osVersion	string	A hibrid gépen futó operációs rendszer verziója.
placementGroupId	string	Az az elhelyezési csoport, amelyben a virtuális gép fut. Ha a virtuális gép felszabadítva van, nem rendelkezik placementGroupId azonosítóval.
platformFaultDomain	integer	A tartalék tartomány száma.
platformUpdateDomain	integer	A Frissítési tartomány száma.
rdpThumbPrint	string	A Távoli asztali tanúsítvány ujjlenyomata.
statuses	InstanceViewStatus[]	Az erőforrás állapotadatai.
vmAgent	VirtualMachineAgentInstanceView	A virtuális gépen futó virtuálisgép-ügynök.
vmHealth	VirtualMachineHealthStatus	A virtuális gép állapota.

Virtual Machine Scale Set VMs - Get Instance View

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

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

Definíciók

ApiError

ApiErrorBase

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGeneration

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineScaleSetVMInstanceView

További források