Compartir a través de


Consoles - Get

Recupere la consola de la máquina virtual.
Obtiene las propiedades de la consola de máquina virtual proporcionada.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
consoleName
path True

string

Nombre de la consola de la máquina virtual.

Patrón de Regex: ^default$

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

uuid

Identificador de la suscripción de destino. El valor debe ser un UUID.

virtualMachineName
path True

string

El nombre de la máquina virtual.

Patrón de Regex: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

Console

Aceptar

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Get virtual machine console

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
Console

La consola representa la consola de una máquina virtual en la nube de red local.

ConsoleDetailedStatus

Estado más detallado de la consola.

ConsoleEnabled

Indicador de si el acceso a la consola está habilitado.

ConsoleProvisioningState

Estado de aprovisionamiento de la consola de máquina virtual.

createdByType

Tipo de identidad que creó el recurso.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

ExtendedLocation

ExtendedLocation representa la ubicación personalizada de Azure donde se creará el recurso.

SshPublicKey

SshPublicKey representa la clave pública que se usa para autenticarse con un recurso a través de SSH.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Console

La consola representa la consola de una máquina virtual en la nube de red local.

Nombre Tipo Description
extendedLocation

ExtendedLocation

ExtendedLocation representa la ubicación personalizada de Azure donde se creará el recurso.
La ubicación extendida del administrador de clústeres asociado al clúster en el que se crea esta máquina virtual.

id

string

Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso.

properties.detailedStatus

ConsoleDetailedStatus

Estado más detallado de la consola.

properties.detailedStatusMessage

string

Mensaje descriptivo sobre el estado detallado actual.

properties.enabled

ConsoleEnabled

Indicador de si el acceso a la consola está habilitado.

properties.expiration

string

Fecha y hora después de la cual no se permitirá el acceso a la clave.

properties.privateLinkServiceId

string

Identificador de recurso del servicio private link que se usa para proporcionar acceso a la consola de la máquina virtual.

properties.provisioningState

ConsoleProvisioningState

Estado de aprovisionamiento de la consola de máquina virtual.

properties.sshPublicKey

SshPublicKey

SshPublicKey representa la clave pública que se usa para autenticarse con un recurso a través de SSH.
Clave pública SSH que se aprovisionará para el acceso de usuario. Se espera que el usuario tenga la clave privada SSH correspondiente para iniciar sesión.

properties.virtualMachineAccessId

string

Identificador único de la máquina virtual que se usa para acceder a la consola.

systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

Estado más detallado de la consola.

Nombre Tipo Description
Error

string

Ready

string

ConsoleEnabled

Indicador de si el acceso a la consola está habilitado.

Nombre Tipo Description
False

string

True

string

ConsoleProvisioningState

Estado de aprovisionamiento de la consola de máquina virtual.

Nombre Tipo Description
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ExtendedLocation

ExtendedLocation representa la ubicación personalizada de Azure donde se creará el recurso.

Nombre Tipo Description
name

string

Identificador de recurso de la ubicación extendida en la que se creará el recurso.

type

string

El tipo de ubicación extendida, por ejemplo, CustomLocation.

SshPublicKey

SshPublicKey representa la clave pública que se usa para autenticarse con un recurso a través de SSH.

Nombre Tipo Description
keyData

string

Datos de clave pública SSH.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.