Compute Node - Get Remote Desktop
Возвращает файл протокола удаленного рабочего стола для указанного вычислительного узла.
Прежде чем получить доступ к вычислительному узлу с помощью RDP-файла, необходимо создать учетную запись пользователя на вычислительном узле. Этот API можно вызывать только в пулах, созданных с конфигурацией облачной службы. Сведения о пулах, созданных с конфигурацией виртуальной машины, см. в разделе API GetRemoteLoginSettings.
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/rdp?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/rdp?timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure. |
node
|
path | True |
string |
Идентификатор вычислительного узла, для которого требуется получить файл протокола удаленного рабочего стола. |
pool
|
path | True |
string |
Идентификатор пула, содержащего вычислительный узел. |
api-version
|
query | True |
string |
Версия API клиента. |
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд. |
Заголовок запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
client-request-id |
string uuid |
Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Указывает, должен ли сервер возвращать client-request-id в ответе. |
|
ocp-date |
string date-time-rfc1123 |
Время отправки запроса. Клиентские библиотеки обычно устанавливают текущее системное время; Задайте его явным образом, если вы вызываете REST API напрямую. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
object |
Ответ, содержащий сведения о протоколе RDP. Media Types: "application/json", "application/octet-stream" Headers
|
Other Status Codes |
Ошибка пакетной службы. Media Types: "application/json", "application/octet-stream" |
Безопасность
azure_auth
Microsoft Entra поток кода проверки подлинности OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | Олицетворение учетной записи пользователя |
Authorization
Type:
apiKey
In:
header
Примеры
Get RDP file of the compute node
Sample Request
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/rdp?api-version=2023-11-01.18.0
Sample Response
"This is actually a byte stream. This request/response is being presented as a string for readability in the example"
Определения
Имя | Описание |
---|---|
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure. |
Error |
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure. |
BatchError
Ответ об ошибке, полученный от службы пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
message |
Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ об ошибке. |
ErrorMessage
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Код языка сообщения об ошибке |
value |
string |
Текст сообщения. |