次の方法で共有

Compute Node - Get Remote Login Settings

  • リファレンス
サービス:
Batch Service
API バージョン:
2024-07-01.20.0

コンピューティング ノードへのリモート ログインに必要な設定を取得します。
リモート ログイン設定を使用してコンピューティング ノードにリモートでログインするには、コンピューティング ノードにユーザー アカウントを作成する必要があります。

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?api-version=2024-07-01.20.0
省略可能なパラメーターを含む: 
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/remoteloginsettings?timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前 / 必須 型 説明
batchUrl
 path True

string

すべての Azure Batch サービス要求のベース URL。
nodeId
 path True

string

リモート ログイン設定を取得するコンピューティング ノードの ID。
poolId
 path True

string

コンピューティング ノードを含むプールの ID。
api-version
 query True

string

クライアント API のバージョン。
timeout
 query

integer

int32

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が 30 より大きい場合は、代わりに既定値が使用されます。

要求ヘッダー

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

名前 必須 型 説明
client-request-id

string

uuid

呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id

boolean

サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date

string

date-time-rfc1123

要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前 型 説明
200 OK

ComputeNodeGetRemoteLoginSettingsResult

ログイン設定を含む応答。

ヘッダー

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

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

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

Authorization

型: apiKey
/: header

例

Node get remote login settings

要求のサンプル

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/remoteloginsettings?api-version=2024-07-01.20.0

応答のサンプル

状態コード:
200 
{
  "remoteLoginIPAddress": "1.1.1.1",
  "remoteLoginPort": 50000
}

定義

名前 説明
BatchError

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

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

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

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

BatchError

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

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message

ErrorMessage

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values

BatchErrorDetail[]

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

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

名前 型 説明
key

string

Value プロパティの意味を指定する識別子。
value

string

エラー応答に含まれる追加情報。

ComputeNodeGetRemoteLoginSettingsResult

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

名前 型 説明
remoteLoginIPAddress

string

コンピューティング ノードへのリモート ログインに使用される IP アドレス。
remoteLoginPort

integer

コンピューティング ノードへのリモート ログインに使用されるポート。

ErrorMessage

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

名前 型 説明
lang

string

エラー メッセージの言語コード
value

string

メッセージのテキスト。