Udostępnij za pośrednictwem


Consoles - Get

Pobierz konsolę maszyny wirtualnej.
Pobierz właściwości podanej konsoli maszyny wirtualnej.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}?api-version=2023-07-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
consoleName
path True

string

Nazwa konsoli maszyny wirtualnej.

Wzorzec wyrażenia regularnego: ^default$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

uuid

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

virtualMachineName
path True

string

Nazwa maszyny wirtualnej.

Wzorzec wyrażenia regularnego: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Console

OK

Other Status Codes

ErrorResponse

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

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Get virtual machine console

Przykładowe żądanie

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default?api-version=2023-07-01

Przykładowa odpowiedź

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default",
  "name": "default",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/virtualMachines/consoles",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"
  },
  "properties": {
    "sshPublicKey": {
      "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
    },
    "enabled": "True",
    "expiration": "2022-06-01T01:27:03.008Z",
    "provisioningState": "Succeeded",
    "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls",
    "virtualMachineAccessId": "VirtualMachineAccessId",
    "detailedStatus": "Ready",
    "detailedStatusMessage": "Console is ready for use"
  }
}

Definicje

Nazwa Opis
Console

Konsola reprezentuje konsolę lokalnej maszyny wirtualnej w chmurze sieciowej.

ConsoleDetailedStatus

Bardziej szczegółowy stan konsoli.

ConsoleEnabled

Wskaźnik, czy dostęp do konsoli jest włączony.

ConsoleProvisioningState

Stan aprowizacji konsoli maszyny wirtualnej.

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

ExtendedLocation

ExtendedLocation reprezentuje niestandardową lokalizację platformy Azure, w której zostanie utworzony zasób.

SshPublicKey

SshPublicKey reprezentuje klucz publiczny używany do uwierzytelniania za pomocą zasobu za pośrednictwem protokołu SSH.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Console

Konsola reprezentuje konsolę lokalnej maszyny wirtualnej w chmurze sieciowej.

Nazwa Typ Opis
extendedLocation

ExtendedLocation

ExtendedLocation reprezentuje niestandardową lokalizację platformy Azure, w której zostanie utworzony zasób.
Rozszerzona lokalizacja menedżera klastra skojarzonego z klastrem, na który jest tworzona ta maszyna wirtualna.

id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.detailedStatus

ConsoleDetailedStatus

Bardziej szczegółowy stan konsoli.

properties.detailedStatusMessage

string

Opisowy komunikat o bieżącym szczegółowym stanie.

properties.enabled

ConsoleEnabled

Wskaźnik, czy dostęp do konsoli jest włączony.

properties.expiration

string

Data i godzina, po której klucz będzie niedozwolony.

properties.privateLinkServiceId

string

Identyfikator zasobu usługi łącza prywatnego używany do zapewnienia dostępu do konsoli maszyny wirtualnej.

properties.provisioningState

ConsoleProvisioningState

Stan aprowizacji konsoli maszyny wirtualnej.

properties.sshPublicKey

SshPublicKey

SshPublicKey reprezentuje klucz publiczny używany do uwierzytelniania za pomocą zasobu za pośrednictwem protokołu SSH.
Klucz publiczny SSH, który zostanie aprowizowany na potrzeby dostępu użytkowników. Oczekuje się, że użytkownik będzie miał odpowiedni klucz prywatny SSH na potrzeby logowania.

properties.virtualMachineAccessId

string

Unikatowy identyfikator maszyny wirtualnej używanej do uzyskiwania dostępu do konsoli.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

Bardziej szczegółowy stan konsoli.

Nazwa Typ Opis
Error

string

Ready

string

ConsoleEnabled

Wskaźnik, czy dostęp do konsoli jest włączony.

Nazwa Typ Opis
False

string

True

string

ConsoleProvisioningState

Stan aprowizacji konsoli maszyny wirtualnej.

Nazwa Typ Opis
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

ExtendedLocation

ExtendedLocation reprezentuje niestandardową lokalizację platformy Azure, w której zostanie utworzony zasób.

Nazwa Typ Opis
name

string

Identyfikator zasobu lokalizacji rozszerzonej, w której zostanie utworzony zasób.

type

string

Typ lokalizacji rozszerzonej, na przykład CustomLocation.

SshPublicKey

SshPublicKey reprezentuje klucz publiczny używany do uwierzytelniania za pomocą zasobu za pośrednictwem protokołu SSH.

Nazwa Typ Opis
keyData

string

Dane klucza publicznego SSH.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.