az batch pool
Note
このリファレンスは、Azure CLI (バージョン 2.30.0 以降) の azure-batch-cli-extensions 拡張機能の一部です。 拡張機能は、az batch pool コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
Batch プールを管理します。
コマンド
| 名前 | 説明 | 型 | Status |
|---|---|---|---|
| az batch pool create |
アカウントに Batch プールを作成します。 プールを作成するときは、Cloud Services の構成または仮想マシンの構成から引数を選択します。 |
拡張 | GA |
az batch pool create
アカウントに 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 を使います。
Azure CLI
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示