Nodes - Get Node Remote Login Settings

服務:

Batch Service

API 版本:

2025-06-01

取得遠端登入計算節點所需的設定。
在你能用遠端登入設定遠端登入運算節點之前，必須在運算節點建立使用者帳號，並設定 SSH 和 RDP 的存取埠。 如需詳細資訊，請參閱 https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2025-06-01

含選擇性參數:

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2025-06-01&timeOut={timeOut}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	Batch 帳戶端點 （例如：https://batchaccount.eastus2.batch.azure.com）。
nodeId	path	True	string	計算節點的 ID，用於取得遠端登入設定。
poolId	path	True	string	包含計算節點的集區識別碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
timeOut	query		integer (int32)	伺服器可以花費數秒處理要求的時間上限。 預設值為 30 秒。 若值大於30，則會使用預設值。」

要求標頭

名稱	必要	類型	Description
client-request-id		string	呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id		boolean	伺服器是否應該在回應中傳回 client-request-id。
ocp-date		string (date-time-rfc7231)	發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

回應

名稱	類型	Description
200 OK	BatchNodeRemoteLoginSettings	要求已成功。 標題 ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱	Description
https://batch.core.windows.net//.default

範例

Get batch node Dual Stack Networking Remote

Node get remote login settings

Get batch node Dual Stack Networking Remote

範例要求

HTTP

GET {endpoint}/pools/dualstackpool/nodes/tvmps_5d8adec89961dcc011329b38df999a841f6cc815a5710678b741f04b33556ed2_d/remoteloginsettings?api-version=2025-06-01

範例回覆

狀態碼:

200

{
  "remoteLoginIPAddress": "１.1.1.1",
  "remoteLoginPort": 40000,
  "ipv6RemoteLoginIPAddress": "fd00::1",
  "ipv6RemoteLoginPort": 40000
}

Node get remote login settings

範例要求

HTTP

GET {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2025-06-01

範例回覆

狀態碼:

200

{
  "remoteLoginIPAddress": "1.1.1.1",
  "remoteLoginPort": 50000
}

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
BatchNodeRemoteLoginSettings	計算節點的遠端登入設定。

BatchError

Object

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message	BatchErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Object

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

BatchErrorMessage

Object

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼。
value	string	訊息的文字。

BatchNodeRemoteLoginSettings

Object

計算節點的遠端登入設定。

名稱	類型	Description
ipv6RemoteLoginIPAddress	string	用於遠端登入運算節點的 IPv6 位址。
ipv6RemoteLoginPort	integer (int32)	用於遠端登入計算節點的埠。
remoteLoginIPAddress	string	用於遠端登入計算節點的IP位址。
remoteLoginPort	integer (int32)	用於遠端登入計算節點的埠。