次の方法で共有

Compute Node - Update User

  • リファレンス
サービス:
Batch Service
API バージョン:
2023-11-01.18.0

指定したコンピューティング ノードのユーザー アカウントのパスワードと有効期限を更新します。
この操作により、Account のすべての更新可能なプロパティが置き換えられます。 たとえば、expiryTime 要素が指定されていない場合、現在の値は変更されずに既定値に置き換えられます。 コンピューティング ノードのユーザー アカウントは、アイドル状態または実行中の状態の場合にのみ更新できます。

PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?api-version=2023-11-01.18.0
省略可能なパラメーターを含む: 
PUT {batchUrl}/pools/{poolId}/nodes/{nodeId}/users/{userName}?timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前 / 必須 型 説明
batchUrl
 path True

string

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

string

ユーザー アカウントを更新するコンピューターの ID。
poolId
 path True

string

コンピューティング ノードを含むプールの ID。
userName
 path True

string

更新するユーザー アカウントの名前。
api-version
 query True

string

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

integer

int32

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 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 を直接呼び出す場合は、明示的に設定します。

要求本文

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

名前 型 説明
expiryTime

string

アカウントの有効期限が切れる時刻。
省略した場合、既定値は現在の時刻から 1 日です。 Linux コンピューティング ノードの場合、expiryTime の精度は最大 1 日です。
password

string

アカウントのパスワード。
パスワードは、Windows コンピューティング ノード ('cloudServiceConfiguration' で作成されたもの、または Windows イメージ参照を使用して 'virtualMachineConfiguration' で作成されたもの) に必要です。 Linux コンピューティング ノードの場合、必要に応じて sshPublicKey プロパティと共にパスワードを指定できます。 省略すると、既存のパスワードが削除されます。
sshPublicKey

string

コンピューティング ノードへのリモート ログインに使用できる SSH 公開キー。
公開キーは OpenSSH エンコードと互換性があり、Base 64 でエンコードする必要があります。 このプロパティは、Linux コンピューティング ノードに対してのみ指定できます。 これが Windows コンピューティング ノードに対して指定されている場合、Batch サービスは要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 省略すると、既存の SSH 公開キーが削除されます。

応答

名前 型 説明
200 OK

Batch サービスへの要求が成功しました。

ヘッダー

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: 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 update user

要求のサンプル

PUT account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users/userName?api-version=2023-11-01.18.0



{
  "password": "12345",
  "expiryTime": "2016-11-27T00:45:48.7320857Z"
}

応答のサンプル

状態コード:
200

定義

名前 説明
BatchError

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

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

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

コンピューティング ノード上のユーザー アカウントに対して行われる一連の変更。

BatchError

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

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message

ErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

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

名前 型 説明
key

string

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

string

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

ErrorMessage

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

名前 型 説明
lang

string

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

string

メッセージのテキストです。

NodeUpdateUserParameter

コンピューティング ノード上のユーザー アカウントに対して行われる一連の変更。

名前 型 説明
expiryTime

string

アカウントの有効期限が切れる時刻。
省略した場合、既定値は現在の時刻から 1 日です。 Linux コンピューティング ノードの場合、expiryTime の精度は最大 1 日です。
password

string

アカウントのパスワード。
パスワードは、Windows コンピューティング ノード ('cloudServiceConfiguration' で作成されたもの、または Windows イメージ参照を使用して 'virtualMachineConfiguration' で作成されたもの) に必要です。 Linux コンピューティング ノードの場合、必要に応じて sshPublicKey プロパティと共にパスワードを指定できます。 省略すると、既存のパスワードが削除されます。
sshPublicKey

string

コンピューティング ノードへのリモート ログインに使用できる SSH 公開キー。
公開キーは OpenSSH エンコードと互換性があり、Base 64 でエンコードする必要があります。 このプロパティは、Linux コンピューティング ノードに対してのみ指定できます。 これが Windows コンピューティング ノードに対して指定されている場合、Batch サービスは要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 省略すると、既存の SSH 公開キーが削除されます。