Pool - List

服務:

Batch Service

API 版本:

2024-07-01.20.0

列出所有要掛接的集區

GET {batchUrl}/pools?api-version=2024-07-01.20.0

含選擇性參數:

GET {batchUrl}/pools?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
api-version	query	True	string	用戶端 API 版本。
$expand	query		string	OData $expand 子句。
$filter	query		string	OData $filter 子句。 如需建構此篩選的詳細資訊，請參閱 https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools。
$select	query		string	OData $select 子句。
maxresults	query		integer int32	回應中要傳回的項目數目上限。 最多可以傳回1000個集區。
timeout	query		integer int32	伺服器可以花費數秒處理要求的時間上限。 預設值為30秒。 如果值大於 30，則會改用預設值。

要求標頭

Media Types: "application/json; odata=minimalmetadata"

名稱	必要	類型	Description
client-request-id		string uuid	呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id		boolean	伺服器是否應該在回應中傳回 client-request-id。
ocp-date		string date-time-rfc1123	發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

回應

名稱	類型	Description
200 OK	CloudPoolListResult	包含集區清單的回應。 標題 client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

Pool list

範例要求

HTTP

GET account.region.batch.azure.com/pools?api-version=2024-07-01.20.0

範例回覆

狀態碼:

200

{
  "value": [
    {
      "id": "testPool",
      "url": "https://accountname.region.batch.azure.com/pools/testPool",
      "eTag": "0x8D4123BEF87D233",
      "lastModified": "2016-11-21T18:26:39.7108787Z",
      "creationTime": "2016-11-21T18:26:39.7108787Z",
      "state": "active",
      "stateTransitionTime": "2016-11-21T18:26:39.7108787Z",
      "allocationState": "steady",
      "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z",
      "vmSize": "small",
      "resizeTimeout": "PT15M",
      "currentDedicatedNodes": 3,
      "currentLowPriorityNodes": 0,
      "targetDedicatedNodes": 3,
      "targetLowPriorityNodes": 0,
      "enableAutoScale": false,
      "enableInterNodeCommunication": false,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "taskSlotsPerNode": 1,
      "taskSchedulingPolicy": {
        "nodeFillType": "spread"
      },
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSKUId": "batch.node.windows amd64"
      }
    }
  ]
}

定義

名稱	Description
AllocationState	集區是否重設大小。
ApplicationPackageReference	要部署到計算節點之封裝的參考。
AutomaticOSUpgradePolicy	用於執行自動OS升級的組態參數。
AutoScaleRun	集區自動調整公式執行的結果和錯誤。
AutoScaleRunError	執行或評估集區自動調整公式時所發生的錯誤。
AutoUserScope	自動用戶的範圍
AutoUserSpecification	指定在 Batch 服務上執行工作之自動用戶的參數。
AzureBlobFileSystemConfiguration	用來使用 Blobfuse 連線到 Azure 記憶體容器的資訊。
AzureFileShareConfiguration	用來連線到 Azure 檔案共享的資訊。
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchPoolIdentity	如果已設定，則為 Batch 集區的身分識別。
CachingType	要針對磁碟啟用的快取類型。
CertificateReference	要安裝在集區中計算節點上之憑證的參考。
CertificateStoreLocation	要安裝憑證之計算節點上的證書存儲位置。
CertificateVisibility	計算節點上的哪些用戶帳戶應該可以存取憑證的私用數據。
CIFSMountConfiguration	用來連線到 CIFS 檔案系統的資訊。
CloudPool	Azure Batch 服務中的集區。
CloudPoolListResult	列出帳戶中集區的結果。
ComputeNodeFillType	工作如何分散到集區中的計算節點。
ComputeNodeIdentityReference	與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。
ContainerConfiguration	容器啟用集區的組態。
ContainerHostBatchBindMountEntry	您想要掛接至工作容器的路徑和掛接模式專案。
ContainerHostDataPath	要掛接至容器工作容器的路徑。
ContainerRegistry	私人容器登錄。
ContainerType	要使用的容器技術。
ContainerWorkingDirectory	容器工作工作目錄的位置。
DataDisk	集區中與計算節點相關聯的數據磁碟將使用的設定。 使用連結的數據磁碟時，您必須從 VM 內掛接和格式化磁碟，才能使用這些磁碟。
DiffDiskPlacement	指定集區中所有計算節點 （VM） 操作系統磁碟的暫時磁碟位置。
DiffDiskSettings	指定計算節點 （VM） 所使用作業系統磁碟的暫時磁碟設定。
DiskEncryptionConfiguration	在集區中的計算節點上套用的磁碟加密組態。 使用 Azure 計算資源庫映像建立的 Linux 集區不支援磁碟加密設定。
DiskEncryptionTarget	磁碟目標 Batch 服務的清單會在計算節點上加密。
DynamicVNetAssignmentScope	動態 vnet 指派的範圍。
ElevationLevel	使用者的提高許可權層級。
EnvironmentSetting	要設定於工作進程的環境變數。
ErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
ImageReference	Azure 虛擬機 Marketplace 映像或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 映像參考清單，請參閱「列出支援的映像」作業。
InboundEndpointProtocol	端點的通訊協定。
InboundNATPool	輸入 NAT 集區，可用來在外部處理 Batch 集區中計算節點上的特定埠。
IPAddressProvisioningType	集區公用IP位址的布建類型。
LinuxUserConfiguration	用來在 Linux 計算節點上建立使用者帳戶的屬性。
LoginMode	使用者的登入模式
ManagedDisk
MetadataItem	與 Batch 服務資源相關聯的名稱/值組。
MountConfiguration	要掛接在每個節點上的文件系統。
NameValuePair	表示名稱/值組。
NetworkConfiguration	集區的網路組態。
NetworkSecurityGroupRule	要套用至輸入端點的網路安全組規則。
NetworkSecurityGroupRuleAccess	應該針對指定的IP位址、子網範圍或卷標採取的動作。
NFSMountConfiguration	用來連線到 NFS 檔案系統的資訊。
NodeCommunicationMode	決定集區如何與 Batch 服務通訊。
NodePlacementConfiguration	集區的節點放置組態。
NodePlacementPolicyType	配置集區中節點的放置原則。
OSDisk	計算節點之作業系統磁碟的設定（VM）。
PoolEndpointConfiguration	集區的端點組態。
PoolIdentityType	如果已設定，則為 Batch 集區的身分識別。
PoolState	集區的目前狀態。
PoolStatistics	包含集區存留期的使用率和資源使用量統計數據。
PublicIPAddressConfiguration	集區網路設定的公用IP位址組態。
ResizeError	重設集區大小時發生的錯誤。
ResourceFile	要下載至計算節點的單一檔案或多個檔案。
ResourceStatistics	集區中計算節點的資源耗用量相關統計數據。
RollingUpgradePolicy	執行滾動升級時所使用的組態參數。
SecurityEncryptionTypes	指定受控磁碟的 EncryptionType。 它設定為 VMGuestStateOnly，以便只加密 VMGuestState Blob，而 NonPersistedTPM 則不會保存 VMGuestState Blob 中的韌體狀態。 附注：它只能設定為機密 VM，而且在使用機密 VM 時為必要專案。
SecurityProfile	指定虛擬機或虛擬機擴展集的安全性配置檔設定。
SecurityTypes	指定虛擬機的 SecurityType。 它必須設定為任何指定的值，才能啟用 UefiSettings。
ServiceArtifactReference	指定使用 'latest' 映射版本時，用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。
StartTask	當節點加入 Azure Batch 服務中的集區，或計算節點重新啟動或重新映像時執行的工作。
StorageAccountType	用於建立數據磁碟或 OS 磁碟的記憶體帳戶類型。
TaskContainerSettings	工作的容器設定。
TaskSchedulingPolicy	指定工作應如何分散到計算節點。
UefiSettings	指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。
UpgradeMode	指定升級至擴展集中虛擬機的模式。 可能的值為： 手動 - 您可以控制擴充集中虛擬機的更新應用程式。 您可以使用 manualUpgrade 動作來執行此動作。 自動 - 擴展集中的所有虛擬機都會同時自動更新。 滾動 - 擴展集會在兩者之間執行選擇性暫停時間的批次更新。
UpgradePolicy	描述升級原則 - 自動、手動或滾動。
UsageStatistics	與集區使用量資訊相關的統計數據。
UserAccount	用來建立用來在 Azure Batch 計算節點上執行工作的用戶的屬性。
UserAssignedIdentity	使用者指派的身分識別
UserIdentity	執行工作的使用者身分識別定義。
VirtualMachineConfiguration	以 Azure 虛擬機器基礎結構為基礎的集區中計算節點的組態。
VMDiskSecurityProfile	指定受控磁碟的安全性配置檔設定。 附注：它只能針對機密 VM 設定，而且在使用機密 VM 時是必要的。
VMExtension	虛擬機延伸模組的組態。
WindowsConfiguration	要套用至虛擬機的 Windows 作業系統設定。
WindowsUserConfiguration	用來在 Windows 計算節點上建立用戶帳戶的屬性。

