Freigeben über


Consoles - Get

Rufen Sie die Konsole des virtuellen Computers ab.
Ruft die Eigenschaften der bereitgestellten VM-Konsole ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
consoleName
path True

string

Der Name der VM-Konsole.

RegEx-Muster: ^default$

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

virtualMachineName
path True

string

Der Name des virtuellen Computers.

RegEx-Muster: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

Console

OK

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Get virtual machine console

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Console

Konsole stellt die Konsole eines lokalen virtuellen Netzwerkcloudcomputers dar.

ConsoleDetailedStatus

Die ausführlichere status der Konsole.

ConsoleEnabled

Der Indikator, ob der Konsolenzugriff aktiviert ist.

ConsoleProvisioningState

Der Bereitstellungsstatus der VM-Konsole.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

ExtendedLocation

ExtendedLocation stellt den benutzerdefinierten Azure-Speicherort dar, an dem die Ressource erstellt wird.

SshPublicKey

SshPublicKey stellt den öffentlichen Schlüssel dar, der für die Authentifizierung bei einer Ressource über SSH verwendet wird.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Console

Konsole stellt die Konsole eines lokalen virtuellen Netzwerkcloudcomputers dar.

Name Typ Beschreibung
extendedLocation

ExtendedLocation

ExtendedLocation stellt den benutzerdefinierten Azure-Speicherort dar, an dem die Ressource erstellt wird.
Der erweiterte Speicherort des Cluster-Managers, der dem Cluster zugeordnet ist, auf dem dieser virtuelle Computer erstellt wird.

id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.detailedStatus

ConsoleDetailedStatus

Die ausführlichere status der Konsole.

properties.detailedStatusMessage

string

Die beschreibende Meldung zum aktuellen detaillierten status.

properties.enabled

ConsoleEnabled

Der Indikator, ob der Konsolenzugriff aktiviert ist.

properties.expiration

string

Das Datum und die Uhrzeit, nach denen der Zugriff auf den Schlüssel nicht mehr zulässig ist.

properties.privateLinkServiceId

string

Die Ressourcen-ID des Private Link-Diensts, der zum Bereitstellen des Zugriffs auf die VM-Konsole verwendet wird.

properties.provisioningState

ConsoleProvisioningState

Der Bereitstellungsstatus der VM-Konsole.

properties.sshPublicKey

SshPublicKey

SshPublicKey stellt den öffentlichen Schlüssel dar, der für die Authentifizierung bei einer Ressource über SSH verwendet wird.
Der öffentliche SSH-Schlüssel, der für den Benutzerzugriff bereitgestellt wird. Es wird erwartet, dass der Benutzer über den entsprechenden privaten SSH-Schlüssel für die Anmeldung verfügt.

properties.virtualMachineAccessId

string

Der eindeutige Bezeichner für den virtuellen Computer, der für den Zugriff auf die Konsole verwendet wird.

systemData

systemData

Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.

tags

object

Ressourcentags.

type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

Die ausführlichere status der Konsole.

Name Typ Beschreibung
Error

string

Ready

string

ConsoleEnabled

Der Indikator, ob der Konsolenzugriff aktiviert ist.

Name Typ Beschreibung
False

string

True

string

ConsoleProvisioningState

Der Bereitstellungsstatus der VM-Konsole.

Name Typ Beschreibung
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

ExtendedLocation

ExtendedLocation stellt den benutzerdefinierten Azure-Speicherort dar, an dem die Ressource erstellt wird.

Name Typ Beschreibung
name

string

Die Ressourcen-ID des erweiterten Speicherorts, an dem die Ressource erstellt wird.

type

string

Der erweiterte Standorttyp, z. B. CustomLocation.

SshPublicKey

SshPublicKey stellt den öffentlichen Schlüssel dar, der für die Authentifizierung bei einer Ressource über SSH verwendet wird.

Name Typ Beschreibung
keyData

string

Die Daten des öffentlichen SSH-Schlüssels.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.