az batch pool

  • 參考

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。 安裝每個擴充功能以受益於其擴充功能。 深入了解擴充功能。

管理 Batch 集區。

命令

名稱 Description 類型 狀態
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 集區。 建立集區時，請從 雲端服務 組態或虛擬機組態中選擇自變數。

 核心 GA
az batch pool create (azure-batch-cli-extensions 擴充功能)

在帳戶中建立 Batch 集區。 建立集區時，請從 雲端服務 組態或虛擬機組態中選擇自變數。

 副檔名 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 集區。 建立集區時，請從 雲端服務 組態或虛擬機組態中選擇自變數。

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]

選擇性參數

--accelerated-networking

此集區是否應該啟用加速網路。 加速網路可將單一根 I/O 虛擬化 （SR-IOV） 啟用至 VM，這可能會導致改善網路效能。 如需詳細資訊，請參閱： https://learn.microsoft.com/azure/virtual- network/accelerated-networking-overview。 將 true 設定為啟用。

接受的值: false, true
--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--application-licenses

應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，集區建立將會失敗。 以空格分隔的值。

--application-package-references

建立集區時，套件的應用程式標識碼必須完整 （/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。 以 'id[#version]' 格式的選擇性版本分隔應用程式識別碼。

--auto-scale-formula

集區中所需計算節點數目的公式。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。 如需指定此公式的詳細資訊，請參閱 https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/。

--certificate-references

針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能 。 以空格分隔的憑證指紋。

--defer-os-rolling-upgrade

如果 OS 正在執行工作，請延遲 TVM 上的 OS 升級。 如果旗標存在，則為 True。

接受的值: false, true
--disable-auto-rollback

是否應停用OS映像復原功能。 如果旗標存在，則為 True。

接受的值: false, true
--disk-encryption-targets

DiskEncryptionTargets 的空間分隔清單。 目前的可能值包括 OsDisk 和 TemporaryDisk。

--enable-auto-os-upgrade

指出當較新版本的OS映像可用時，是否應該以滾動方式自動套用作業系統升級至擴展集實例。

如果 Windows 集區將此設定為 true，則 WindowsConfiguration.enableAutomatic 更新 無法設定為 true。 如果旗標存在，則為 True。

接受的值: false, true
--enable-cross-zone-upgrade

允許 VMSS 在建構升級批次時忽略 AZ 界限。 將 Update 網域和 maxBatchInstancePercent 納入考慮，以判斷批次大小。 只有當使用 NodePlacementConfiguration 作為 Zonal 時，此欄位才能設定為 true 或 false。 如果旗標存在，則為 True。

接受的值: false, true
--enable-inter-node-communication

集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。 如果旗標存在，則為 True。

--enable-secure-boot

啟用安全開機。

接受的值: false, true
--enable-vtpm

啟用 vTPM。

接受的值: false, true
--enable-write-accel

指定是否應該在磁碟上啟用或停用 writeAccelerator。

接受的值: false, true
--encryption-at-host

用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。 默認行為為：除非資源將此屬性設定為 true，否則將會停用主機的加密。

接受的值: false, true
--id

必要。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符會保留大小寫且不區分大小寫（也就是說，您可能不會在帳戶內有兩個只區分大小寫的集區標識符）。

--image

OS 映像參考。 這可以是 'publisher：offer：sku[：version]' 格式，或 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}' 格式的完整 ARM 映射標識符。 如果 'publisher：offer：sku[：version]' 格式，版本是選擇性的，如果省略了最新版本，則會使用 。 有效的值可以透過 'az batch pool supported-images list' 擷取。 例如：『MicrosoftWindowsServer：WindowsServer：2012-R2-Datacenter：latest』。

--json-file

包含集區的檔案會以 JSON 建立屬性參數規格（格式為符合 REST API 要求本文）。 如果指定此參數，則會忽略所有 「集區建立屬性參數自變數」。 請參閱 https://docs.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#request-body。

--max-batch-instance-percent