AllocationState

集區是否重設大小。

名稱	類型	Description
resizing	string	集區正在重設大小;也就是說，正在將計算節點新增至集區或從集區中移除。
steady	string	集區未重設大小。 集區中的計算節點數目沒有變更。 集區會在建立時進入此狀態，且集區上未執行任何作業以變更計算節點的數目。
stopping	string	集區已重設大小，但使用者已要求停止重設大小，但停止要求尚未完成。

ApplicationPackageReference

要部署到計算節點之封裝的參考。

名稱	類型	Description
applicationId	string	要部署之應用程式的標識碼。 建立集區時，套件的應用程式標識碼必須完整 （/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。
version	string	要部署的應用程式版本。 如果省略，則會部署預設版本。 如果在集區上省略此專案，而且此應用程式未指定預設版本，要求會失敗，錯誤碼 InvalidApplicationPackageReferences 和 HTTP 狀態代碼 409。 如果在 Task 上省略此專案，而且此應用程式未指定預設版本，則工作會失敗，並出現前置處理錯誤。

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

名稱	類型	Description
disableAutomaticRollback	boolean	是否應停用OS映像復原功能。
enableAutomaticOSUpgrade	boolean	指出當較新版本的OS映像可用時，是否應該以滾動方式自動套用作業系統升級至擴展集實例。 如果 Windows 集區設為 true，WindowsConfiguration.enableAutomaticUpdates 無法設定為 true。
osRollingUpgradeDeferral	boolean	如果 OS 正在執行工作，請延遲 TVM 上的 OS 升級。
useRollingUpgradePolicy	boolean	指出是否應在自動OS升級期間使用滾動升級原則。 如果未在 VMSS 上定義任何原則，自動 OS 升級將會回復為默認原則。

AutoScaleRun

集區自動調整公式執行的結果和錯誤。

名稱	類型	Description
error	AutoScaleRunError	如果評估失敗，在集區上評估自動調整公式時發生錯誤的詳細數據。
results	string	自動調整公式評估中使用的所有變數最終值。 每個變數值都會以 $variable=value 的形式傳回，而變數會以分號分隔。
timestamp	string	上次評估自動調整公式的時間。

AutoScaleRunError

執行或評估集區自動調整公式時所發生的錯誤。

名稱	類型	Description
code	string	自動調整錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message	string	描述自動調整錯誤的訊息，其適用於在使用者介面中顯示。
values	NameValuePair[]	與自動調整錯誤相關的其他錯誤詳細數據清單。

AutoUserScope

自動用戶的範圍

名稱	類型	Description
pool	string	指定工作會以在集區中的每個計算節點上建立的通用自動使用者帳戶執行。
task	string	指定服務應該為工作建立新的使用者。

AutoUserSpecification

指定在 Batch 服務上執行工作之自動用戶的參數。

名稱	類型	Description
elevationLevel	ElevationLevel	自動使用者的提高許可權層級。 預設值為 nonAdmin。
scope	AutoUserScope	自動用戶的範圍 預設值為集區。 如果集區正在執行 Windows，則當需要更嚴格的工作隔離時，應該指定 Task 的值。 例如，如果工作以可能會影響其他工作的方式變動登錄，或已在集區上指定憑證，而該集區上不應該由一般工作存取，但應該可供 StartTasks 存取。

AzureBlobFileSystemConfiguration

用來使用 Blobfuse 連線到 Azure 記憶體容器的資訊。

名稱	類型	Description
accountKey	string	Azure 記憶體帳戶金鑰。 此屬性與 sasKey 和身分識別互斥;必須只指定一個。
accountName	string	Azure 記憶體帳戶名稱。
blobfuseOptions	string	要傳遞至掛接命令的其他命令行選項。 這些是 Windows 中的「net use」選項，Linux 中的「掛接」選項。
containerName	string	Azure Blob 記憶體容器名稱。
identityReference	ComputeNodeIdentityReference	用來存取 containerName 之使用者指派身分識別的參考 此屬性與 accountKey 和 sasKey 互斥;必須只指定一個。
relativeMountPath	string	要掛接檔系統之計算節點上的相對路徑 所有文件系統都會掛接至 Batch 掛接目錄，可透過 AZ_BATCH_NODE_MOUNTS_DIR 環境變數存取。
sasKey	string	Azure 記憶體 SAS 令牌。 此屬性與 accountKey 和身分識別互斥;必須只指定一個。

AzureFileShareConfiguration

用來連線到 Azure 檔案共享的資訊。

名稱	類型	Description
accountKey	string	Azure 記憶體帳戶金鑰。
accountName	string	Azure 記憶體帳戶名稱。
azureFileUrl	string	Azure 檔案服務 URL。 這是格式為 『https://{account}.file.core.windows.net/』。
mountOptions	string	要傳遞至掛接命令的其他命令行選項。 這些是 Windows 中的「net use」選項，Linux 中的「掛接」選項。
relativeMountPath	string	要掛接檔系統之計算節點上的相對路徑 所有文件系統都會掛接至 Batch 掛接目錄，可透過 AZ_BATCH_NODE_MOUNTS_DIR 環境變數存取。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

BatchPoolIdentity

如果已設定，則為 Batch 集區的身分識別。

名稱	類型	Description
type	PoolIdentityType	如果已設定，則為 Batch 集區的身分識別。 與 Batch 集區相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
userAssignedIdentities	UserAssignedIdentity[]	與 Batch 帳戶相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

CachingType

要針對磁碟啟用的快取類型。

名稱	類型	Description
none	string	磁碟的快取模式未啟用。
readonly	string	磁碟的快取模式是唯讀的。
readwrite	string	磁碟的快取模式是讀取和寫入。

CertificateReference

要安裝在集區中計算節點上之憑證的參考。

名稱	類型	Description
storeLocation	CertificateStoreLocation	要安裝憑證之計算節點上的證書存儲位置。 默認值為 currentuser。 此屬性僅適用於使用 Windows 計算節點設定的集區。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。
storeName	string	要安裝憑證之計算節點上的證書存儲名稱。 此屬性僅適用於使用 Windows 計算節點設定的集區。 常見的存放區名稱包括：My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook，但也可以使用任何自定義存放區名稱。 預設值為 My。
thumbprint	string	憑證的指紋。
thumbprintAlgorithm	string	指紋相關聯的演算法。 這必須是sha1。
visibility	CertificateVisibility[]	計算節點上的哪些用戶帳戶應該可以存取憑證的私用數據。 您可以在此集合中指定多個可見度。 預設值為 [所有帳戶]。

CertificateStoreLocation

要安裝憑證之計算節點上的證書存儲位置。

名稱	類型	Description
currentuser	string	憑證應該安裝到 CurrentUser 證書存儲。
localmachine	string	憑證應該安裝到 LocalMachine 證書存儲。

CertificateVisibility

