Compute Node - Get Remote Desktop
Obtém o ficheiro de Protocolo de Ambiente de Trabalho Remoto para o Nó de Computação especificado.
Antes de poder aceder a um Nó de Computação com o ficheiro RDP, tem de criar uma Conta de utilizador no Nó de Computação. Esta API só pode ser invocada em Conjuntos criados com uma configuração de serviço cloud. Para Conjuntos criados com uma configuração de máquina virtual, veja a 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
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
O URL base para todos os pedidos de serviço Azure Batch. |
node
|
path | True |
string |
O ID do Nó de Computação para o qual pretende obter o ficheiro do Protocolo de Ambiente de Trabalho Remoto. |
pool
|
path | True |
string |
O ID do Conjunto que contém o Nó de Computação. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos. |
Cabeçalho do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve devolver o client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
object |
Uma resposta que contém as informações de RDP. Media Types: "application/json", "application/octet-stream" Headers
|
Other Status Codes |
O erro do serviço Batch. Media Types: "application/json", "application/octet-stream" |
Segurança
azure_auth
Microsoft Entra fluxo de código de autenticação OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Representar a sua conta de utilizador |
Authorization
Type:
apiKey
In:
header
Exemplos
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"
Definições
Name | Description |
---|---|
Batch |
Uma resposta de erro recebida do serviço Azure Batch. |
Batch |
Um item de informações adicionais incluídas numa resposta de erro Azure Batch. |
Error |
Uma mensagem de erro recebida numa resposta de erro Azure Batch. |
BatchError
Uma resposta de erro recebida do serviço Azure Batch.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
message |
Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador. |
|
values |
Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Valor. |
value |
string |
As informações adicionais incluídas na resposta do erro. |
ErrorMessage
Uma mensagem de erro recebida numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |