Partager via


Consoles - Get

Récupérez la console de la machine virtuelle.
Obtient les propriétés de la console de machine virtuelle fournie.

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

Paramètres URI

Nom Dans Obligatoire Type Description
consoleName
path True

string

Nom de la console de machine virtuelle.

Modèle d’expression régulière: ^default$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.

virtualMachineName
path True

string

Nom de la machine virtuelle.

Modèle d’expression régulière: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

Console

Ok

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Get virtual machine console

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
Console

Console représente la console d’une machine virtuelle Network Cloud locale.

ConsoleDetailedStatus

Plus détaillée status de la console.

ConsoleEnabled

Indicateur indiquant si l’accès à la console est activé.

ConsoleProvisioningState

État d’approvisionnement de la console de machine virtuelle.

createdByType

Type d’identité qui a créé la ressource.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ExtendedLocation

ExtendedLocation représente l’emplacement personnalisé Azure où la ressource sera créée.

SshPublicKey

SshPublicKey représente la clé publique utilisée pour l’authentification auprès d’une ressource via SSH.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Console

Console représente la console d’une machine virtuelle Network Cloud locale.

Nom Type Description
extendedLocation

ExtendedLocation

ExtendedLocation représente l’emplacement personnalisé Azure où la ressource sera créée.
Emplacement étendu du gestionnaire de cluster associé au cluster sur lequel cette machine virtuelle est créée.

id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

location

string

Emplacement géographique où réside la ressource

name

string

nom de la ressource.

properties.detailedStatus

ConsoleDetailedStatus

Plus détaillée status de la console.

properties.detailedStatusMessage

string

Message descriptif sur le status détaillé actuel.

properties.enabled

ConsoleEnabled

Indicateur indiquant si l’accès à la console est activé.

properties.expiration

string

Date et heure après lesquelles l’accès à la clé sera interdit.

properties.privateLinkServiceId

string

ID de ressource du service de liaison privée utilisé pour fournir l’accès à la console de machine virtuelle.

properties.provisioningState

ConsoleProvisioningState

État d’approvisionnement de la console de machine virtuelle.

properties.sshPublicKey

SshPublicKey

SshPublicKey représente la clé publique utilisée pour l’authentification auprès d’une ressource via SSH.
Clé publique SSH qui sera provisionnée pour l’accès utilisateur. L’utilisateur doit disposer de la clé privée SSH correspondante pour la connexion.

properties.virtualMachineAccessId

string

Identificateur unique de la machine virtuelle utilisée pour accéder à la console.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ConsoleDetailedStatus

Plus détaillée status de la console.

Nom Type Description
Error

string

Ready

string

ConsoleEnabled

Indicateur indiquant si l’accès à la console est activé.

Nom Type Description
False

string

True

string

ConsoleProvisioningState

État d’approvisionnement de la console de machine virtuelle.

Nom Type Description
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

ExtendedLocation

ExtendedLocation représente l’emplacement personnalisé Azure où la ressource sera créée.

Nom Type Description
name

string

ID de ressource de l’emplacement étendu sur lequel la ressource sera créée.

type

string

Type d’emplacement étendu, par exemple CustomLocation.

SshPublicKey

SshPublicKey représente la clé publique utilisée pour l’authentification auprès d’une ressource via SSH.

Nom Type Description
keyData

string

Données de clé publique SSH.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.