計算節點上的哪些用戶帳戶應該可以存取憑證的私用數據。

名稱	類型	Description
remoteuser	string	用戶從遠端訪問計算節點的用戶帳戶應該可以看到憑證。
starttask	string	執行 StartTask 的用戶帳戶應該可以看到憑證。 請注意，如果 AutoUser 範圍同時為 StartTask 和 Task 的集區，工作也會看到此憑證。
task	string	執行作業工作的用戶帳戶應該可以看到憑證。

CIFSMountConfiguration

用來連線到 CIFS 檔案系統的資訊。

名稱	類型	Description
mountOptions	string	要傳遞至掛接命令的其他命令行選項。 這些是 Windows 中的「net use」選項，Linux 中的「掛接」選項。
password	string	要用於驗證 CIFS 檔案系統的密碼。
relativeMountPath	string	要掛接檔系統之計算節點上的相對路徑 所有文件系統都會掛接至 Batch 掛接目錄，可透過 AZ_BATCH_NODE_MOUNTS_DIR 環境變數存取。
source	string	要掛接之文件系統的 URI。
username	string	要用於對 CIFS 檔案系統進行驗證的使用者。

CloudPool

Azure Batch 服務中的集區。

名稱	類型	Description
allocationState	AllocationState	集區是否重設大小。
allocationStateTransitionTime	string	集區進入其目前配置狀態的時間。
applicationPackageReferences	ApplicationPackageReference[]	要安裝在集區中每個計算節點上的套件清單。 封裝參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新映射為止。 任何指定的集區上最多有10個套件參考。
autoScaleEvaluationInterval	string	根據自動調整公式自動調整集區大小的時間間隔。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。
autoScaleFormula	string	集區中所需計算節點數目的公式。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。
autoScaleRun	AutoScaleRun	自動調整公式上次執行的結果和錯誤。 只有當集區自動調整時，才會設定此屬性，也就是 enableAutoScale 為 true。
certificateReferences	CertificateReference[]	要安裝在集區中每個計算節點上的憑證清單。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能。
creationTime	string	集區的建立時間。
currentDedicatedNodes	integer	集區中目前專用計算節點的數目。
currentLowPriorityNodes	integer	目前位於集區中的現成/低優先順序計算節點數目。 已先佔的現成/低優先順序計算節點會包含在此計數中。
currentNodeCommunicationMode	NodeCommunicationMode	集區通訊模式的目前狀態。
displayName	string	集區的顯示名稱。 顯示名稱不是唯一的，而且可以包含最大長度為 1024 的任何 Unicode 字元。
eTag	string	集區的 ETag。 這是不透明的字串。 您可以使用它來偵測集區是否已在要求之間變更。 特別是，您可以在更新集區時傳遞ETag，以指定只有當其他人同時沒有修改集區時，您的變更才會生效。
enableAutoScale	boolean	集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 屬性，而且集區會根據公式自動重設大小。 默認值為 false。
enableInterNodeCommunication	boolean	集區是否允許計算節點之間的直接通訊。 這會限制可將計算節點指派給集區的限制。 指定此值可減少集區中要配置之計算節點數目的機率。
id	string	可唯一識別帳戶內集區的字串。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 標識符是區分大小寫和不區分大小寫的（也就是說，您可能不會在帳戶內有兩個標識符，只有大小寫不同）。
identity	BatchPoolIdentity	如果已設定，則為 Batch 集區的身分識別。 與 Batch 集區相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
lastModified	string	集區上次修改的時間。 這是集區層級數據上次變更的時間，例如 targetDedicatedNodes 或 enableAutoscale 設定。 它不會考慮節點層級變更，例如計算節點變更狀態。
metadata	MetadataItem[]	與集區相關聯的名稱/值組清單做為元數據。
mountConfiguration	MountConfiguration[]	要掛接在集區中每個節點上的檔案系統清單。 這支援 Azure 檔案服務、NFS、CIFS/SMB 和 Blobfuse。
networkConfiguration	NetworkConfiguration	集區的網路組態。 集區的網路組態。
resizeErrors	ResizeError[]	執行集區上最後一次重設大小時遇到的錯誤清單。 只有當上次集區重設大小期間發生一或多個錯誤，而且只有在PoolallocationState為穩定時，才會設定此屬性。
resizeTimeout	string	將計算節點配置至集區的逾時。 這是最近重設大小作業的逾時。 （建立集區時的初始重設大小會計算為重設大小。預設值為15分鐘。
resourceTags	object	與集區相關聯的使用者指定標記。 要與 Azure Batch 集區相關聯的使用者定義標籤。 指定時，這些標籤會傳播至與集區相關聯的備份 Azure 資源。 只有在使用 poolAllocationMode 屬性設定為 'UserSubscription' 建立 Batch 帳戶時，才能指定這個屬性。
startTask	StartTask	在聯結集區時，指定要在每個計算節點上執行的工作。 批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時，包括 （但不限於） 。 由於復原作業的重試與 無關，而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0，由於復原作業，可能會發生內部重試。 因此，所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動，而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 在某些情況下，即使計算節點未重新啟動，StartTask 仍可能會重新執行。 請特別小心，以避免 StartTasks 從 StartTask 工作目錄建立中斷程式或安裝/啟動服務，因為這樣會阻止 Batch 重新執行 StartTask。
state	PoolState	集區的目前狀態。
stateTransitionTime	string	集區進入其目前狀態的時間。
stats	PoolStatistics	集區整個存留期的使用率和資源使用量統計數據。 只有當 CloudPool 擷取到包含 『stats』 屬性的 expand 子句時，才會填入此屬性;否則為 null。 統計數據可能無法立即取得。 Batch 服務會定期匯總統計數據。 一般延遲約30分鐘。
targetDedicatedNodes	integer	集區中所需的專用計算節點數目。
targetLowPriorityNodes	integer	集區中所需的現成/低優先順序計算節點數目。
targetNodeCommunicationMode	NodeCommunicationMode	集區所需的節點通訊模式。 如果省略，預設值為 Default。
taskSchedulingPolicy	TaskSchedulingPolicy	工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。
taskSlotsPerNode	integer	可用來在集區中單一計算節點上執行並行工作的工作位置數目。 預設值為 1。 最大值是集區 vmSize 或 256 核心數目的 4 倍小。
upgradePolicy	UpgradePolicy	集區的升級原則。 描述升級原則 - 自動、手動或滾動。
url	string	集區的 URL。
userAccounts	UserAccount[]	要建立於集區中每個計算節點上的用戶帳戶清單。
virtualMachineConfiguration	VirtualMachineConfiguration	集區的虛擬機組態。 必須指定這個屬性。
vmSize	string	集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 如需集區中虛擬機可用大小的相關信息，請參閱在 Azure Batch 集區中為計算節點選擇 VM 大小（https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes）。

CloudPoolListResult

列出帳戶中集區的結果。

名稱	類型	Description
odata.nextLink	string	要取得下一組結果的URL。
value	CloudPool[]	集區清單。

ComputeNodeFillType

工作如何分散到集區中的計算節點。

名稱	類型	Description
pack	string	在將任何工作指派給集區中的下一個計算節點之前，應該將盡可能多的工作指派給集區中的每個計算節點（taskSlotsPerNode）。
spread	string	工作應該平均指派給集區中的所有計算節點。

ComputeNodeIdentityReference

與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。

名稱	類型	Description
resourceId	string	使用者指派身分識別的 ARM 資源識別碼。

ContainerConfiguration

容器啟用集區的組態。

名稱	類型	Description
containerImageNames	string[]	容器映像名稱的集合。 這是完整的映像參考，如同指定為 “docker pull”。 除非映像具有替代登錄的完整映射，否則映像會從預設 Docker 登錄進行來源。
containerRegistries	ContainerRegistry[]	可從中提取容器的其他私人登錄。 如果必須從需要認證的私人登錄下載任何映像，則必須在這裡提供這些認證。
type	ContainerType	要使用的容器技術。

ContainerHostBatchBindMountEntry

您想要掛接至工作容器的路徑和掛接模式專案。

名稱	類型	Description
isReadOnly	boolean	將此來源路徑掛接為唯讀模式或否。 默認值為 false （讀取/寫入模式）。 針對 Linux，如果您將此路徑掛接為讀取/寫入模式，這並不表示容器中的所有使用者都有路徑的讀取/寫入存取權，這取決於主機 VM 中的存取權。 如果此路徑是只讀掛接，容器內的所有使用者將無法修改路徑。
source	ContainerHostDataPath	掛接至容器客戶的路徑可以選取。

ContainerHostDataPath

要掛接至容器工作容器的路徑。

名稱	類型	Description
Applications	string	應用程式路徑。
JobPrep	string	作業準備工作路徑。
Shared	string	要共用其檔案之多重實例工作的路徑。
Startup	string	開始工作的路徑。
Task	string	工作路徑。
VfsMounts	string	路徑包含此節點上掛接的所有虛擬檔案系統。

ContainerRegistry

私人容器登錄。

名稱	類型	Description
identityReference	ComputeNodeIdentityReference	使用者指派身分識別的參考，用來存取 Azure Container Registry，而不是使用者名稱和密碼。 與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。
password	string	登入登錄伺服器的密碼。
registryServer	string	登錄 URL。 如果省略，預設值為 「docker.io」。。
username	string	要登入登錄伺服器的用戶名稱。

ContainerType

要使用的容器技術。

名稱	類型	Description
criCompatible	string	CRI 型技術將用來啟動容器。
dockerCompatible	string	Docker 相容容器技術將用來啟動容器。

ContainerWorkingDirectory

容器工作工作目錄的位置。

名稱	類型	Description
containerImageDefault	string	使用容器映像中定義的工作目錄。 請注意，此目錄不會包含 Batch 下載的資源檔。
taskWorkingDirectory	string	使用標準 Batch 服務工作工作目錄，其中包含 Batch 填入的工作資源檔。

DataDisk

集區中與計算節點相關聯的數據磁碟將使用的設定。 使用連結的數據磁碟時，您必須從 VM 內掛接和格式化磁碟，才能使用這些磁碟。

名稱	類型	Description
caching	CachingType	要針對數據磁碟啟用的快取類型。 快取的預設值為 readwrite。 如需快取選項的相關信息，請參閱：https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/。
diskSizeGB	integer	以 GB 為單位的初始磁碟大小。
lun	integer	邏輯單元編號。 lun 可用來唯一識別每個數據磁碟。 如果連結多個磁碟，則每個磁碟都應該有相異的 Lun。 值必須介於 0 到 63 之間，且包含 。
storageAccountType	StorageAccountType	要用於數據磁碟的記憶體帳戶類型。 如果省略，預設值為 「standard_lrs」。。

DiffDiskPlacement

指定集區中所有計算節點 （VM） 操作系統磁碟的暫時磁碟位置。

名稱	類型	Description
CacheDisk	string	暫時OS磁碟會儲存在VM快取上。

DiffDiskSettings

指定計算節點 （VM） 所使用作業系統磁碟的暫時磁碟設定。

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

DiskEncryptionConfiguration

在集區中的計算節點上套用的磁碟加密組態。 使用 Azure 計算資源庫映像建立的 Linux 集區不支援磁碟加密設定。

名稱	類型	Description
targets	DiskEncryptionTarget[]	磁碟目標 Batch 服務的清單會在計算節點上加密。 磁碟目標 Batch 服務的清單會在計算節點上加密。

DiskEncryptionTarget

磁碟目標 Batch 服務的清單會在計算節點上加密。

名稱	類型	Description
osdisk	string	計算節點上的OS磁碟會加密。
temporarydisk	string	計算節點上的暫存磁碟會加密。 在 Linux 上，此加密適用於在開機時間進行加密時的其他分割區（例如掛接的數據磁碟上的磁碟分區）。

DynamicVNetAssignmentScope

動態 vnet 指派的範圍。

名稱	類型	Description
job	string	動態 VNet 指派是個別作業完成。
none	string	未啟用動態 VNet 指派。

ElevationLevel

使用者的提高許可權層級。

名稱	類型	Description
admin	string	使用者是具有較高存取權的使用者，且會以完整的系統管理員許可權運作。
nonadmin	string	使用者是標準使用者，沒有提升許可權的存取權。

EnvironmentSetting

要設定於工作進程的環境變數。

名稱	類型	Description
name	string	環境變數的名稱。
value	string	環境變數的值。

ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。

ImageReference

Azure 虛擬機 Marketplace 映像或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 映像參考清單，請參閱「列出支援的映像」作業。

名稱	類型	Description
communityGalleryImageId	string	社群資源庫映像唯一標識符 這個屬性與其他屬性互斥，而且可以從社群資源庫映像 GET 呼叫擷取。
exactVersion	string	用來建立節點之平臺映像或市集映像的特定版本。 只有當建立集區時為 'version' 指定的值是 'latest' 時，這個只讀字段才會與 'version' 不同。
offer	string	Azure 虛擬機 Marketplace 映像的供應項目類型。 例如，UbuntuServer 或 WindowsServer。
publisher	string	Azure 虛擬機 Marketplace 映像的發行者。 例如，Canonical 或 MicrosoftWindowsServer。
sharedGalleryImageId	string	共用資源庫映像唯一標識碼 這個屬性與其他屬性互斥，而且可以從共用資源庫映像 GET 呼叫擷取。
sku	string	Azure 虛擬機 Marketplace 映像的 SKU。 例如，18.04-LTS 或 2019-Datacenter。
version	string	Azure 虛擬機 Marketplace 映像的版本。 您可以指定 'latest' 的值來選取最新版的映像。 如果省略，預設值為 'latest'。
virtualMachineImageId	string	Azure 計算資源庫映射的 ARM 資源識別碼。 將會使用此映像標識碼來建立集區中的計算節點。這是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 的格式 或 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} ，一律預設為最新的映射版本。 這個屬性與其他 ImageReference 屬性互斥。 Azure 計算資源庫映像必須有相同區域中的複本，且必須與 Azure Batch 帳戶位於相同的訂用帳戶中。 如果未在 imageId 中指定映像版本，則會使用最新版本。 如需 Batch 計算節點代理程式與 Batch 服務通訊之防火牆設定的相關信息，請參閱 https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration。

InboundEndpointProtocol

端點的通訊協定。

名稱	類型	Description
tcp	string	針對端點使用 TCP。
udp	string	針對端點使用UDP。

InboundNATPool

輸入 NAT 集區，可用來在外部處理 Batch 集區中計算節點上的特定埠。

名稱	類型	Description
backendPort	integer	計算節點上的埠號碼。 這在 Batch 集區內必須是唯一的。 可接受的值介於 1 到 65535 之間，但 29876 和 29877 除外，因為這些值是保留的。 如果提供任何保留值，要求就會失敗，且 HTTP 狀態代碼為 400。
frontendPortRangeEnd	integer	外部埠範圍中的最後一個埠號碼，用來提供個別計算節點上 backendPort 的輸入存取權。 可接受的值範圍介於 1 到 65534 之間，但 Batch 服務保留的埠從 50000 到 55000。 集區內的所有範圍都必須相異且無法重疊。 每個範圍至少必須包含 40 個埠。 如果提供任何保留或重疊的值，要求就會失敗，且 HTTP 狀態代碼為 400。
frontendPortRangeStart	integer	外部埠範圍中的第一個埠號碼，將用來提供個別計算節點上 backendPort 的輸入存取。 可接受的值範圍介於 1 到 65534 之間，但保留的埠介於 50000 到 55000 之間。 集區內的所有範圍都必須相異且無法重疊。 每個範圍至少必須包含 40 個埠。 如果提供任何保留或重疊的值，要求就會失敗，且 HTTP 狀態代碼為 400。
name	string	端點的名稱。 名稱在 Batch 集區內必須是唯一的，可以包含字母、數位、底線、句號和連字元。 名稱必須以字母或數字開頭，結尾必須是字母、數位或底線，且不能超過 77 個字元。 如果提供任何無效的值，要求就會失敗，且 HTTP 狀態代碼為 400。
networkSecurityGroupRules	NetworkSecurityGroupRule[]	將套用至端點的網路安全組規則清單。 批次集區上所有端點可指定的最大規則數目為 25。 如果未指定網路安全組規則，則會建立默認規則以允許輸入存取指定的 backendPort。 如果超過網路安全組規則的最大數目，要求會失敗，並出現 HTTP 狀態代碼 400。
protocol	InboundEndpointProtocol	端點的通訊協定。

