Compute Node - Get Remote Desktop

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtient le fichier de protocole Bureau à distance pour le nœud de calcul spécifié.
Avant de pouvoir accéder à un nœud de calcul à l’aide du fichier RDP, vous devez créer un compte d’utilisateur sur le nœud de calcul. Cette API ne peut être appelée que sur les pools créés avec une configuration de service cloud. Pour les pools créés avec une configuration de machine virtuelle, consultez l’API GetRemoteLoginSettings.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/rdp?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/rdp?timeout={timeout}&api-version=2023-11-01.18.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
nodeId	path	True	string	ID du nœud de calcul pour lequel vous souhaitez obtenir le fichier de protocole Bureau à distance.
poolId	path	True	string	ID du pool qui contient le nœud de calcul.
api-version	query	True	string	Version de l’API cliente.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom	Obligatoire	Type	Description
client-request-id		string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date		string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.

Réponses

Nom	Type	Description
200 OK	object	Réponse contenant les informations RDP. Media Types: "application/json", "application/octet-stream" Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch. Media Types: "application/json", "application/octet-stream"

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

Exemples

Get RDP file of the compute node

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/rdp?api-version=2023-11-01.18.0

Sample Response

Status code:

200

"This is actually a byte stream. This request/response is being presented as a string for readability in the example"

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.