Nodes - Get Node Remote Login Settings

サービス:

Batch Service

API バージョン:

2025-06-01

リモートでCompute Nodeにログインするために必要な設定を取得します。
リモートログイン設定を使ってCompute Nodeにリモートログインする前に、Compute Nodeでユーザーアカウントを作成し、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 パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
nodeId	path	True	string	リモートログイン設定を取得するためのコンピュートノードのID。
poolId	path	True	string	コンピューティング ノードを含むプールの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
timeOut	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

名前	必須	型	説明
client-request-id		string	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id		boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date		string (date-time-rfc7231)	要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	BatchNodeRemoteLoginSettings	要求は成功しました。 ヘッダー ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
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
}

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラー メッセージ。
BatchNodeRemoteLoginSettings	コンピューティング ノードのリモート ログイン設定。

BatchError

Object

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message	BatchErrorMessage	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Object

Azure Batch エラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

BatchErrorMessage

Object

Azure Batch エラー応答で受信したエラー メッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード。
value	string	メッセージのテキスト。

BatchNodeRemoteLoginSettings

Object

コンピューティング ノードのリモート ログイン設定。

名前	型	説明
ipv6RemoteLoginIPAddress	string	コンピュートノードへのリモートログインに使用されるIPv6アドレス。
ipv6RemoteLoginPort	integer (int32)	コンピューティング ノードへのリモート ログインに使用されるポート。
remoteLoginIPAddress	string	コンピューティング ノードへのリモート ログインに使用される IP アドレス。
remoteLoginPort	integer (int32)	コンピューティング ノードへのリモート ログインに使用されるポート。