IPAddressProvisioningType

集區公用IP位址的布建類型。

名稱	類型	Description
batchmanaged	string	公用IP將由 Batch 建立和管理。 視集區的大小而定，可能會有多個公用IP。
nopublicipaddresses	string	將不會建立公用IP位址。
usermanaged	string	公用IP是由使用者提供，並且將用來布建計算節點。

LinuxUserConfiguration

用來在 Linux 計算節點上建立使用者帳戶的屬性。

名稱	類型	Description
gid	integer	用戶帳戶的群組標識碼。 uid 和 gid 屬性必須一起指定或完全不指定。 如果未指定，則基礎操作系統會挑選 gid。
sshPrivateKey	string	用戶帳戶的 SSH 私鑰。 私鑰不得受到密碼保護。 當集區的 enableInterNodeCommunication 屬性為 true 時，私鑰用於在 Linux 集區中計算節點之間自動設定非對稱密鑰型驗證（如果 enableInterNodeCommunication 為 false，則會忽略它）。 其方式是將金鑰組放入使用者的 .ssh 目錄中。 如果未指定，則計算節點之間不會設定無密碼 SSH（不會修改使用者的 .ssh 目錄）。
uid	integer	用戶帳戶的使用者標識碼。 uid 和 gid 屬性必須一起指定或完全不指定。 如果未指定基礎操作系統，則會挑選 uid。

LoginMode

使用者的登入模式

名稱	類型	Description
batch	string	LOGON32_LOGON_BATCH Win32 登入模式。 建議針對長時間執行的平行進程使用批次登入模式。
interactive	string	LOGON32_LOGON_INTERACTIVE Win32 登入模式。 UAC 會在 Windows 集區上啟用。 如果此選項與 Windows 集區中提升許可權的使用者身分識別搭配使用，除非 Task 命令行所執行的應用程式設定為一律需要系統管理許可權，否則使用者會話將不會提升。

ManagedDisk

名稱	類型	Description
securityProfile	VMDiskSecurityProfile	指定受控磁碟的安全性配置檔設定。 指定受控磁碟的安全性配置檔設定。 附注：它只能針對機密 VM 設定，而且在使用機密 VM 時是必要的。
storageAccountType	StorageAccountType	受控磁碟的記憶體帳戶類型。

MetadataItem

與 Batch 服務資源相關聯的名稱/值組。

名稱	類型	Description
name	string	元數據項目的名稱。
value	string	元數據專案的值。

MountConfiguration

要掛接在每個節點上的文件系統。

名稱	類型	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	在每個節點上使用 Blob FUSE 掛接的 Azure 記憶體容器。 這個屬性與其他所有屬性互斥。
azureFileShareConfiguration	AzureFileShareConfiguration	要掛接在每個節點上的 Azure 檔案共用。 這個屬性與其他所有屬性互斥。
cifsMountConfiguration	CIFSMountConfiguration	要掛接在每個節點上的 CIFS/SMB 文件系統。 這個屬性與其他所有屬性互斥。
nfsMountConfiguration	NFSMountConfiguration	要掛接在每個節點上的NFS文件系統。 這個屬性與其他所有屬性互斥。

NameValuePair

表示名稱/值組。

名稱	類型	Description
name	string	name-value 配對中的名稱。
value	string	名稱/值組中的值。

NetworkConfiguration

集區的網路組態。

名稱	類型	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	動態 vnet 指派的範圍。
enableAcceleratedNetworking	boolean	此集區是否應該啟用加速網路。 加速網路可讓單一根 I/O 虛擬化（SR-IOV）連線到 VM，這可能會導致改善網路效能。 如需詳細資訊，請參閱：https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview。
endpointConfiguration	PoolEndpointConfiguration	Batch 集區中計算節點上端點的組態。
publicIPAddressConfiguration	PublicIPAddressConfiguration	Batch 集區中計算節點的公用IPAddress組態。 集區網路設定的公用IP位址組態。
subnetId	string	將聯結集區計算節點之虛擬網路子網的 ARM 資源識別碼。 這是 /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}的格式。 虛擬網路必須位於與 Azure Batch 帳戶相同的區域和訂用帳戶中。 指定的子網應該有足夠的可用IP位址，以容納集區中的計算節點數目。 如果子網沒有足夠的可用IP位址，集區會部分配置節點，而且會發生重設大小錯誤。 'MicrosoftAzureBatch' 服務主體必須具有指定 VNet 的「傳統虛擬機參與者」Role-Based 訪問控制 （RBAC） 角色。 指定的子網必須允許來自 Azure Batch 服務的通訊，才能排程節點上的工作。 藉由檢查指定的 VNet 是否有任何相關聯的網路安全組 （NSG），即可驗證此情況。 如果 NSG 拒絕與指定子網中的節點通訊，Batch 服務會將計算節點的狀態設定為無法使用。 僅支援ARM虛擬網路 （'Microsoft.Network/virtualNetworks'）。 如果指定的 VNet 具有任何相關聯的網路安全組 （NSG），則必須啟用一些保留的系統埠以進行輸入通訊，包括埠 29876 和 29877。 同時在埠 443 上啟用對 Azure 記憶體的輸出連線。 如需詳細資訊，請參閱：https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

要套用至輸入端點的網路安全組規則。

名稱	類型	Description
access	NetworkSecurityGroupRuleAccess	應該針對指定的IP位址、子網範圍或卷標採取的動作。
priority	integer	此規則的優先順序。 集區內的優先順序必須是唯一的，且會依優先順序進行評估。 數位越低，優先順序越高。 例如，可以使用訂單號碼 150、250 和 350 來指定規則。 順序編號為 150 的規則優先於順序為 250 的規則。 允許的優先順序為 150 到 4096。 如果提供任何保留或重複的值，要求就會失敗，且 HTTP 狀態代碼為 400。
sourceAddressPrefix	string	要符合規則的來源位址前置詞或標籤。 有效值為單一IP位址（例如10.10.10.10.10）、IP子網（例如192.168.1.0/24）、預設標記或 * （適用於所有位址）。 如果提供任何其他值，要求就會因為 HTTP 狀態代碼 400 而失敗。
sourcePortRanges	string[]	要與規則相符的來源埠範圍。 有效值為 『』（針對所有埠 0 - 65535）、特定埠（即 22），或埠範圍（即 100-200）。埠的範圍必須是 0 到 65535。此集合中的每個專案不得重疊任何其他專案（範圍或個別埠）。如果提供任何其他值，要求就會因為 HTTP 狀態代碼 400 而失敗。預設值為 ''。

NetworkSecurityGroupRuleAccess

應該針對指定的IP位址、子網範圍或卷標採取的動作。

名稱	類型	Description
allow	string	允許存取。
deny	string	拒絕存取。

NFSMountConfiguration

用來連線到 NFS 檔案系統的資訊。

名稱	類型	Description
mountOptions	string	要傳遞至掛接命令的其他命令行選項。 這些是 Windows 中的「net use」選項，Linux 中的「掛接」選項。
relativeMountPath	string	要掛接檔系統之計算節點上的相對路徑 所有文件系統都會掛接至 Batch 掛接目錄，可透過 AZ_BATCH_NODE_MOUNTS_DIR 環境變數存取。
source	string	要掛接之文件系統的 URI。

NodeCommunicationMode

決定集區如何與 Batch 服務通訊。

名稱	類型	Description
classic	string	使用傳統通訊模式的節點需要來自 「BatchNodeManagement」 埠 29876 和 29877 上的輸入 TCP 通訊。{region}“ 服務卷標和埠 443 上的輸出 TCP 通訊至 ”Storage.region“ 和 ”BatchNodeManagement“。{region}“ 服務標籤。
default	string	節點通訊模式會自動由 Batch 服務設定。
simplified	string	使用簡化通訊模式的節點需要埠 443 上的輸出 TCP 通訊至 “BatchNodeManagement”。{region}“ 服務標籤。 不需要開啟的輸入埠。

NodePlacementConfiguration

集區的節點放置組態。

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

NodePlacementPolicyType

配置集區中節點的放置原則。

名稱	類型	Description
regional	string	集區中的所有節點都會配置在同一個區域中。
zonal	string	集區中的節點將會分散到不同的可用性區域，並盡最大努力平衡。

OSDisk

計算節點之作業系統磁碟的設定（VM）。

名稱	類型	Description
caching	CachingType	指定快取需求。 可能的值為：None、ReadOnly、ReadWrite。 預設值為：標準記憶體的 [無]。 進階記憶體的 ReadOnly。 快取的預設值為 none。 如需快取選項的相關信息，請參閱：https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/。
diskSizeGB	integer	建立新的 OS 磁碟時，以 GB 為單位的初始磁碟大小。
ephemeralOSDiskSettings	DiffDiskSettings	指定計算節點 （VM） 所使用作業系統磁碟的暫時磁碟設定。
managedDisk	ManagedDisk	受控磁碟參數。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

PoolEndpointConfiguration

集區的端點組態。

名稱	類型	Description
inboundNATPools	InboundNATPool[]	輸入 NAT 集區清單，可用來在外部處理個別計算節點上的特定埠。 每個批次集區的輸入NAT集區數目上限為5。 如果超過輸入 NAT 集區的最大數目，要求會失敗，並出現 HTTP 狀態代碼 400。 如果 IPAddressProvisioningType 為 NoPublicIPAddresses，則無法指定此專案。

PoolIdentityType

如果已設定，則為 Batch 集區的身分識別。

名稱	類型	Description
None	string	Batch 集區沒有與其相關聯的身分識別。 在更新集區中設定 None 將會移除現有的身分識別。
UserAssigned	string	Batch 集區具有使用者指派的身分識別。

PoolState

集區的目前狀態。

名稱	類型	Description
active	string	集區可供執行工作，但受限於計算節點的可用性。
deleting	string	使用者已要求刪除集區，但刪除作業尚未完成。

PoolStatistics

包含集區存留期的使用率和資源使用量統計數據。

名稱	類型	Description
lastUpdateTime	string	上次更新統計數據的時間。 所有統計數據都受限於 startTime 與 lastUpdateTime 之間的範圍。
resourceStats	ResourceStatistics	集區中計算節點的資源耗用量相關統計數據。
startTime	string	統計數據所涵蓋之時間範圍的開始時間。
url	string	統計數據的 URL。
usageStats	UsageStatistics	與集區使用量相關的統計數據，例如所使用的核心時間量。

PublicIPAddressConfiguration

集區網路設定的公用IP位址組態。

名稱	類型	Description
ipAddressIds	string[]	布建計算節點時，Batch 服務將使用的公用IP清單。 此處指定的IP數目會限制集區大小上限 - 100個專用節點或100個現成/低優先順序節點，可以為每個公用IP配置。 例如，需要 250 個專用 VM 的集區至少需要 3 個公用 IP。 此集合的每個元素都是下列形式：/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}。
provision	IPAddressProvisioningType	集區公用IP位址的布建類型。 預設值為 BatchManaged。

ResizeError

重設集區大小時發生的錯誤。

名稱	類型	Description
code	string	集區重設大小錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message	string	描述集區重設大小錯誤的訊息，其適用於在使用者介面中顯示。
values	NameValuePair[]	與集區重設大小錯誤相關的其他錯誤詳細數據清單。

ResourceFile

要下載至計算節點的單一檔案或多個檔案。

名稱	類型	Description
autoStorageContainerName	string	自動記憶體帳戶中的記憶體容器名稱。 autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，其中一個必須指定。
blobPrefix	string	從 Azure 記憶體容器下載 Blob 時要使用的 Blob 前置詞。 只會下載名稱開頭為指定前置詞的 Blob。 只有在使用 autoStorageContainerName 或 storageContainerUrl 時，屬性才有效。 此前置詞可以是部分檔名或子目錄。 如果未指定前置詞，則會下載容器中的所有檔案。
fileMode	string	以八進位格式的檔案許可權模式屬性。 此屬性僅適用於下載至 Linux 計算節點的檔案。 如果針對將下載至 Windows 計算節點的 resourceFile 指定，則會忽略它。 如果未為 Linux 計算節點指定這個屬性，則會將預設值 0770 套用至檔案。
filePath	string	要下載檔案的計算節點位置，相對於工作的工作目錄。 如果指定 HTTPUrl 屬性，則需要 filePath，並描述將下載檔案的路徑，包括檔名。 否則，如果指定 autoStorageContainerName 或 storageContainerUrl 屬性，則 filePath 是選擇性的，而且是要下載檔案的目錄。 在 filePath 當做目錄使用的情況下，任何已經與輸入數據相關聯的目錄結構都會完整保留，並附加至指定的 filePath 目錄。 指定的相對路徑無法脫離 Task 的工作目錄（例如，使用 '..'）。
httpUrl	string	要下載之檔案的 URL。 autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，其中一個必須指定。 如果 URL 指向 Azure Blob 記憶體，則必須從計算節點讀取它。 在 Azure 記憶體中取得 Blob 的這類 URL 有三種方式：包括授與 Blob 讀取許可權的共用存取簽章（SAS），使用具有讀取許可權的受控識別，或設定 Blob 或其容器的 ACL 以允許公用存取。
identityReference	ComputeNodeIdentityReference	使用者指派身分識別的參考，用來存取 storageContainerUrl 或 HTTPUrl 所指定的 Azure Blob 記憶體 與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。
storageContainerUrl	string	Azure Blob 記憶體中 Blob 容器的 URL。 autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，其中一個必須指定。 此 URL 必須可從計算節點讀取和列出。 有三種方式可以取得 Azure 記憶體中容器的這類 URL：包括授與容器讀取和清單許可權的共用存取簽章（SAS），使用具有讀取和清單許可權的受控識別，或為容器設定 ACL 以允許公用存取。

ResourceStatistics

集區中計算節點的資源耗用量相關統計數據。

名稱	類型	Description
avgCPUPercentage	number	集區中所有計算節點的平均CPU使用量（每個節點的百分比）。
avgDiskGiB	number	集區中所有計算節點中 GiB 的平均已使用磁碟空間。
avgMemoryGiB	number	集區中所有計算節點的 GiB 平均記憶體使用量。
diskReadGiB	number	在集區中所有計算節點的 GiB 磁碟中讀取的總數據量。
diskReadIOps	integer	集區中所有計算節點的磁碟讀取作業總數。
diskWriteGiB	number	集區中所有計算節點的 GiB 寫入數據總量。
diskWriteIOps	integer	集區中所有計算節點的磁碟寫入作業總數。
lastUpdateTime	string	上次更新統計數據的時間。 所有統計數據都受限於 startTime 與 lastUpdateTime 之間的範圍。
networkReadGiB	number	在集區中的所有計算節點中，網路 GiB 中讀取的總數據量。
networkWriteGiB	number	在集區中所有計算節點的 GiB 中寫入的總數據量。
peakDiskGiB	number	集區中所有計算節點中 GiB 的尖峰已使用磁碟空間。
peakMemoryGiB	number	集區中所有計算節點的 GiB 尖峰記憶體使用量。
startTime	string	統計數據所涵蓋之時間範圍的開始時間。

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

