Compute Node - Get Remote Desktop

Service:

Batch Service

API Version:

2023-11-01.18.0

Belirtilen İşlem Düğümü için Uzak Masaüstü Protokolü dosyasını alır.
RDP dosyasını kullanarak bir İşlem Düğümüne erişebilmeniz için önce İşlem Düğümünde bir kullanıcı Hesabı oluşturmanız gerekir. Bu API yalnızca bulut hizmeti yapılandırmasıyla oluşturulan havuzlarda çağrılabilir. Sanal makine yapılandırmasıyla oluşturulan Havuzlar için bkz. GetRemoteLoginSettings API'sine bakın.

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
batchUrl	path	True	string	Tüm Azure Batch hizmet isteklerinin temel URL'si.
nodeId	path	True	string	Uzak Masaüstü Protokolü dosyasını almak istediğiniz İşlem Düğümünün kimliği.
poolId	path	True	string	İşlem Düğümünü içeren Havuzun Kimliği.
api-version	query	True	string	İstemci API Sürümü.
timeout	query		integer int32	Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye olarak). Varsayılan değer 30 saniyedir.

İstek Başlığı

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

Name	Gerekli	Tür	Description
client-request-id		string uuid	Çağıran tarafından oluşturulan istek kimliği, küme ayraçları gibi dekorasyonu olmayan bir GUID biçimindedir; örneğin 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Sunucunun yanıtta client-request-id döndürip döndürmeyeceği.
ocp-date		string date-time-rfc1123	İsteğin verildiği saat. İstemci kitaplıkları bunu genellikle geçerli sistem saat saatine ayarlar; REST API'yi doğrudan çağırıyorsanız açıkça ayarlayın.

Yanıtlar

Name	Tür	Description
200 OK	object	RDP bilgilerini içeren bir yanıt. Media Types: "application/json", "application/octet-stream" Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch hizmetinden gelen hata. Media Types: "application/json", "application/octet-stream"

Güvenlik

azure_auth

OAuth 2.0 kimlik doğrulama kodu akışını Microsoft Entra

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

Scopes

Name	Description
user_impersonation	Kullanıcı hesabınızın kimliğine bürünme

Authorization

Type: apiKey
In: header

Örnekler

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"

Tanımlar

Name	Description
BatchError	Azure Batch hizmetinden alınan bir hata yanıtı.
BatchErrorDetail	Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.
ErrorMessage	Azure Batch hata yanıtında bir hata iletisi alındı.

BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
message	ErrorMessage	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
values	BatchErrorDetail[]	Hatayla ilgili ek ayrıntıları içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.

Name	Tür	Description
key	string	Value özelliğinin anlamını belirten tanımlayıcı.
value	string	Hata yanıtına eklenen ek bilgiler.

ErrorMessage

Azure Batch hata yanıtında bir hata iletisi alındı.

Name	Tür	Description
lang	string	Hata iletisinin dil kodu
value	string	İletinin metni.