Virtual Machine Scale Set VMs - Get Instance View

Pobiera stan maszyny wirtualnej z zestawu skalowania maszyn wirtualnych.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
instanceId
path True

string

Identyfikator wystąpienia maszyny wirtualnej.

resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

vmScaleSetName
path True

string

Nazwa zestawu skalowania maszyn wirtualnych.

api-version
query True

string

Wersja interfejsu API klienta.

Odpowiedzi

Nazwa Typ Opis
200 OK

VirtualMachineScaleSetVMInstanceView

OK

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

Sample Response

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

Definicje

Nazwa Opis
ApiError

Błąd interfejsu API.

ApiErrorBase

Baza błędów interfejsu API.

BootDiagnosticsInstanceView

Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.

CloudError

Odpowiedź na błąd z usługi Compute.

DiskEncryptionSettings

Określa ustawienia szyfrowania dla dysku systemu operacyjnego.

Minimalna wersja interfejsu API: 2015-06-15

DiskInstanceView

Informacje o dyskach.

HyperVGeneration

Generacja funkcji hypervisor maszyny wirtualnej [V1, V2]

InnerError

Szczegóły błędu wewnętrznego.

InstanceViewStatus

Stan widoku wystąpienia.

KeyVaultKeyReference

Określa lokalizację klucza szyfrowania klucza w Key Vault.

KeyVaultSecretReference

Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.

MaintenanceOperationResultCodeTypes

Kod wyniku ostatniej operacji konserwacji.

MaintenanceRedeployStatus

Stan Operacja konserwacji na maszynie wirtualnej.

StatusLevelTypes

Kod poziomu.

SubResource

Względny adres URL Key Vault zawierający wpis tajny.

VirtualMachineAgentInstanceView

Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.

VirtualMachineExtensionHandlerInstanceView

Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.

VirtualMachineExtensionInstanceView

Informacje o rozszerzeniach.

VirtualMachineHealthStatus

Stan kondycji maszyny wirtualnej.

VirtualMachineScaleSetVMInstanceView

Widok wystąpienia maszyny wirtualnej zestawu skalowania maszyn wirtualnych.

ApiError

Błąd interfejsu API.

Nazwa Typ Opis
code

string

Kod błędu.

details

ApiErrorBase[]

Szczegóły błędu interfejsu API

innererror

InnerError

Wewnętrzny błąd interfejsu API

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

BootDiagnosticsInstanceView

Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.

Nazwa Typ Opis
consoleScreenshotBlobUri

string

Identyfikator URI zrzutu ekranu konsoli obiektu blob. Uwaga:Nie zostanie to ustawione, jeśli diagnostyka rozruchu jest obecnie włączona w zarządzanym magazynie.

serialConsoleLogBlobUri

string

Identyfikator URI obiektu blob dziennika konsoli szeregowej. Uwaga:Nie zostanie to ustawione, jeśli diagnostyka rozruchu jest obecnie włączona w zarządzanym magazynie.

status

InstanceViewStatus

Informacje o stanie diagnostyki rozruchu maszyny wirtualnej. Uwaga: Zostanie ona ustawiona tylko wtedy, gdy podczas włączania diagnostyki rozruchu wystąpią błędy.

CloudError

Odpowiedź na błąd z usługi Compute.

Nazwa Typ Opis
error

ApiError

Błąd interfejsu API.

DiskEncryptionSettings

Określa ustawienia szyfrowania dla dysku systemu operacyjnego.

Minimalna wersja interfejsu API: 2015-06-15

Nazwa Typ Opis
diskEncryptionKey

KeyVaultSecretReference

Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.

enabled

boolean

Określa, czy szyfrowanie dysków powinno być włączone na maszynie wirtualnej.

keyEncryptionKey

KeyVaultKeyReference

Określa lokalizację klucza szyfrowania klucza w Key Vault.

DiskInstanceView

Informacje o dyskach.

Nazwa Typ Opis
encryptionSettings

DiskEncryptionSettings[]

Określa ustawienia szyfrowania dla dysku systemu operacyjnego.

Minimalna wersja interfejsu API: 2015-06-15

name

string

Nazwa dysku.

statuses

InstanceViewStatus[]

Informacje o stanie zasobu.

HyperVGeneration

Generacja funkcji hypervisor maszyny wirtualnej [V1, V2]

Nazwa Typ Opis
V1

string

V2

string

InnerError

Szczegóły błędu wewnętrznego.

Nazwa Typ Opis
errordetail

string

Wewnętrzny komunikat o błędzie lub zrzut wyjątku.

exceptiontype

string

Typ wyjątku.

InstanceViewStatus

Stan widoku wystąpienia.

Nazwa Typ Opis
code

string

Kod stanu.

displayStatus

string

Krótka etykieta lokalizowalna dla stanu.

level

StatusLevelTypes

Kod poziomu.

message

string

Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.

time

string

Czas stanu.

KeyVaultKeyReference

Określa lokalizację klucza szyfrowania klucza w Key Vault.

Nazwa Typ Opis
keyUrl

string

Adres URL odwołującego się do klucza szyfrowania klucza w Key Vault.

sourceVault

SubResource

Względny adres URL Key Vault zawierający klucz.

KeyVaultSecretReference

Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.

Nazwa Typ Opis
secretUrl

string