名稱	類型	Description
enableCrossZoneUpgrade	boolean	允許 VMSS 在建構升級批次時忽略 AZ 界限。 將 Update 網域和 maxBatchInstancePercent 納入考慮，以判斷批次大小。 只有當使用 NodePlacementConfiguration 作為 Zonal 時，此欄位才能設定為 true 或 false。
maxBatchInstancePercent	integer	一個批次中滾動升級同時升級的虛擬機實例總數上限百分比。 由於這是最大值，先前或未來批次中狀況不良的實例可能會導致批次中的實例百分比降低，以確保更高的可靠性。 此欄位的值應介於 5 到 100 之間，包含。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都指派值，maxBatchInstancePercent 的值不應該超過 maxUnhealthyInstancePercent。
maxUnhealthyInstancePercent	integer	擴展集中可同時狀況不良的虛擬機實例總數百分比上限，可能是因為升級而造成狀況不良，或在滾動升級中止之前，在虛擬機健康情況檢查中發現狀況不良狀態。 啟動任何批次之前，會先檢查此條件約束。 此欄位的值應介於 5 到 100 之間，包含。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都指派值，maxBatchInstancePercent 的值不應該超過 maxUnhealthyInstancePercent。
maxUnhealthyUpgradedInstancePercent	integer	可發現處於狀況不良狀態的已升級虛擬機實例百分比上限。 升級每個批次之後，就會進行這項檢查。 如果超過這個百分比，滾動更新就會中止。 此欄位的值應介於 0 到 100 之間，並包含。
pauseTimeBetweenBatches	string	完成一個批次中所有虛擬機的更新，以及開始下一個批次之間的等候時間。 持續時間應以 ISO 8601 格式指定。
prioritizeUnhealthyInstances	boolean	在任何狀況良好的實例之前，升級擴展集中所有狀況不良的實例。
rollbackFailedInstancesOnPolicyBreach	boolean	如果違反滾動升級原則，回復實例至先前的模型。

SecurityEncryptionTypes

指定受控磁碟的 EncryptionType。 它設定為 VMGuestStateOnly，以便只加密 VMGuestState Blob，而 NonPersistedTPM 則不會保存 VMGuestState Blob 中的韌體狀態。 附注：它只能設定為機密 VM，而且在使用機密 VM 時為必要專案。

名稱	類型	Description
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

指定虛擬機或虛擬機擴展集的安全性配置檔設定。

名稱	類型	Description
encryptionAtHost	boolean	用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。 如需主機需求加密的詳細資訊，請參閱 https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes。
securityType	SecurityTypes	指定虛擬機的 SecurityType。 它必須設定為任何指定的值，才能啟用 UefiSettings。
uefiSettings	UefiSettings	指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。

SecurityTypes

指定虛擬機的 SecurityType。 它必須設定為任何指定的值，才能啟用 UefiSettings。

名稱	類型	Description
confidentialVM	string	Azure 機密運算提供機密 VM 適用於具有高安全性和機密性需求的租使用者。 這些 VM 提供強式硬體強制執行的界限，以協助符合您的安全性需求。 您可以使用機密 VM 進行移轉，而不需要變更程式代碼，而平臺可保護 VM 的狀態不受讀取或修改。
trustedLaunch	string	受信任的啟動可防範進階和持續性的攻擊技術。

ServiceArtifactReference

指定使用 'latest' 映射版本時，用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。

名稱	類型	Description
id	string	ServiceArtifactReference 的服務成品參考標識符 服務成品參考標識符的格式為 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

當節點加入 Azure Batch 服務中的集區，或計算節點重新啟動或重新映像時執行的工作。

名稱	類型	Description
commandLine	string	StartTask 的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand”，或在 Linux 中使用 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對路徑（相對於Task工作目錄），或使用 Batch 提供的環境變數 （https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables）。
containerSettings	TaskContainerSettings	StartTask 執行所在的容器設定。 指定此專案時，AZ_BATCH_NODE_ROOT_DIR下方的所有目錄都會遞歸地對應到容器中（節點上的 Azure Batch 目錄根目錄），所有工作環境變數都會對應到容器中，而工作命令行則會在容器中執行。 AZ_BATCH_NODE_ROOT_DIR外部容器中產生的檔案可能不會反映到主機磁碟，這表示 Batch 檔案 API 將無法存取這些檔案。
environmentSettings	EnvironmentSetting[]	StartTask 的環境變數設定清單。
maxTaskRetryCount	integer	重試工作的最大次數。 如果 Batch 服務結束代碼為非零，則會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。 如果重試計數上限為0，Batch服務就不會重試工作。 如果重試計數上限為 -1，Batch 服務會不限制地重試工作，但不建議用於啟動工作或任何工作。 預設值為 0（沒有重試）。
resourceFiles	ResourceFile[]	Batch 服務在執行命令行之前，會先下載至計算節點的檔案清單。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。 此元素底下列出的檔案位於工作的工作目錄中。
userIdentity	UserIdentity	StartTask 執行的使用者身分識別。 如果省略，工作會以工作唯一的非系統管理使用者身分執行。
waitForSuccess	boolean	在排程計算節點上的任何工作之前，Batch 服務是否應該等候 StartTask 順利完成（也就是結束代碼 0）。 如果 True 且 StartTask 在節點上失敗，Batch 服務會重試 StartTask，最多重試計數上限 （maxTaskRetryCount）。 如果工作在所有重試之後仍未順利完成，則 Batch 服務會將節點標示為無法使用，且不會排程工作。 您可以透過計算節點狀態和失敗資訊詳細資料來偵測此狀況。 如果為 false，Batch 服務將不會等候 StartTask 完成。 在此情況下，當 StartTask 仍在執行時，其他工作可以在計算節點上開始執行;即使 StartTask 失敗，新的工作仍會繼續排程在計算節點上。 默認值為 true。

StorageAccountType

用於建立數據磁碟或 OS 磁碟的記憶體帳戶類型。

名稱	類型	Description
premium_lrs	string	數據磁碟/OS 磁碟應使用進階本地備援記憶體。
standard_lrs	string	數據磁碟/OS 磁碟應使用標準本地備援記憶體。
standardssd_lrs	string	數據磁碟/OS 磁碟應使用標準 SSD 本地備援記憶體。

TaskContainerSettings

工作的容器設定。

名稱	類型	Description
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	您要掛接至容器工作的路徑。 如果此陣列為 Null 或不存在，容器工作將會在 Windows 中掛接整個暫存磁碟驅動器（或 Linux 中的AZ_BATCH_NODE_ROOT_DIR）。 如果此陣列設定為空白，它就不會將任何數據路徑掛接至容器。
containerRunOptions	string	容器 create 命令的其他選項。 除了 Batch 服務所控制的自變數之外，這些額外的選項也會提供為 「docker create」 命令的自變數。
imageName	string	用來建立要在其中執行工作之容器的映像。 這是完整的映像參考，如同指定為 “docker pull”。 如果未提供任何標記做為 Image 名稱的一部分，則會使用標記 「：latest」 做為預設值。
registry	ContainerRegistry	包含容器映像的私人登錄。 如果已在建立集區時提供，則可以省略此設定。
workingDirectory	ContainerWorkingDirectory	容器工作工作目錄的位置。 默認值為 『taskWorkingDirectory』。

TaskSchedulingPolicy

指定工作應如何分散到計算節點。

名稱	類型	Description
nodeFillType	ComputeNodeFillType	工作如何分散到集區中的計算節點。 如果未指定，則會散佈預設值。

UefiSettings

指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。

名稱	類型	Description
secureBootEnabled	boolean	指定是否應在虛擬機上啟用安全開機。
vTpmEnabled	boolean	指定是否應在虛擬機上啟用 vTPM。

UpgradeMode

指定升級至擴展集中虛擬機的模式。

可能的值為：

