Condividi tramite


Consoles - Get

Recuperare la console della macchina virtuale.
Ottiene le proprietà della console macchina virtuale fornita.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
consoleName
path True

string

Nome della console della macchina virtuale.

Criterio di espressione regolare: ^default$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

uuid

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.

virtualMachineName
path True

string

Nome della macchina virtuale.

Criterio di espressione regolare: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

Console

OK

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get virtual machine console

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Console

La console rappresenta la console di una macchina virtuale cloud di rete locale.

ConsoleDetailedStatus

Stato più dettagliato della console.

ConsoleEnabled

Indicatore che indica se l'accesso alla console è abilitato.

ConsoleProvisioningState

Stato di provisioning della console della macchina virtuale.

createdByType

Tipo di identità che ha creato la risorsa.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

ExtendedLocation

ExtendedLocation rappresenta la posizione personalizzata di Azure in cui verrà creata la risorsa.

SshPublicKey

SshPublicKey rappresenta la chiave pubblica usata per l'autenticazione con una risorsa tramite SSH.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Console

La console rappresenta la console di una macchina virtuale cloud di rete locale.

Nome Tipo Descrizione
extendedLocation

ExtendedLocation

ExtendedLocation rappresenta la posizione personalizzata di Azure in cui verrà creata la risorsa.
Il percorso esteso della gestione cluster associato al cluster in cui viene creata la macchina virtuale.

id

string

ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Posizione geografica in cui risiede la risorsa

name

string

nome della risorsa.

properties.detailedStatus

ConsoleDetailedStatus

Stato più dettagliato della console.

properties.detailedStatusMessage

string

Messaggio descrittivo sullo stato dettagliato corrente.

properties.enabled

ConsoleEnabled

Indicatore che indica se l'accesso alla console è abilitato.

properties.expiration

string

Data e ora dopo la quale la chiave non sarà consentita.

properties.privateLinkServiceId

string

ID risorsa del servizio collegamento privato usato per fornire l'accesso alla console della macchina virtuale.

properties.provisioningState

ConsoleProvisioningState

Stato di provisioning della console della macchina virtuale.

properties.sshPublicKey

SshPublicKey

SshPublicKey rappresenta la chiave pubblica usata per l'autenticazione con una risorsa tramite SSH.
Chiave pubblica SSH di cui verrà effettuato il provisioning per l'accesso utente. L'utente deve avere la chiave privata SSH corrispondente per l'accesso.

properties.virtualMachineAccessId

string

Identificatore univoco per la macchina virtuale usata per accedere alla console.

systemData

systemData

Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.

tags

object

Tag delle risorse.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

Stato più dettagliato della console.

Nome Tipo Descrizione
Error

string

Ready

string

ConsoleEnabled

Indicatore che indica se l'accesso alla console è abilitato.

Nome Tipo Descrizione
False

string

True

string

ConsoleProvisioningState

Stato di provisioning della console della macchina virtuale.

Nome Tipo Descrizione
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ExtendedLocation

ExtendedLocation rappresenta la posizione personalizzata di Azure in cui verrà creata la risorsa.

Nome Tipo Descrizione
name

string

ID risorsa della posizione estesa in cui verrà creata la risorsa.

type

string

Tipo di posizione estesa, ad esempio CustomLocation.

SshPublicKey

SshPublicKey rappresenta la chiave pubblica usata per l'autenticazione con una risorsa tramite SSH.

Nome Tipo Descrizione
keyData

string

Dati della chiave pubblica SSH.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.