Compute Node - Get Remote Desktop

Service:

Batch Service

API Version:

2023-11-01.18.0

Lekéri a megadott számítási csomópont távoli asztali protokollfájlt.
Ahhoz, hogy az RDP-fájl használatával elérhessen egy számítási csomópontot, létre kell hoznia egy felhasználói fiókot a számítási csomóponton. Ez az API csak felhőszolgáltatás-konfigurációval létrehozott készleteken hívható meg. A virtuálisgép-konfigurációval létrehozott készletekről lásd a GetRemoteLoginSettings API-t.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
nodeId	path	True	string	Annak a számítási csomópontnak az azonosítója, amelyhez le szeretné szerezni a távoli asztali protokollfájlt.
poolId	path	True	string	A számítási csomópontot tartalmazó készlet azonosítója.
api-version	query	True	string	Ügyfél API-verziója.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Válaszok

Name	Típus	Description
200 OK	object	Az RDP-adatokat tartalmazó válasz. Media Types: "application/json", "application/octet-stream" Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája. Media Types: "application/json", "application/octet-stream"

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

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"

Definíciók

Name	Description
BatchError	A Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail	A Azure Batch hibaválaszban szereplő további információk egy eleme.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Az Érték tulajdonság jelentését meghatározó azonosító.
value	string	A hibaválaszban szereplő további információk.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.