手動 - 您可以控制擴充集中虛擬機的更新應用程式。 您可以使用 manualUpgrade 動作來執行此動作。

自動 - 擴展集中的所有虛擬機都會同時自動更新。

滾動 - 擴展集會在兩者之間執行選擇性暫停時間的批次更新。

名稱	類型	Description
automatic	string	擴展集中的所有虛擬機都會同時自動更新。
manual	string	您可以控制擴展集中虛擬機更新的應用程式。 您可以使用 manualUpgrade 動作來執行此動作。
rolling	string	擴展集中的現有實例會在要升級的批次中關閉。 升級的批次完成後，實例會再次開始取得流量，下一個批次將會開始。 這會繼續執行，直到所有實例都 up-to-date 為止。

UpgradePolicy

描述升級原則 - 自動、手動或滾動。

名稱	類型	Description
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	用於執行自動OS升級的組態參數。 用於執行自動OS升級的組態參數。
mode	UpgradeMode	指定升級至擴展集中虛擬機的模式。 可能的值為： 手動 - 您可以控制擴充集中虛擬機的更新應用程式。 您可以使用 manualUpgrade 動作來執行此動作。 自動 - 擴展集中的所有虛擬機都會同時自動更新。 滾動 - 擴展集會在兩者之間執行選擇性暫停時間的批次更新。
rollingUpgradePolicy	RollingUpgradePolicy	執行滾動升級時所使用的組態參數。 執行滾動升級時所使用的組態參數。

UsageStatistics

與集區使用量資訊相關的統計數據。

名稱	類型	Description
dedicatedCoreTime	string	專用計算節點核心的匯總時鐘時間是集區一部分。
lastUpdateTime	string	上次更新統計數據的時間。 所有統計數據都受限於 startTime 與 lastUpdateTime 之間的範圍。
startTime	string	統計數據所涵蓋之時間範圍的開始時間。

UserAccount

用來建立用來在 Azure Batch 計算節點上執行工作的用戶的屬性。

名稱	類型	Description
elevationLevel	ElevationLevel	用戶帳戶的提高許可權層級。 預設值為 nonAdmin。
linuxUserConfiguration	LinuxUserConfiguration	用戶帳戶的 Linux 特定用戶設定。 如果在 Windows 集區上指定，則會忽略這個屬性。 如果未指定，則會使用預設選項建立使用者。
name	string	用戶帳戶的名稱。 名稱可以包含最多 20 個字元的任何 Unicode 字元。
password	string	用戶帳戶的密碼。
windowsUserConfiguration	WindowsUserConfiguration	用戶帳戶的 Windows 特定用戶設定。 只有在用戶位於 Windows 集區時，才能指定這個屬性。 如果未指定且在 Windows 集區上，則會使用預設選項建立使用者。

UserAssignedIdentity

使用者指派的身分識別

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。
resourceId	string	使用者指派身分識別的 ARM 資源識別碼

UserIdentity

執行工作的使用者身分識別定義。

名稱	類型	Description
autoUser	AutoUserSpecification	工作執行所在的自動使用者。 userName 和 autoUser 屬性互斥;您必須指定一個，但不能同時指定兩者。
username	string	執行工作的使用者身分識別名稱。 userName 和 autoUser 屬性互斥;您必須指定一個，但不能同時指定兩者。

VirtualMachineConfiguration

以 Azure 虛擬機器基礎結構為基礎的集區中計算節點的組態。

名稱	類型	Description
containerConfiguration	ContainerConfiguration	集區的容器組態。 如果指定，會在集區中的每個計算節點上執行安裝程式，以允許工作在容器中執行。 此集區上執行的所有一般工作和作業管理員工作都必須指定 containerSettings 屬性，而所有其他工作都可以指定它。
dataDisks	DataDisk[]	連結至集區中計算節點的數據磁碟設定。 如果集區中的計算節點必須連結空的數據磁碟，則必須指定這個屬性。 這無法更新。 每個計算節點都會取得自己的磁碟（磁碟不是檔案共用）。 無法連結現有的磁碟，每個連結的磁碟都是空的。 從集區移除計算節點時，也會刪除與該節點相關聯的磁碟和所有數據。 磁碟在連接之後不會格式化，因此必須先格式化，才能使用 - 如需詳細資訊，請參閱 https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux 和 https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine。
diskEncryptionConfiguration	DiskEncryptionConfiguration	集區的磁碟加密組態。 如果指定，則會在節點布建期間，在集區中的每個節點上執行加密。
extensions	VMExtension[]	集區的虛擬機擴充功能。 如果指定，此組態中提及的擴充功能將會安裝在每個節點上。
imageReference	ImageReference	Azure 虛擬機 Marketplace 映像或要使用的自定義虛擬機映像參考。
licenseType	string	部署作業系統時要使用的內部部署授權類型。 這隻適用於包含 Windows 作業系統的映像，而且只有在您持有將部署之計算節點的有效內部部署授權時，才應該使用。 如果省略，則不會套用任何內部部署授權折扣。 值為： Windows_Server - 內部部署授權適用於 Windows Server。 Windows_Client - 內部部署授權適用於 Windows 用戶端。
nodeAgentSKUId	string	要布建在集區中計算節點上的 Batch 計算節點代理程式的 SKU。 Batch Compute Node 代理程式是在集區中的每個計算節點上執行的程式，並提供計算節點與 Batch 服務之間的命令與控制介面。 針對不同的操作系統，計算節點代理程式有不同的實作，稱為 SKU。 您必須指定符合選取的映像參考的計算節點代理程式 SKU。 若要取得支援的計算節點代理程式 SKU 清單及其已驗證的映像參考清單，請參閱「列出支援的計算節點代理程式 SKU」作業。
nodePlacementConfiguration	NodePlacementConfiguration	集區的節點放置組態。 此設定會指定集區中節點實際配置方式的規則。
osDisk	OSDisk	虛擬機操作系統磁碟的設定。
securityProfile	SecurityProfile	指定虛擬機或虛擬機擴展集的安全性配置檔設定。 指定虛擬機或虛擬機擴展集的安全性配置檔設定。
serviceArtifactReference	ServiceArtifactReference	指定使用 'latest' 映射版本時，用來為擴展集中所有虛擬機設定相同映像版本的服務成品參考標識符。 服務成品參考標識符的格式為 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	虛擬機上的 Windows 作業系統設定。 如果 imageReference 屬性指定 Linux OS 映射，則不得指定這個屬性。

VMDiskSecurityProfile

指定受控磁碟的安全性配置檔設定。 附注：它只能針對機密 VM 設定，而且在使用機密 VM 時是必要的。

名稱	類型	Description
securityEncryptionType	SecurityEncryptionTypes	指定受控磁碟的 EncryptionType。 它設定為 VMGuestStateOnly，以便只加密 VMGuestState Blob，而 NonPersistedTPM 則不會保存 VMGuestState Blob 中的韌體狀態。 附注：它只能設定為機密 VM，而且在使用機密 VM 時為必要專案。

VMExtension

虛擬機延伸模組的組態。

名稱	類型	Description
autoUpgradeMinorVersion	boolean	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。 不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。
enableAutomaticUpgrade	boolean	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。
name	string	虛擬機擴充功能的名稱。
protectedSettings	object	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
provisionAfterExtensions	string[]	延伸模組名稱的集合。 必須布建此延伸模組之後的延伸模組名稱集合。
publisher	string	擴充處理程序發行者的名稱。
settings	object	擴充功能的 JSON 格式化公用設定。
type	string	延伸模組的類型。
typeHandlerVersion	string	腳本處理程式的版本。

WindowsConfiguration

要套用至虛擬機的 Windows 作業系統設定。

名稱	類型	Description
enableAutomaticUpdates	boolean	虛擬機上是否啟用自動更新。 如果省略，預設值為 true。

WindowsUserConfiguration

用來在 Windows 計算節點上建立用戶帳戶的屬性。

名稱	類型	Description
loginMode	LoginMode	使用者的登入模式 預設值為 『batch』。