一個批次中滾動升級同時升級的虛擬機實例總數上限百分比。 由於這是最大值，先前或未來批次中狀況不良的實例可能會導致批次中的實例百分比降低，以確保更高的可靠性。 此欄位的值應介於 5 到 100 之間，包含。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都指派值，maxBatchInstancePercent 的值不應該超過 maxUnhealthyInstancePercent。

--max-unhealthy-instance-percent

擴展集中可同時狀況不良的虛擬機實例總數百分比上限，可能是因為升級而造成狀況不良，或在滾動升級中止之前，在虛擬機健康情況檢查中發現狀況不良狀態。 啟動任何批次之前，會先檢查此條件約束。 此欄位的值應介於 5 到 100 之間，包含。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都指派值，maxBatchInstancePercent 的值不應該超過 maxUnhealthyInstancePercent。

--max-unhealthy-upgraded-instance-percent

可發現處於狀況不良狀態的已升級虛擬機實例百分比上限。 升級每個批次之後，就會進行這項檢查。 如果超過這個百分比，滾動更新就會中止。 此欄位的值應介於 0 到 100 之間，並包含。

--metadata

Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。 以 『key=value』 格式分隔的空間值。

--node-agent-sku-id

必要。 Batch Compute Node 代理程式是在集區中的每個計算節點上執行的程式，並提供計算節點與 Batch 服務之間的命令與控制介面。 針對不同的操作系統，計算節點代理程式有不同的實作，稱為 SKU。 您必須指定符合選取的映像參考的計算節點代理程式 SKU。 若要取得支援的計算節點代理程式 SKU 清單及其已驗證的映像參考清單，請參閱「列出支援的計算節點代理程式 SKU」作業。

--os-disk-caching

指定快取需求。 可能的值為：None、ReadOnly、ReadWrite。 預設值為：標準記憶體的 [無]。 進階版 記憶體的 ReadOnly。

接受的值: none, readonly, readwrite
--os-disk-size

建立新的 OS 磁碟時，以 GB 為單位的初始磁碟大小。

--os-family

必要。 可能的值為：2 - OS 系列 2，相當於 Windows Server 2008 R2 SP1。 3 - OS 系列 3，相當於 Windows Server 2012。 4 - OS 系列 4，相當於 Windows Server 2012 R2。 5 - OS 系列 5，相當於 Windows Server 2016。 6 - OS 系列 6，相當於 Windows Server 2019。 如需詳細資訊，請參閱 Azure 客體 OS 版本 （https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases）。

接受的值: 2, 3, 4, 5, 6
--os-version

預設值為 * ，指定指定作業系統系列的最新操作系統版本。

--pause-time-between-batches

完成一個批次中所有虛擬機的更新，以及開始下一個批次之間的等候時間。 持續時間應以 ISO 8601 格式指定。 預期格式為 ISO-8601 持續時間。

--placement

指定集區中所有 VM 之作業系統磁碟的暫時磁碟位置。 用戶可以在要求中使用這個屬性來選擇位置，例如快取暫時OS磁碟布建的磁碟空間。 如需暫時 OS 磁碟大小需求的詳細資訊，請參閱 的 Windows VM https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements 暫時 OS 磁碟大小需求，以及位於 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的 Linux VM。

接受的值: cachedisk
--policy

Batch 集區上的節點放置原則類型。 Batch 服務用來布建節點的配置原則。 如果未指定，Batch 會使用區域原則。

接受的值: regional, zonal
--prioritize-unhealthy-instances

在任何狀況良好的實例之前，升級擴展集中所有狀況不良的實例。 如果旗標存在，則為 True。

接受的值: false, true
--resize-timeout

此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為 15 分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。 預期格式為 ISO-8601 持續時間。

--resource-tags

用戶能夠指定集區的資源標記。 然後，針對集區建立的任何資源也會由相同的資源標籤。

--rollback-failed-instances-on-policy-breach

如果違反滾動升級原則，回復實例至先前的模型。 如果旗標存在，則為 True。

接受的值: false, true
--security-type

