az batch pool
Note
このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細をご覧ください。
Batch プールを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az batch pool autoscale |
Batch プールの自動スケーリングを管理します。 |
コア | GA |
| az batch pool autoscale disable |
プールの自動スケーリングを無効にします。 |
コア | GA |
| az batch pool autoscale enable |
プールの自動スケーリングを有効にします。 |
コア | GA |
| az batch pool autoscale evaluate |
プールで自動スケーリング式を評価した結果を取得します。 |
コア | GA |
| az batch pool create |
アカウントに Batch プールを作成します。 プールを作成するときは、Cloud Services の構成または仮想マシンの構成から引数を選択します。 |
コア | GA |
| az batch pool create (azure-batch-cli-extensions 拡張機能) |
アカウントに Batch プールを作成します。 プールを作成するときは、Cloud Services の構成または仮想マシンの構成から引数を選択します。 |
拡張子 | GA |
| az batch pool delete |
指定したアカウントからプールを削除します。 |
コア | GA |
| az batch pool list |
指定したアカウント内のすべてのプールを一覧表示します。 |
コア | GA |
| az batch pool node-counts |
Batch プールのノード数を取得します。 |
コア | GA |
| az batch pool node-counts list |
プールごとにグループ化された、各状態のコンピューティング ノードの数を取得します。 |
コア | GA |
| az batch pool reset |
Batch プールのプロパティを更新します。 更新できる未指定のプロパティは、既定値にリセットされます。 |
コア | GA |
| az batch pool resize |
Batch プールのサイズ変更またはサイズ変更の停止。 |
コア | GA |
| az batch pool set |
Batch プールのプロパティを更新します。 サブグループ内のプロパティを更新すると、そのグループの未指定のプロパティがリセットされます。 |
コア | GA |
| az batch pool show |
指定したプールに関する情報を取得します。 |
コア | GA |
| az batch pool supported-images |
Azure Batch サービスでサポートされている VM イメージに関する情報を照会します。 |
コア | GA |
| az batch pool supported-images list |
Azure Batch サービスでサポートされているすべての仮想マシン イメージを一覧表示します。 |
コア | GA |
| az batch pool usage-metrics |
Batch プールの使用状況メトリックを表示します。 |
コア | GA |
| az batch pool usage-metrics list |
指定されたアカウントについて、個々の時間間隔にわたってプール別に集計された使用状況メトリックを一覧表示します。 |
コア | GA |
az batch pool create
アカウントに Batch プールを作成します。 プールを作成するときは、Cloud Services の構成または仮想マシンの構成から引数を選択します。
az batch pool create [--accelerated-networking {false, true}]
[--account-endpoint]
[--account-key]
[--account-name]
[--application-licenses]
[--application-package-references]
[--auto-scale-formula]
[--certificate-references]
[--defer-os-rolling-upgrade {false, true}]
[--disable-auto-rollback {false, true}]
[--disk-encryption-targets]
[--enable-auto-os-upgrade {false, true}]
[--enable-cross-zone-upgrade {false, true}]
[--enable-inter-node-communication]
[--enable-secure-boot {false, true}]
[--enable-vtpm {false, true}]
[--enable-write-accel {false, true}]
[--encryption-at-host {false, true}]
[--id]
[--image]
[--json-file]
[--max-batch-instance-percent]
[--max-unhealthy-instance-percent]
[--max-unhealthy-upgraded-instance-percent]
[--metadata]
[--node-agent-sku-id]
[--os-disk-caching {none, readonly, readwrite}]
[--os-disk-size]
[--os-family {2, 3, 4, 5, 6}]
[--os-version]
[--pause-time-between-batches]
[--placement {cachedisk}]
[--policy {regional, zonal}]
[--prioritize-unhealthy-instances {false, true}]
[--resize-timeout]
[--resource-tags]
[--rollback-failed-instances-on-policy-breach {false, true}]
[--security-type]
[--start-task-command-line]
[--start-task-resource-files]
[--start-task-wait-for-success]
[--storage-account-type {premium_lrs, standard_lrs, standardssd_lrs}]
[--target-communication {classic, default, simplified}]
[--target-dedicated-nodes]
[--target-low-priority-nodes]
[--targets]
[--task-slots-per-node]
[--upgrade-policy-mode {automatic, manual, rolling}]
[--use-rolling-upgrade-policy {false, true}]
[--vm-size]省略可能のパラメーター
このプールで高速ネットワークを有効にする必要があるかどうか。 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、「network/accelerated-networking-overview」を参照してください https://learn.microsoft.com/azure/virtual- 。 有効にするには true を設定します。
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 スペース区切りの値。
プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。 'id[#version]' 形式の省略可能なバージョンを持つスペース区切りのアプリケーション ID。
プール内のコンピューティング ノードの必要な数の数式。 式は、プールが作成される前に有効な値としてチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、次を参照してください https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/。
Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。 スペース区切りの証明書の拇印。
タスクを実行している場合は、TVM の OS アップグレードを延期します。 True の場合フラグが存在します。
OS イメージのロールバック機能を無効にする必要があるかどうか。 True の場合フラグが存在します。
DiskEncryptionTargets のスペース区切りリスト。 現在使用可能な値には、OsDisk と TemporaryDisk が含まれます。
新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。
Windows ベースのプールでこれが true に設定されている場合、WindowsConfiguration.enableAutomatic更新 を true に設定することはできません。 True の場合フラグが存在します。
アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、Update Doメイン と maxBatchInstancePercent を考慮してください。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。 True の場合フラグが存在します。
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。 True の場合フラグが存在します。
セキュア ブートを有効にします。
vTPM を有効にします。
ディスクで writeAccelerator を有効または無効にするかどうかを指定します。
このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 既定の動作は次のとおりです。このプロパティがリソースに対して true に設定されていない限り、ホストでの暗号化は無効になります。
必須。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に、大文字と小文字のみが異なる 2 つのプール ID がない可能性があります)。
OS イメージリファレンス。 これは、'publisher:offer:sku[:version]' 形式、または '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}' 形式の完全修飾 ARM イメージ ID のいずれかです。 'publisher:offer:sku[:version]' 形式の場合、バージョンは省略可能であり、省略した場合は最新のバージョンが使用されます。 有効な値は、'az batch pool supported-images list' を使用して取得できます。 例: 'MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest'。
プールを含むファイルは、JSON でプロパティ パラメーター仕様を作成します (REST API 要求本文に一致するように書式設定されます)。 このパラメーターを指定すると、すべての 'Pool Create Properties Parameter Arguments' は無視されます。 以下を参照してください。https://docs.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#request-body
1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に発生します。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 'key=value' 形式のスペース区切り値。
必須。 Batch コンピューティング ノード エージェントは、プール内の各コンピューティング ノードで実行されるプログラムであり、コンピューティング ノードと Batch サービスの間のコマンドアンドコントロール インターフェイスを提供します。 コンピューティング ノード エージェントの実装は、SKU と呼ばれ、オペレーティング システムごとに異なります。 選択したイメージ参照と一致するコンピューティング ノード エージェント SKU を指定する必要があります。 サポートされているコンピューティング ノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているコンピューティング ノード エージェント SKU の一覧」操作を参照してください。
キャッシュ要件を指定します。 使用できる値は None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 プレミアム ストレージの ReadOnly。
新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。
必須。 使用可能な値は 2 - OS ファミリ 2 で、Windows Server 2008 R2 SP1 に相当します。 3 - WINDOWS Server 2012 と同等の OS ファミリ 3。 4 - WINDOWS Server 2012 R2 と同等の OS ファミリ 4。 5 - Windows Server 2016 と同等の OS ファミリ 5。 6 - Windows Server 2019 と同等の OS ファミリ 6。 詳細については、Azure ゲスト OS リリース (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) に関するページを参照してください。
既定値は * で、指定した OS ファミリの最新のオペレーティング システム バージョンを指定します。
すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 想定される形式は ISO-8601 期間です。
プール内のすべての VM のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などの場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、Windows VM と Linux VM https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsのエフェメラル OS ディスク サイズの要件に関するページを参照してください。
Batch プールでのノード配置ポリシーの種類。 ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。
正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 True の場合フラグが存在します。
このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 想定される形式は ISO-8601 期間です。
ユーザーはプールのリソース タグを指定できます。 プール用に作成されたリソースも、同じリソース タグによってタグ付けされます。
ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。 True の場合フラグが存在します。
仮想マシンの SecurityType を指定します。 Uefi設定 を有効にするには、指定した値に設定する必要があります。 既定の動作は Uefi です設定は、このプロパティが設定されていない限り有効になりません。
必須。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で提供される環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。 filename=httpurl 形式のスペース区切りのリソース参照。
コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 True で、ノードで StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この状態は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、コンピューティング ノードで他のタスクの実行を開始できます。StartTask が失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は true です。 True の場合フラグが存在します。
マネージド ディスクのストレージ アカウントの種類。
プールの目的のノード通信モード。 この要素が存在する場合は、プールで構成されている既存の targetNodeCommunicationMode を置き換えます。 省略すると、既存のメタデータは変更されません。
プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
省略した場合、プール内のコンピューティング ノード上のディスクは暗号化されません。 Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。 暗号化する領域の分離されたターゲット ディスク。 値には、OsDisk または TemporaryDisk のいずれかを指定できます。
プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
プール OS アップグレードのモード。
自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。 True の場合フラグが存在します。
必須。 Cloud Services プール (cloudServiceConfiguration で作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services のサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除くすべての Cloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプールで使用可能な VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) または Virtual Machines (Windows) のサイズ ()」https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool create (azure-batch-cli-extensions 拡張機能)
アカウントに Batch プールを作成します。 プールを作成するときは、Cloud Services の構成または仮想マシンの構成から引数を選択します。
az batch pool create [--account-endpoint]
[--account-key]
[--account-name]
[--application-licenses]
[--application-package-references]
[--auto-scale-formula]
[--certificate-references]
[--disk-encryption-targets]
[--enable-inter-node-communication]
[--id]
[--image]
[--json-file]
[--metadata]
[--node-agent-sku-id]
[--os-family]
[--os-version]
[--parameters]
[--policy]
[--resize-timeout]
[--resource-group]
[--start-task-command-line]
[--start-task-resource-files]
[--start-task-wait-for-success]
[--target-dedicated-nodes]
[--target-low-priority-nodes]
[--targets]
[--task-slots-per-node]
[--template]
[--vm-size]省略可能のパラメーター
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウントの名前。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。
プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 式は、プールが作成される前に有効チェック。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) を参照してください。
Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。
DiskEncryptionTargets のスペース区切りリスト。 現在使用可能な値には、OsDisk と TemporaryDisk が含まれます。
プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
必須。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に、大文字と小文字のみが異なる 2 つのプール ID がない可能性があります)。
OS イメージリファレンス。 これは、'publisher:offer:sku[:version]' 形式、または '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}' 形式の完全修飾 ARM イメージ ID のいずれかです。 'publisher:offer:sku[:version]' 形式の場合、バージョンは省略可能であり、省略した場合は最新のバージョンが使用されます。 有効な値は、'az batch pool node-agent-skus list' を使用して取得できます。 例: 'MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest'。
JSON 形式で作成するプールを含むファイル。このパラメーターが指定されている場合、他のすべてのパラメーターは無視されます。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
プール内のコンピューティング ノードにプロビジョニングされる Batch ノード エージェントの SKU。 Batch ノード エージェントは、プール内の各ノードで実行されるプログラムであり、ノードと Batch サービスの間のコマンドおよび制御インターフェイスを提供します。 オペレーティング システムに応じてさまざまなノード エージェントの実装 (SKU と呼ばれます) があります。 選択したイメージ参照に一致するノード エージェント SKU を指定する必要があります。 サポートされているノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。
プール内の仮想マシンにインストールする Azure ゲスト OS ファミリ。 使用可能な値は 2 - OS ファミリ 2 で、Windows Server 2008 R2 SP1 に相当します。 3 - WINDOWS Server 2012 と同等の OS ファミリ 3。 4 - WINDOWS Server 2012 R2 と同等の OS ファミリ 4。 5 - Windows Server 2016 と同等の OS ファミリ 5。 詳細については、Azure ゲスト OS リリース (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) に関するページを参照してください。 使用できる値: 2、3、4、5。
既定値は * で、指定した OS ファミリの最新のオペレーティング システム バージョンを指定します。
Batch プール JSON テンプレート ファイルのパラメーター値。 --template でのみ使用できます。
Batch プールでのノード配置ポリシーの種類。 ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。 使用できる値: regional、zonal。
このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
Batch アカウントのリソース グループ。
開始タスクのコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 スペースで区切られたリソース参照 (filename=httpurl 形式)。
コンピューティング ノード上のタスクをスケジュールする前に、Batch サービスが開始タスクが正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 true で、コンピューティング ノードで開始タスクが失敗した場合、Batch サービスは開始タスクを最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはコンピューティング ノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、ノードの状態とスケジュール エラーの詳細を使用して検出できます。 false の場合、Batch サービスは開始タスクの完了を待機しません。 この場合、開始タスクの実行中に、他のタスクがコンピューティング ノードで実行を開始できます。開始タスクが失敗した場合でも、新しいタスクはノードで引き続きスケジュールされます。 既定値は false です。 True の場合フラグが存在します。
プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
省略した場合、プール内のコンピューティング ノード上のディスクは暗号化されません。 Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。 暗号化する領域の分離されたターゲット ディスク。 値には、OsDisk または TemporaryDisk のいずれかを指定できます。
プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
Batch プールの JSON テンプレート ファイル。 このパラメーターを指定すると、他のすべてのパラメーターは無視されます。
必須。 Cloud Services プール (cloudServiceConfiguration で作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services のサイズ (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/)」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除くすべての Cloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用するプールで使用可能な VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) または Virtual Machines (Windows) のサイズ ()」https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool delete
指定したアカウントからプールを削除します。
プールの削除を要求すると、プールの状態が削除に設定されているアクションが発生します。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティング ノードに変更し始めます。既存のコンピューティング ノードで実行されているタスクはすべて終了して再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。 実行中のタスクは再キューされるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。 その後、タスクは新しいプールで実行できます。 再キューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出してプールを 0 サイズに縮小する必要があります。 削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラー コード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。
az batch pool delete --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--yes]必須のパラメーター
削除するプールの ID。
省略可能のパラメーター
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool list
指定したアカウント内のすべてのプールを一覧表示します。
az batch pool list [--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--filter]
[--select]省略可能のパラメーター
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
OData $expand 句。
OData $filter 句。 このフィルターの構築の詳細については、次を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools。
OData $select 句。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool reset
Batch プールのプロパティを更新します。 更新できる未指定のプロパティは、既定値にリセットされます。
az batch pool reset --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--application-package-references]
[--certificate-references]
[--json-file]
[--metadata]
[--start-task-command-line]
[--start-task-environment-settings]
[--start-task-max-task-retry-count]
[--start-task-wait-for-success]必須のパラメーター
更新するプールの ID。
省略可能のパラメーター
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウントの名前。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
必須。 この一覧は、プール上の既存のアプリケーション パッケージ参照を置き換えます。 アプリケーション パッケージ参照への変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のアプリケーション パッケージ参照があります。 省略した場合、または空のコレクションを指定した場合は、既存のアプリケーション パッケージ参照がプールから削除されます。 特定のプールでは、最大 10 個の参照を指定できます。
必須。 この一覧は、プールで構成されている既存の証明書参照を置き換えます。 空のコレクションを指定すると、既存の証明書参照がプールから削除されます。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。
JSON のプール更新プロパティ パラメーター仕様を含むファイル (REST API 要求本文に一致するように書式設定)。 このパラメーターを指定すると、すべての 'Pool Update Properties Parameter Arguments' は無視されます。
必須。 この一覧は、プールで構成されている既存のメタデータを置き換えます。 省略した場合、または空のコレクションを指定した場合は、既存のメタデータがプールから削除されます。
開始タスクのコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。
開始タスクの環境変数設定の一覧。 'key=value' 形式のスペース区切り値。
タスクを再試行できる最大回数。
コンピューティング ノード上のタスクをスケジュールする前に、Batch サービスが開始タスクが正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 フラグが存在する場合は True、それ以外の場合は False に設定されます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool resize
Batch プールのサイズ変更またはサイズ変更の停止。
az batch pool resize --pool-id
[--abort]
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--node-deallocation-option {requeue, retaineddata, taskcompletion, terminate}]
[--resize-timeout]
[--target-dedicated-nodes]
[--target-low-priority-nodes]必須のパラメーター
プールの ID。
省略可能のパラメーター
プールのサイズ変更操作を停止します。
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウントの名前。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
この操作は、リソースの現在の ETag が指定した値と完全に一致する場合にのみ実行されます。
この操作は、指定されたタイムスタンプ以降にリソースが変更された場合にのみ実行されます。
この操作は、リソースの現在の ETag が指定した値と正確に一致する場合にのみ実行されません。
この操作は、指定されたタイムスタンプ以降にリソースが変更された場合にのみ実行されません。
プール サイズが減少している場合に、プールからノードを削除できる場合。
既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
プール内の専用コンピューティング ノードの必要な数。
プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool set
Batch プールのプロパティを更新します。 サブグループ内のプロパティを更新すると、そのグループの未指定のプロパティがリセットされます。
az batch pool set --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--application-package-references]
[--certificate-references]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--json-file]
[--metadata]
[--start-task-command-line]
[--start-task-environment-settings]
[--start-task-max-task-retry-count]
[--start-task-resource-files]
[--start-task-wait-for-success]
[--target-communication {classic, default, simplified}]必須のパラメーター
更新するプールの ID。
省略可能のパラメーター
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 この要素が存在する場合は、既存の Package 参照が置き換えられます。 空のコレクションを指定すると、すべてのパッケージ参照がプールから削除されます。 省略すると、既存のパッケージ参照は変更されません。 'id[#version]' 形式の省略可能なバージョンを持つスペース区切りのアプリケーション ID。
この要素が存在する場合は、プールで構成されている既存の証明書参照が置き換えられます。 省略すると、既存の証明書参照は変更されません。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。 スペース区切りの証明書の拇印。
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。
プールのパッチ パラメーター仕様を JSON に含むファイル (それぞれの REST API 本文に一致するように書式設定)。 このパラメーターを指定すると、すべての 'Pool Arguments' は無視されます。
この要素が存在する場合は、プールで構成されている既存のメタデータが置き換えられます。 空のコレクションを指定すると、すべてのメタデータがプールから削除されます。 省略すると、既存のメタデータは変更されません。 'key=value' 形式のスペース区切り値。
必須。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で提供される環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
'key=value' 形式のスペース区切り値。
タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、これは開始タスクまたはタスクには推奨されません。 既定値は 0 (再試行なし) です。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。 filename=httpurl 形式のスペース区切りのリソース参照。
コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 True で、ノードで StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この状態は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、コンピューティング ノードで他のタスクの実行を開始できます。StartTask が失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は true です。 プロパティを更新するには、'true' または 'false' を指定します。
プールの目的のノード通信モード。 この要素が存在する場合は、プールで構成されている既存の targetNodeCommunicationMode を置き換えます。 省略すると、既存のメタデータは変更されません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az batch pool show
指定したプールに関する情報を取得します。
az batch pool show --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--select]必須のパラメーター
取得するプールの ID。
省略可能のパラメーター
Batch サービス エンドポイント。 または、環境変数で設定します: AZURE_BATCH_ENDPOINT。
Batch アカウント キー。 または、環境変数で設定します: AZURE_BATCH_ACCESS_KEY。
Batch アカウント名。 または、環境変数 (AZURE_BATCH_ACCOUNT) で設定します。
OData $expand 句。
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、指定した時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。
OData $select 句。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI