Поделиться через


Consoles - Get

Получите консоль виртуальной машины.
Получение свойств предоставленной консоли виртуальной машины.

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

Параметры URI

Имя В Обязательно Тип Описание
consoleName
path True

string

Имя консоли виртуальной машины.

Шаблон регулярного выражения: ^default$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.

virtualMachineName
path True

string

Имя виртуальной машины.

Шаблон регулярного выражения: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

Console

ОК

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Get virtual machine console

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
Console

Консоль представляет консоль локальной сетевой облачной виртуальной машины.

ConsoleDetailedStatus

Более подробное состояние консоли.

ConsoleEnabled

Индикатор того, включен ли доступ к консоли.

ConsoleProvisioningState

Состояние подготовки консоли виртуальной машины.

createdByType

Тип удостоверения, создавшего ресурс.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

ExtendedLocation

ExtendedLocation представляет пользовательское расположение Azure, в котором будет создан ресурс.

SshPublicKey

SshPublicKey представляет открытый ключ, используемый для проверки подлинности в ресурсе по протоколу SSH.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Console

Консоль представляет консоль локальной сетевой облачной виртуальной машины.

Имя Тип Описание
extendedLocation

ExtendedLocation

ExtendedLocation представляет пользовательское расположение Azure, в котором будет создан ресурс.
Расширенное расположение диспетчера кластеров, связанного с кластером, в котором создается эта виртуальная машина.

id

string

Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.detailedStatus

ConsoleDetailedStatus

Более подробное состояние консоли.

properties.detailedStatusMessage

string

Описательное сообщение о текущем подробном состоянии.

properties.enabled

ConsoleEnabled

Индикатор того, включен ли доступ к консоли.

properties.expiration

string

Дата и время, по истечении которых доступ к ключу будет запрещен.

properties.privateLinkServiceId

string

Идентификатор ресурса службы приватного канала, который используется для предоставления доступа к консоли виртуальной машины.

properties.provisioningState

ConsoleProvisioningState

Состояние подготовки консоли виртуальной машины.

properties.sshPublicKey

SshPublicKey

SshPublicKey представляет открытый ключ, используемый для проверки подлинности в ресурсе по протоколу SSH.
Открытый ключ SSH, который будет подготовлен для доступа пользователей. Ожидается, что у пользователя будет соответствующий закрытый ключ SSH для входа.

properties.virtualMachineAccessId

string

Уникальный идентификатор виртуальной машины, используемой для доступа к консоли.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

Более подробное состояние консоли.

Имя Тип Описание
Error

string

Ready

string

ConsoleEnabled

Индикатор того, включен ли доступ к консоли.

Имя Тип Описание
False

string

True

string

ConsoleProvisioningState

Состояние подготовки консоли виртуальной машины.

Имя Тип Описание
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ExtendedLocation

ExtendedLocation представляет пользовательское расположение Azure, в котором будет создан ресурс.

Имя Тип Описание
name

string

Идентификатор расширенного расположения, в котором будет создан ресурс.

type

string

Расширенный тип расположения, например CustomLocation.

SshPublicKey

SshPublicKey представляет открытый ключ, используемый для проверки подлинности в ресурсе по протоколу SSH.

Имя Тип Описание
keyData

string

Данные открытого ключа SSH.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.