指定虛擬機的 SecurityType。 它必須設定為任何指定的值，才能啟用 Uefi 設定。 默認行為為：除非設定此屬性，否則不會啟用 Uefi 設定。

--start-task-command-line

必要。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或在 Linux 中使用 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對路徑（相對於工作工作目錄），或使用 Batch 提供的環境變數 （https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables）。

--start-task-resource-files

此元素底下列出的檔案位於工作的工作目錄中。 filename=httpurl 格式的空間分隔資源參考。

--start-task-wait-for-success

在排程計算節點上的任何工作之前，Batch 服務是否應該等候 StartTask 順利完成（也就是結束代碼 0）。 如果 True 且 StartTask 在節點上失敗，Batch 服務會重試 StartTask，最多重試計數上限 （maxTaskRetryCount）。 如果工作在所有重試之後仍未順利完成，則 Batch 服務會將節點標示為無法使用，且不會排程工作。 您可以透過計算節點狀態和失敗資訊詳細資料來偵測此狀況。 如果為 false，Batch 服務將不會等候 StartTask 完成。 在此情況下，當 StartTask 仍在執行時，其他工作可以在計算節點上開始執行;即使 StartTask 失敗，新的工作仍會繼續排程在計算節點上。 預設值為 True。 如果旗標存在，則為 True。

--storage-account-type

受控磁碟的記憶體帳戶類型。

接受的值: premium_lrs, standard_lrs, standardssd_lrs
--target-communication

集區所需的節點通訊模式。 如果這個專案存在，它會取代集區上設定的現有 targetNodeCommunicationMode。 如果省略，任何現有的元數據會保持不變。

接受的值: classic, default, simplified
--target-dedicated-nodes

集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。

--target-low-priority-nodes

集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。

--targets

如果省略，將不會加密集區中計算節點上的磁碟。 在 Linux 集區上，僅支援 「TemporaryDisk」 ;在 Windows 集區上，必須指定 「OsDisk」 和 「TemporaryDisk」。。 要加密的空間分隔目標磁碟。 值可以是 OsDisk 或 TemporaryDisk。

--task-slots-per-node

可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。

--upgrade-policy-mode

集區OS升級的模式。

接受的值: automatic, manual, rolling
--use-rolling-upgrade-policy

指出是否應在自動OS升級期間使用滾動升級原則。 如果未在 VMSS 上定義任何原則，自動 OS 升級將會回復為默認原則。 如果旗標存在，則為 True。

接受的值: false, true
--vm-size

必要。 如需 雲端服務 集區可用虛擬機大小的相關信息（使用 cloudServiceConfiguration 建立的集區），請參閱 雲端服務 的大小 （https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/）。 Batch 支援除了 ExtraSmall、A1V2 和 A2V2 以外的所有 雲端服務 VM 大小。 如需使用來自 虛擬機器 Marketplace 映像的集區可用 VM 大小相關信息（使用 virtualMachineConfiguration 建立的集區），請參閱 虛擬機器 （Linux） （https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/） 的大小或 虛擬機器 的大小 （Windows） （https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/）。 Batch 支援除了STANDARD_A0和具有進階記憶體以外的所有 Azure VM 大小（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az batch pool create (azure-batch-cli-extensions 擴充功能)

在帳戶中建立 Batch 集區。 建立集區時，請從 雲端服務 組態或虛擬機組態中選擇自變數。

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]

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--application-licenses

應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，集區建立將會失敗。

--application-package-references

建立集區時，套件的應用程式標識碼必須完整 （/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。

--auto-scale-formula

如果 enableAutoScale 設定為 false，則不得指定此屬性。 如果 enableAutoScale 設定為 true，則為必要專案。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會以詳細的錯誤資訊拒絕要求。 如需指定此公式的詳細資訊，請參閱<在 azure="" batch="" 集區中自動調整計算節點="">（https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/）。

--certificate-references

針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能 。

--disk-encryption-targets

DiskEncryptionTargets 的空間分隔清單。 目前的可能值包括 OsDisk 和 TemporaryDisk。

--enable-inter-node-communication

集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點有部署限制。 這可能會導致集區無法達到其所需的大小。 預設值為 false。

預設值: False
--id

必要。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符會保留大小寫且不區分大小寫（也就是說，您可能不會在帳戶內有兩個只區分大小寫的集區標識符）。

--image

OS 映像參考。 這可以是 'publisher：offer：sku[：version]' 格式，或 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}' 格式的完整 ARM 映射標識符。 如果 'publisher：offer：sku[：version]' 格式，版本是選擇性的，如果省略了最新版本，則會使用 。 有效的值可以透過 'az batch pool node-agent-skus list' 擷取。 例如：『MicrosoftWindowsServer：WindowsServer：2012-R2-Datacenter：latest』。

--json-file

包含 JSON 格式之集區的檔案，如果指定此參數，則會忽略所有其他參數。

--metadata

Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。

--node-agent-sku-id

要布建在集區中計算節點上的 Batch 節點代理程式的 SKU。 Batch 節點代理程式是在集區中的每個節點上執行的程式，並提供節點與 Batch 服務之間的命令和控制介面。 節點代理程式對不同作業系統有不同的實作方式，稱為 SKU。 您必須指定符合所選映像參考的節點代理程式 SKU。 若要取得支持的節點代理程式 SKU 清單及其已驗證映像參考清單，請參閱「列出支援的節點代理程式 SKU」作業。

--os-family

要安裝在集區中虛擬機上的 Azure 客體 OS 系列。 可能的值為：2 - OS 系列 2，相當於 Windows Server 2008 R2 SP1。 3 - OS 系列 3，相當於 Windows Server 2012。 4 - OS 系列 4，相當於 Windows Server 2012 R2。 5 - OS 系列 5，相當於 Windows Server 2016。 如需詳細資訊，請參閱 Azure 客體 OS 版本 （https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases）。 允許的值：2、3、4、5。

--os-version

預設值為 * ，指定指定作業系統系列的最新操作系統版本。

--parameters

Batch 集區 JSON 範本檔案的參數值。 只能與 --template 搭配使用。

--policy

Batch 集區上的節點放置原則類型。 Batch 服務用來布建節點的配置原則。 如果未指定，Batch 會使用區域原則。 允許的值：區域、區域。

--resize-timeout

此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為 15 分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。

--resource-group

Batch 帳戶的資源群組。

--start-task-command-line

開始工作的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或在 Linux 中使用 “/bin/sh -c MyCommand”。

--start-task-resource-files

Batch 服務在執行命令行之前，會先下載到計算節點的檔案清單。 以 filename=httpurl 格式分隔的資源參考空間。

--start-task-wait-for-success

Batch 服務是否應該等候啟動工作順利完成（也就是結束代碼 0 結束），再排程計算節點上的任何工作。 如果 true 且計算節點上的啟動工作失敗，Batch 服務就會將啟動工作重試到其最大重試計數 （maxTaskRetryCount）。 如果工作在所有重試之後仍未順利完成，Batch 服務會將計算節點標示為無法使用，且不會排程工作。 您可以透過節點狀態和排程錯誤詳細數據來偵測此狀況。 如果為 false，Batch 服務將不會等候啟動工作完成。 在此情況下，當啟動工作仍在執行時，其他工作可以在計算節點上開始執行;即使啟動工作失敗，新工作仍會繼續排程在節點上。 預設值為 false。 如果旗標存在，則為 True。

預設值: False
--target-dedicated-nodes

集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。

--target-low-priority-nodes

集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定此屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。

--targets

如果省略，將不會加密集區中計算節點上的磁碟。 在 Linux 集區上，僅支援 「TemporaryDisk」 ;在 Windows 集區上，必須指定 「OsDisk」 和 「TemporaryDisk」。。 要加密的空間分隔目標磁碟。 值可以是 OsDisk 或 TemporaryDisk。

--task-slots-per-node

可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值是 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。

--template

Batch 集區 JSON 範本檔案。 如果指定此參數，則會忽略所有其他參數。

--vm-size

