Pool - Update Properties
指定したプールのプロパティを更新します。
これにより、プールのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
batch
|
path | True |
string |
すべての Azure Batch サービス要求のベース URL。 |
pool
|
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 を直接呼び出す場合は、明示的に設定します。 |
要求本文
Media Types: "application/json; odata=minimalmetadata"
名前 | 必須 | 型 | 説明 |
---|---|---|---|
applicationPackageReferences | True |
プール内の各コンピューティング ノードにインストールするアプリケーション パッケージの一覧。 |
|
certificateReferences | True |
プール内の各コンピューティング ノードにインストールする証明書の一覧。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。 |
|
metadata | True |
メタデータとしてプールに関連付けられている名前と値のペアの一覧。 |
|
startTask |
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 |
||
targetNodeCommunicationMode |
プールの目的のノード通信モード。 |
応答
名前 | 型 | 説明 |
---|---|---|
204 No Content |
Batch サービスへの要求が成功しました。 ヘッダー
|
|
Other Status Codes |
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
例
Pool update
要求のサンプル
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
応答のサンプル
定義
名前 | 説明 |
---|---|
Application |
コンピューティング ノードにデプロイするパッケージへの参照。 |
Auto |
自動ユーザーのスコープ |
Auto |
Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。 |
Batch |
Azure Batch サービスから受信したエラー応答。 |
Batch |
Azure Batch エラー応答に含まれる追加情報の項目。 |
Certificate |
プール内のコンピューティング ノードにインストールされる証明書への参照。 |
Certificate |
証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 |
Certificate |
証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 |
Compute |
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 |
Container |
タスク コンテナーにマウントするパスとマウント モードのエントリ。 |
Container |
コンテナー タスクのコンテナーにマウントされるパス。 |
Container |
プライベート コンテナー レジストリ。 |
Container |
コンテナータスク作業ディレクトリの場所。 |
Elevation |
ユーザーの昇格レベル。 |
Environment |
タスク プロセスで設定する環境変数。 |
Error |
Azure Batch エラー応答で受信したエラー メッセージ。 |
Metadata |
Batch サービス リソースに関連付けられている名前と値のペア。 |
Node |
プールが Batch サービスと通信する方法を決定します。 |
Pool |
プールに対して行う一連の変更。 |
Resource |
コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。 |
Start |
ノードが Azure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。 |
Task |
タスクのコンテナー設定。 |
User |
タスクを実行するユーザー ID の定義。 |
ApplicationPackageReference
コンピューティング ノードにデプロイするパッケージへの参照。
名前 | 型 | 説明 |
---|---|---|
applicationId |
string |
デプロイするアプリケーションの ID。 |
version |
string |
デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。 |
AutoUserScope
自動ユーザーのスコープ
名前 | 型 | 説明 |
---|---|---|
pool |
string |
タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。 |
task |
string |
サービスがタスクの新しいユーザーを作成することを指定します。 |
AutoUserSpecification
Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。
名前 | 型 | 説明 |
---|---|---|
elevationLevel |
自動ユーザーの昇格レベル。 |
|
scope |
自動ユーザーのスコープ |
BatchError
Azure Batch サービスから受信したエラー応答。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batch エラー応答に含まれる追加情報の項目。
名前 | 型 | 説明 |
---|---|---|
key |
string |
Value プロパティの意味を指定する識別子。 |
value |
string |
エラー応答に含まれる追加情報。 |
CertificateReference
プール内のコンピューティング ノードにインストールされる証明書への参照。
名前 | 型 | 説明 |
---|---|---|
storeLocation |
証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 |
|
storeName |
string |
証明書をインストールするコンピューティング ノード上の証明書ストアの名前。 |
thumbprint |
string |
証明書の拇印。 |
thumbprintAlgorithm |
string |
拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。 |
visibility |
証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 |
CertificateStoreLocation
証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
名前 | 型 | 説明 |
---|---|---|
currentuser |
string |
証明書は CurrentUser 証明書ストアにインストールする必要があります。 |
localmachine |
string |
証明書は LocalMachine 証明書ストアにインストールする必要があります。 |
CertificateVisibility
証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。
名前 | 型 | 説明 |
---|---|---|
remoteuser |
string |
証明書は、ユーザーがコンピューティング ノードにリモートでアクセスするユーザー アカウントに表示される必要があります。 |
starttask |
string |
証明書は、StartTask が実行されているユーザー アカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。 |
task |
string |
証明書は、ジョブ タスクが実行されているユーザー アカウントに表示されます。 |
ComputeNodeIdentityReference
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
ユーザー割り当て ID の ARM リソース ID。 |
ContainerHostBatchBindMountEntry
タスク コンテナーにマウントするパスとマウント モードのエントリ。
名前 | 型 | 説明 |
---|---|---|
isReadOnly |
boolean |
このソース パスを読み取り専用モードとしてマウントするかどうか。 既定値は false (読み取り/書き込みモード) です。 |
source |
コンテナー顧客にマウントするパスを選択できます。 |
ContainerHostDataPath
コンテナー タスクのコンテナーにマウントされるパス。
名前 | 型 | 説明 |
---|---|---|
Applications |
string |
アプリケーション パス。 |
JobPrep |
string |
ジョブ準備タスクのパス。 |
Shared |
string |
複数インスタンス のタスクがファイルを共有するためのパス。 |
Startup |
string |
開始タスクのパス。 |
Task |
string |
タスク パス。 |
VfsMounts |
string |
パスには、このノードにマウントされているすべての仮想ファイル システムが含まれています。 |
ContainerRegistry
プライベート コンテナー レジストリ。
名前 | 型 | 説明 |
---|---|---|
identityReference |
ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。 |
|
password |
string |
レジストリ サーバーにログインするためのパスワード。 |
registryServer |
string |
レジストリ URL。 |
username |
string |
レジストリ サーバーにログインするユーザー名。 |
ContainerWorkingDirectory
コンテナータスク作業ディレクトリの場所。
名前 | 型 | 説明 |
---|---|---|
containerImageDefault |
string |
コンテナー イメージで定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。 |
taskWorkingDirectory |
string |
Batch によって設定されたタスク リソース ファイルが含まれる標準の Batch サービスタスク作業ディレクトリを使用します。 |
ElevationLevel
ユーザーの昇格レベル。
名前 | 型 | 説明 |
---|---|---|
admin |
string |
ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者権限で動作します。 |
nonadmin |
string |
ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。 |
EnvironmentSetting
タスク プロセスで設定する環境変数。
名前 | 型 | 説明 |
---|---|---|
name |
string |
環境変数の名前。 |
value |
string |
環境変数の値。 |
ErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
名前 | 型 | 説明 |
---|---|---|
lang |
string |
エラー メッセージの言語コード |
value |
string |
メッセージのテキスト。 |
MetadataItem
Batch サービス リソースに関連付けられている名前と値のペア。
名前 | 型 | 説明 |
---|---|---|
name |
string |
メタデータ項目の名前。 |
value |
string |
メタデータ項目の値。 |
NodeCommunicationMode
プールが Batch サービスと通信する方法を決定します。
名前 | 型 | 説明 |
---|---|---|
classic |
string |
クラシック通信モードを使用するノードでは、"BatchNodeManagement" からのポート 29876 と 29877 の受信 TCP 通信が必要です。{region}" サービス タグとポート 443 の "Storage.region" および "BatchNodeManagement" への送信 TCP 通信。{region}" サービス タグ。 |
default |
string |
ノード通信モードは、Batch サービスによって自動的に設定されます。 |
simplified |
string |
簡略化された通信モードを使用するノードでは、ポート 443 で "BatchNodeManagement" への送信 TCP 通信が必要です。{region}" サービス タグ。 開いている受信ポートは必要ありません。 |
PoolUpdatePropertiesParameter
プールに対して行う一連の変更。
名前 | 型 | 説明 |
---|---|---|
applicationPackageReferences |
プール内の各コンピューティング ノードにインストールするアプリケーション パッケージの一覧。 |
|
certificateReferences |
プール内の各コンピューティング ノードにインストールする証明書の一覧。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。 |
|
metadata |
メタデータとしてプールに関連付けられている名前と値のペアの一覧。 |
|
startTask |
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 |
|
targetNodeCommunicationMode |
プールの目的のノード通信モード。 |
ResourceFile
コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。
名前 | 型 | 説明 |
---|---|---|
autoStorageContainerName |
string |
自動ストレージ アカウントのストレージ コンテナー名。 |
blobPrefix |
string |
Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。 指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。 |
fileMode |
string |
ファイルアクセス許可モード属性 (8 進数形式)。 |
filePath |
string |
タスクの作業ディレクトリを基準にして、ファイルをダウンロードするコンピューティング ノード上の場所。 |
httpUrl |
string |
ダウンロードするファイルの URL。 |
identityReference |
storageContainerUrl または httpUrl で指定された Azure Blob Storage へのアクセスに使用するユーザー割り当て ID への参照 |
|
storageContainerUrl |
string |
Azure Blob Storage 内の BLOB コンテナーの URL。 |
StartTask
ノードが Azure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。
名前 | 型 | 説明 |
---|---|---|
commandLine |
string |
StartTask のコマンド ライン。 |
containerSettings |
StartTask を実行するコンテナーの設定。 |
|
environmentSettings |
StartTask の環境変数設定の一覧。 |
|
maxTaskRetryCount |
integer |
タスクを再試行できる最大回数。 |
resourceFiles |
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 |
|
userIdentity |
StartTask を実行するユーザー ID。 |
|
waitForSuccess |
boolean |
コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 |
TaskContainerSettings
タスクのコンテナー設定。
名前 | 型 | 説明 |
---|---|---|
containerHostBatchBindMounts |
コンテナー タスクにマウントするパス。 |
|
containerRunOptions |
string |
コンテナー作成コマンドの追加オプション。 |
imageName |
string |
タスクを実行するコンテナーの作成に使用するイメージ。 |
registry |
コンテナー イメージを含むプライベート レジストリ。 |
|
workingDirectory |
コンテナータスク作業ディレクトリの場所。 |
UserIdentity
タスクを実行するユーザー ID の定義。
名前 | 型 | 説明 |
---|---|---|
autoUser |
タスクを実行する自動ユーザー。 |
|
username |
string |
タスクを実行するユーザー ID の名前。 |