Adres URL odwołujący się do wpisu tajnego w Key Vault.

sourceVault

SubResource

Względny adres URL Key Vault zawierający wpis tajny.

MaintenanceOperationResultCodeTypes

Kod wyniku ostatniej operacji konserwacji.

Nazwa Typ Opis
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

Stan Operacja konserwacji na maszynie wirtualnej.

Nazwa Typ Opis
isCustomerInitiatedMaintenanceAllowed

boolean

Prawda, jeśli klient może wykonać konserwację.

lastOperationMessage

string

Komunikat zwrócony dla ostatniej operacji konserwacji.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

Kod wyniku ostatniej operacji konserwacji.

maintenanceWindowEndTime

string

Godzina zakończenia okna obsługi.

maintenanceWindowStartTime

string

Godzina rozpoczęcia okna obsługi.

preMaintenanceWindowEndTime

string

Godzina zakończenia okna przed konserwacją.

preMaintenanceWindowStartTime

string

Godzina rozpoczęcia okna przed konserwacją.

StatusLevelTypes

Kod poziomu.

Nazwa Typ Opis
Error

string

Info

string

Warning

string

SubResource

Względny adres URL Key Vault zawierający wpis tajny.

Nazwa Typ Opis
id

string

Identyfikator zasobu

VirtualMachineAgentInstanceView

Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.

Nazwa Typ Opis
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.

statuses

InstanceViewStatus[]

Informacje o stanie zasobu.

vmAgentVersion

string

Pełna wersja agenta maszyny wirtualnej.

VirtualMachineExtensionHandlerInstanceView

Widok wystąpienia programu obsługi rozszerzenia maszyny wirtualnej.

Nazwa Typ Opis
status

InstanceViewStatus

Stan procedury obsługi rozszerzeń.

type

string

Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".

typeHandlerVersion

string

Określa wersję programu obsługi skryptów.

VirtualMachineExtensionInstanceView

Informacje o rozszerzeniach.

Nazwa Typ Opis
name

string

Nazwa rozszerzenia maszyny wirtualnej.

statuses

InstanceViewStatus[]

Informacje o stanie zasobu.

substatuses

InstanceViewStatus[]

Informacje o stanie zasobu.

type

string

Określa typ rozszerzenia; przykładem jest "CustomScriptExtension".

typeHandlerVersion

string

Określa wersję programu obsługi skryptów.

VirtualMachineHealthStatus

Stan kondycji maszyny wirtualnej.

Nazwa Typ Opis
status

InstanceViewStatus

Informacje o stanie kondycji maszyny wirtualnej.

VirtualMachineScaleSetVMInstanceView

Widok wystąpienia maszyny wirtualnej zestawu skalowania maszyn wirtualnych.

Nazwa Typ Opis
assignedHost

string

Identyfikator zasobu dedykowanego hosta, na którym maszyna wirtualna jest przydzielana za pośrednictwem automatycznego umieszczania, gdy maszyna wirtualna jest skojarzona z dedykowaną grupą hostów z włączoną funkcją automatycznego umieszczania. Minimalna wersja interfejsu API: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

Diagnostyka rozruchu to funkcja debugowania, która umożliwia wyświetlenie danych wyjściowych konsoli i zrzutu ekranu w celu zdiagnozowania stanu maszyny wirtualnej. Możesz łatwo wyświetlić dane wyjściowe dziennika konsoli. Platforma Azure umożliwia również wyświetlanie zrzutu ekranu maszyny wirtualnej z funkcji hypervisor.

computerName

string

Określa nazwę systemu operacyjnego hosta maszyny wirtualnej.

Nie można zaktualizować tej nazwy po utworzeniu maszyny wirtualnej.

Maksymalna długość (Windows): 15 znaków

Maksymalna długość (Linux): 64 znaki.

Aby zapoznać się z konwencjami i ograniczeniami nazewnictwa , zobacz Wytyczne dotyczące implementacji usług infrastruktury platformy Azure.

disks

DiskInstanceView[]

Informacje o dyskach.

extensions

VirtualMachineExtensionInstanceView[]

Informacje o rozszerzeniach.

hyperVGeneration

HyperVGeneration

Generacja funkcji hypervisor maszyny wirtualnej [V1, V2]

maintenanceRedeployStatus

MaintenanceRedeployStatus

Stan Operacja konserwacji na maszynie wirtualnej.

osName

string

System operacyjny uruchomiony na maszynie hybrydowej.

osVersion

string

Wersja systemu operacyjnego uruchomiona na maszynie hybrydowej.

placementGroupId

string

Grupa umieszczania, w której jest uruchomiona maszyna wirtualna. Jeśli przydział maszyny wirtualnej zostanie cofnięty, nie będzie miał identyfikatora placementGroupId.

platformFaultDomain

integer

Liczba domen błędów.

platformUpdateDomain

integer

Liczba domen aktualizacji.

rdpThumbPrint

string

Odcisk palca certyfikatu pulpitu zdalnego.

statuses

InstanceViewStatus[]

Informacje o stanie zasobu.

vmAgent

VirtualMachineAgentInstanceView

Agent maszyny wirtualnej uruchomiony na maszynie wirtualnej.

vmHealth

VirtualMachineHealthStatus

Stan kondycji maszyny wirtualnej.