必要。 如需 雲端服務 集區可用虛擬機大小的相關信息（使用 cloudServiceConfiguration 建立的集區），請參閱 雲端服務 的大小 （https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/）。 Batch 支援除了 ExtraSmall、A1V2 和 A2V2 以外的所有 雲端服務 VM 大小。 如需使用來自 虛擬機器 Marketplace 映像的集區可用 VM 大小相關信息（使用 virtualMachineConfiguration 建立的集區），請參閱 虛擬機器 （Linux） 的大小https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ （） 或 虛擬機器 的大小 （Windows） （https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/）。 Batch 支援除了STANDARD_A0和具有進階記憶體以外的所有 Azure VM 大小（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az batch pool delete

編輯

從指定的帳戶刪除集區。

當您要求刪除集區時，會發生下列動作：集區狀態設定為刪除;已停止集區上任何進行中的重設大小作業;Batch 服務會開始將集區大小調整為零計算節點;在現有計算節點上執行的任何工作都會終止並重新排入佇列（如同已使用預設重新佇列選項要求重設大小集區作業）：最後，集區會從系統中移除。 因為重新排入佇列執行的工作，因此使用者可以藉由更新其作業以以不同的集區為目標來重新執行這些工作。 工作接著可以在新的集區上執行。 如果您想要覆寫重新佇列行為，則應該先明確地呼叫重設大小集區，將集區壓縮為零大小，再刪除集區。 如果您在處於刪除狀態的集區上呼叫 Update、Patch 或刪除 API，它會失敗，並出現 HTTP 狀態代碼 409，並出現錯誤碼 PoolBeingDeleted。

az batch pool delete --pool-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--yes]

必要參數

--pool-id

要刪除的集區標識碼。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來尚未修改時，才會執行此作業。

--yes -y

不提示確認。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az batch pool list

編輯

列出指定帳戶中的所有集區。

az batch pool list [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--expand]
                   [--filter]
                   [--select]

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--expand

OData $expand 子句。

--filter

OData $filter 子句。 如需建構此篩選的詳細資訊，請參閱 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools。

--select

OData $select 子句。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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]

必要參數

--pool-id

要更新之集區的標識碼。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--application-package-references

必要。 此清單會取代集區上任何現有的應用程式套件參考。 應用程式套件參考的變更會影響聯結集區的所有新計算節點，但在重新啟動或重新映像之前，不會影響已在集區中的計算節點。 在任何指定的集區上，最多有10個應用程式套件參考。 如果省略，或如果您指定空集合，則會從集區中移除任何現有的應用程式套件參考。 在指定的集區上最多可以指定10個參考。

--certificate-references

必要。 此清單會取代集區上設定的任何現有憑證參考。 如果您指定空集合，則會從集區中移除任何現有的憑證參考。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能 。

--json-file

包含 JSON 中集區更新屬性參數規格的檔案（格式為符合 REST API 要求本文）。 如果指定此參數，則會忽略所有 「集區更新屬性參數自變數」。

--metadata

必要。 此清單會取代集區上設定的任何現有元數據。 如果省略，或如果您指定空集合，則會從集區中移除任何現有的元數據。

--start-task-command-line

開始工作的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或在 Linux 中使用 “/bin/sh -c MyCommand”。

--start-task-environment-settings

啟動工作的環境變數設定清單。 以 『key=value』 格式分隔的空間值。

--start-task-max-task-retry-count

重試工作的最大次數。

--start-task-wait-for-success

Batch 服務是否應該等候啟動工作順利完成（也就是結束代碼 0 結束），再排程計算節點上的任何工作。 如果旗標存在，則為 True，否則會預設為 False。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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]

必要參數

--pool-id

集區的標識碼。

選擇性參數

--abort

停止集區重設大小作業。

預設值: False
--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--if-match

只有在資源的目前 ETag 完全符合指定的值時，才會執行作業。

--if-modified-since

只有在資源自指定的時間戳之後修改過時，才會執行此作業。

--if-none-match

