Pool - Update Properties

リファレンス

サービス:: Batch Service

API バージョン:: 2023-11-01.18.0

指定した Pool のプロパティを更新します。
これにより、Pool のすべての更新可能なプロパティが完全に置き換えられます。たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0

省略可能なパラメーターを含む:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべてのAzure Batchサービス要求のベース URL。
poolId	path	True	string	更新するプールの ID。
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"

名前	必須	型	説明
applicationPackageReferences	True	ApplicationPackageReference[]	プール内の各コンピューティングノードにインストールするアプリケーションパッケージの一覧。この一覧は、プール上の既存のアプリケーションパッケージ参照を置き換えます。アプリケーションパッケージ参照への変更は、プールに参加しているすべての新しいコンピューティングノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティングノードには影響しません。任意のプールには、最大 10 個のアプリケーションパッケージ参照があります。省略した場合、または空のコレクションを指定した場合、既存のアプリケーションパッケージ参照はすべてプールから削除されます。特定のプールでは、最大 10 個の参照を指定できます。
certificateReferences	True	CertificateReference[]	プール内の各コンピューティングノードにインストールする証明書の一覧。この一覧は、プールで構成されている既存の証明書参照を置き換えます。空のコレクションを指定すると、既存の証明書参照はすべてプールから削除されます。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティングノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホームディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。代わりに Azure KeyVault 拡張機能を使用してください。
metadata	True	MetadataItem[]	プールにメタデータとして関連付けられている名前と値のペアの一覧。この一覧は、プールで構成されている既存のメタデータを置き換えます。省略した場合、または空のコレクションを指定した場合、既存のメタデータはすべて Pool から削除されます。
startTask		StartTask	プールに参加する各コンピューティングノードで実行するタスク。タスクは、コンピューティングノードがプールに追加されたとき、またはコンピューティングノードが再起動されたときに実行されます。この要素が存在する場合は、既存の StartTask が上書きされます。省略すると、既存の StartTask がプールから削除されます。
targetNodeCommunicationMode		NodeCommunicationMode	プールの目的のノード通信モード。この設定は、プールの既存の targetNodeCommunication 設定を置き換えます。省略した場合、既存の設定は既定です。

応答

名前	型	説明
204 No Content		Batch サービスへの要求が成功しました。ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

204 No Content

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

例

Pool update

要求のサンプル

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

応答のサンプル

状態コード:: 204

定義

名前	説明
ApplicationPackageReference	コンピューティングノードにデプロイするパッケージへの参照。
AutoUserScope	自動ユーザーのスコープ
AutoUserSpecification	Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
CertificateReference	プール内のコンピューティングノードにインストールされる証明書への参照。
CertificateStoreLocation	証明書をインストールするコンピューティングノード上の証明書ストアの場所。
CertificateVisibility	証明書のプライベートデータにアクセスできるコンピューティングノード上のユーザーアカウント。
ComputeNodeIdentityReference	コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
ContainerRegistry	プライベートコンテナーレジストリ。
ContainerWorkingDirectory	コンテナー Task 作業ディレクトリの場所。
ElevationLevel	ユーザーの昇格レベル。
EnvironmentSetting	タスクプロセスで設定する環境変数。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
MetadataItem	Batch サービスリソースに関連付けられている名前と値のペア。
NodeCommunicationMode	プールが Batch サービスと通信する方法を決定します。
PoolUpdatePropertiesParameter	プールに対して行われる一連の変更。
ResourceFile	コンピューティングノードにダウンロードする 1 つのファイルまたは複数のファイル。
StartTask	ノードがAzure Batch サービスのプールに参加するとき、またはコンピューティングノードが再起動または再イメージ化されたときに実行されるタスク。
TaskContainerSettings	タスクのコンテナー設定。
UserIdentity	タスクを実行するユーザー ID の定義。

ApplicationPackageReference

コンピューティングノードにデプロイするパッケージへの参照。

名前	型	説明
applicationId	string	デプロイするアプリケーションの ID。プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。
version	string	デプロイするアプリケーションのバージョン。省略すると、既定のバージョンがデプロイされます。プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラーコード InvalidApplicationPackageReferences と HTTP 状態コード 409 で失敗します。 Task でこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AutoUserScope

自動ユーザーのスコープ

名前	型	説明
pool	string	タスクが、プール内のすべてのコンピューティングノードで作成される共通の自動ユーザーアカウントとして実行されることを指定します。
task	string	サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

名前	型	説明
elevationLevel	ElevationLevel	自動ユーザーの昇格レベル。既定値は nonAdmin です。
scope	AutoUserScope	自動ユーザーのスコープ既定値は pool です。プールで Windows が実行されている場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが StartTasks からアクセスできる証明書がプールで指定されている場合などです。

BatchError

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

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

BatchErrorDetail

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

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

CertificateReference

プール内のコンピューティングノードにインストールされる証明書への参照。

名前	型	説明
storeLocation	CertificateStoreLocation	証明書をインストールするコンピューティングノード上の証明書ストアの場所。既定値は currentuser です。このプロパティは、Windows コンピューティングノード (cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用して virtualMachineConfiguration を使用して作成されたプール) にのみ適用されます。 Linux コンピューティングノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホームディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
storeName	string	証明書をインストールするコンピューティングノード上の証明書ストアの名前。このプロパティは、Windows コンピューティングノード (cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用して virtualMachineConfiguration を使用して作成されたプール) にのみ適用されます。一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、任意のカスタムストア名も使用できます。既定値は、My です。
thumbprint	string	証明書の拇印。
thumbprintAlgorithm	string	拇印が関連付けられているアルゴリズム。これは sha1 である必要があります。
visibility	CertificateVisibility[]	証明書のプライベートデータにアクセスできるコンピューティングノード上のユーザーアカウント。このコレクションでは、複数の可視性を指定できます。既定値はすべてのアカウントです。

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。

ContainerRegistry

プライベートコンテナーレジストリ。

名前	型	説明
identityReference	ComputeNodeIdentityReference	ユーザー名とパスワードではなく、Azure Container Registryへのアクセスに使用するユーザー割り当て ID への参照。コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
password	string	レジストリサーバーにログインするためのパスワード。
registryServer	string	レジストリ URL。省略すると、既定値は "docker.io" になります。
username	string	レジストリサーバーにログインするユーザー名。

ContainerWorkingDirectory

コンテナー Task 作業ディレクトリの場所。

名前	型	説明
containerImageDefault	string	コンテナー Image で定義されている作業ディレクトリを使用します。このディレクトリには、Batch によってダウンロードされたリソースファイルが含まれていないことに注意してください。
taskWorkingDirectory	string	標準の Batch サービス Task 作業ディレクトリを使用します。このディレクトリには、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}" サービスタグ。開いている受信ポートは必要ありません。