只有在資源的目前 ETag 完全符合指定的值時，才會執行作業。

--if-unmodified-since

只有在資源自指定的時間戳之後修改過時，才會執行此作業。

--node-deallocation-option

如果集區大小正在減少，則節點可能會從集區中移除時。

接受的值: requeue, retaineddata, taskcompletion, terminate
--resize-timeout

預設值為 15 分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。

--target-dedicated-nodes

集區中所需的專用計算節點數目。

--target-low-priority-nodes

集區中所需的現成/低優先順序計算節點數目。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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}]

必要參數

--pool-id

要更新的集區標識碼。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--application-package-references

封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 如果這個專案存在，它會取代任何現有的套件參考。 如果您指定空集合，則會從集區中移除所有套件參考。 如果省略，任何現有的套件參考會保持不變。 以 'id[#version]' 格式的選擇性版本分隔應用程式識別碼。

--certificate-references

如果這個專案存在，它會取代集區上設定的任何現有憑證參考。 如果省略，任何現有的憑證參考會保持不變。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能 。 以空格分隔的憑證指紋。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來尚未修改時，才會執行此作業。

--json-file

檔案，其中包含 JSON 中的集區修補程式參數規格（格式化為符合個別 REST API 主體）。 如果指定此參數，則會忽略所有 『Pool Arguments』。

--metadata

如果這個專案存在，它會取代集區上設定的任何現有元數據。 如果您指定空集合，則會從集區中移除任何元數據。 如果省略，任何現有的元數據會保持不變。 以 『key=value』 格式分隔的空間值。

--start-task-command-line

必要。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或在 Linux 中使用 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對路徑（相對於工作工作目錄），或使用 Batch 提供的環境變數 （https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables）。

--start-task-environment-settings

以 『key=value』 格式分隔的空間值。

--start-task-max-task-retry-count

重試工作的最大次數。 如果 Batch 服務結束代碼為非零，則會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。 如果重試計數上限為0，Batch服務就不會重試工作。 如果重試計數上限為 -1，Batch 服務會不限制地重試工作，但不建議用於啟動工作或任何工作。 預設值為 0（沒有重試）。

--start-task-resource-files

此元素底下列出的檔案位於工作的工作目錄中。 filename=httpurl 格式的空間分隔資源參考。

--start-task-wait-for-success

在排程計算節點上的任何工作之前，Batch 服務是否應該等候 StartTask 順利完成（也就是結束代碼 0）。 如果 True 且 StartTask 在節點上失敗，Batch 服務會重試 StartTask，最多重試計數上限 （maxTaskRetryCount）。 如果工作在所有重試之後仍未順利完成，則 Batch 服務會將節點標示為無法使用，且不會排程工作。 您可以透過計算節點狀態和失敗資訊詳細資料來偵測此狀況。 如果為 false，Batch 服務將不會等候 StartTask 完成。 在此情況下，當 StartTask 仍在執行時，其他工作可以在計算節點上開始執行;即使 StartTask 失敗，新的工作仍會繼續排程在計算節點上。 預設值為 True。 指定 'true' 或 'false' 來更新屬性。

--target-communication

集區所需的節點通訊模式。 如果這個專案存在，它會取代集區上設定的現有 targetNodeCommunicationMode。 如果省略，任何現有的元數據會保持不變。

接受的值: classic, default, simplified
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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]

必要參數

--pool-id

要取得的集區標識碼。

選擇性參數

--account-endpoint

Batch 服務端點。 或者，由環境變數設定：AZURE_BATCH_ENDPOINT。

--account-key

Batch 帳戶金鑰。 或者，由環境變數設定：AZURE_BATCH_ACCESS_KEY。

--account-name

Batch 帳戶名稱。 或者，由環境變數設定：AZURE_BATCH_ACCOUNT。

--expand

OData $expand 子句。

--if-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時，才會執行此作業。

--if-modified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行此作業。

--if-none-match

與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時，才會執行作業。

--if-unmodified-since

時間戳，指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來尚未修改時，才會執行此作業。

--select

OData $select 子句。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。