Job - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

取得指定之作業的相關信息。

GET {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
jobId	path	True	string	作業的標識碼。
api-version	query	True	string	用戶端 API 版本。
$expand	query		string	OData $expand 子句。
$select	query		string	OData $select 子句。
timeout	query		integer int32	伺服器可以花費在處理要求的最大時間，以秒為單位。 預設值為 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，請明確設定它。
If-Match		string	與用戶端已知資源版本的 ETag 值相關聯。 只有在服務上資源的目前 ETag 完全符合用戶端所指定的值時，才會執行作業。
If-None-Match		string	與用戶端已知資源版本的 ETag 值相關聯。 只有在服務的目前 ETag 不符合用戶端所指定的值時，才會執行作業。
If-Modified-Since		string date-time-rfc1123	時間戳，表示用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行作業。
If-Unmodified-Since		string date-time-rfc1123	時間戳，表示用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間之後尚未修改時，才會執行作業。

回應

名稱	類型	Description
200 OK	CloudJob	包含作業的回應。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

範例

Job get

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "jobId",
  "url": "https://account.region.batch.azure.com/jobs/jobId",
  "eTag": "0x8D4100FC49F0278",
  "lastModified": "2016-11-19T00:05:27.5391608Z",
  "creationTime": "2016-11-19T00:05:25.311915Z",
  "state": "completed",
  "stateTransitionTime": "2016-11-19T00:05:27.578581Z",
  "previousState": "active",
  "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
  "priority": 0,
  "maxParallelTasks": -1,
  "allowTaskPreemption": false,
  "usesTaskDependencies": false,
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "poolInfo": {
    "poolId": "poolId"
  },
  "executionInfo": {
    "startTime": "2016-11-19T00:05:25.3309105Z",
    "endTime": "2016-11-19T00:05:27.578581Z",
    "poolId": "poolId",
    "terminateReason": "UserTerminate"
  },
  "onAllTasksComplete": "noaction",
  "onTaskFailure": "noaction"
}

定義

名稱	Description
AccessScope	令牌授與存取權的 Batch 資源。
ApplicationPackageReference	要部署到計算節點之封裝的參考。
AuthenticationTokenSettings	工作可用來執行 Batch 服務作業的驗證令牌設定。
AutoPoolSpecification	指定暫存「自動集區」的特性。 提交作業時，Batch 服務會建立此自動集區。
AutoUserScope	自動用戶的範圍
AutoUserSpecification	指定在 Batch 服務上執行工作之自動用戶的參數。
AzureBlobFileSystemConfiguration	用來使用 Blobfuse 連線到 Azure 記憶體容器的資訊。
AzureFileShareConfiguration	用來連線到 Azure Fileshare 的資訊。
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
CachingType	要針對磁碟啟用的快取類型。
CertificateReference	要安裝在集區中計算節點上之憑證的參考。
CertificateStoreLocation	要在其中安裝憑證之計算節點上的證書存儲位置。
CertificateVisibility	計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。
CIFSMountConfiguration	用來連線到 CIFS 檔案系統的資訊。
CloudJob	Azure Batch作業。
CloudServiceConfiguration	以 Azure 雲端服務 平台為基礎的集區中計算節點的組態。
ComputeNodeFillType	工作如何分散到集區中的計算節點。
ComputeNodeIdentityReference	與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。
ContainerConfiguration	容器啟用集區的組態。
ContainerRegistry	私人容器登錄。
ContainerType	要使用的容器技術。
ContainerWorkingDirectory	容器Task工作目錄的位置。
DataDisk	集區中與計算節點相關聯的數據磁碟將使用的設定。 使用連結的資料磁碟時，您必須在 VM 內掛接並格式化磁碟，才能使用這些磁碟。
DiffDiskPlacement	指定集區中所有計算節點 (VM) 作業系統磁碟的暫時磁碟位置。
DiffDiskSettings	指定計算節點 (VM) 所使用的作業系統磁碟暫時磁碟設定。
DiskEncryptionConfiguration	套用在集區中計算節點上的磁碟加密組態。 使用 Azure 計算資源庫映像建立的 Linux 集區不支援磁碟加密設定。
DiskEncryptionTarget	磁碟目標 Batch 服務會在計算節點上加密。
DynamicVNetAssignmentScope	動態 vnet 指派的範圍。
ElevationLevel	使用者的提高許可權層級。
EnvironmentSetting	工作進程上要設定的環境變數。
ErrorCategory	錯誤類別。
ErrorMessage	在 Azure Batch 錯誤回應中收到的錯誤訊息。
HttpHeader	HTTP 標頭名稱/值組
ImageReference	Azure 虛擬機器 Marketplace 映射或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 影像參考清單，請參閱「列出支援的映像」作業。
InboundEndpointProtocol	端點的通訊協定。
InboundNATPool	輸入 NAT 集區，可用來在外部處理 Batch 集區中計算節點上的特定埠。
IPAddressProvisioningType	集區的公用IP位址布建類型。
JobConstraints	作業的執行條件約束。
JobExecutionInformation	包含Azure Batch 服務中作業執行的相關信息。
JobManagerTask	指定作業管理員工作的詳細數據。
JobNetworkConfiguration	作業的網路組態。
JobPreparationTask	在任何指定計算節點上作業的任何工作之前，要執行的作業準備工作。
JobReleaseTask	作業執行所在的任何計算節點上，要於作業完成時執行的作業發行工作。
JobSchedulingError	排程作業時 Batch 服務所遇到的錯誤。
JobState	Job 的狀態。
JobStatistics	作業的資源使用量統計數據。
LinuxUserConfiguration	用來在 Linux 計算節點上建立使用者帳戶的屬性。
LoginMode	使用者的登入模式
ManagedDisk
MetadataItem	與 Batch 服務資源相關聯的名稱/值組。
MountConfiguration	要在每個節點上掛接的文件系統。
NameValuePair	表示名稱/值組。
NetworkConfiguration	集區的網路組態。
NetworkSecurityGroupRule	要套用至輸入端點的網路安全組規則。
NetworkSecurityGroupRuleAccess	應針對指定的IP位址、子網範圍或卷標採取的動作。
NFSMountConfiguration	用來連線到 NFS 檔案系統的資訊。
NodeCommunicationMode	決定集區如何與 Batch 服務通訊。
NodePlacementConfiguration	集區的節點放置組態。
NodePlacementPolicyType	配置集區中節點的放置原則。
OnAllTasksComplete	當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。
OnTaskFailure	當作業中的任何工作失敗時，Batch 服務應該採取的動作。
OSDisk	計算節點 (VM) 之作業系統磁碟的設定。
OutputFile	在 Batch 服務完成執行工作程式之後，將檔案從 Azure Batch 計算節點上傳至另一個位置的規格。
OutputFileBlobContainerDestination	指定 Azure Blob 記憶體容器內的檔案上傳目的地。
OutputFileDestination	檔案應該上傳至其中的目的地。
OutputFileUploadCondition	工作輸出檔案或一組檔案應該上傳的條件。
OutputFileUploadOptions	輸出檔案上傳作業的詳細數據，包括執行上傳的條件。
PoolEndpointConfiguration	集區的端點組態。
PoolInformation	指定如何將作業指派給集區。
PoolLifetimeOption	建立的自動集區存留期下限，以及排程上的多個作業指派給集區的方式。
PoolSpecification	建立新集區的規格。
PublicIPAddressConfiguration	集區網路設定的公用IP位址組態。
ResourceFile	要下載至計算節點的單一檔案或多個檔案。
SecurityProfile	指定虛擬機或虛擬機擴展集的安全性配置檔設定。
SecurityTypes	指定虛擬機的 SecurityType。 它必須設定為任何指定的值，才能啟用 UefiSettings。
ServiceArtifactReference	指定使用「最新」映像版本時，用來為擴展集中的所有虛擬機設定相同映射版本的服務成品參考標識符。
StartTask	當節點加入 Azure Batch 服務中的集區，或計算節點重新啟動或重新製作映射時，就會執行的工作。
StorageAccountType	用於建立數據磁碟或 OS 磁碟的記憶體帳戶類型。
TaskConstraints	要套用至工作的執行條件約束。
TaskContainerSettings	Task 的容器設定。
TaskSchedulingPolicy	指定工作應如何分散到計算節點。
UefiSettings	指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。
UserAccount	用來建立使用者的屬性，用來在 Azure Batch 計算節點上執行工作。
UserIdentity	執行工作的使用者身分識別定義。
VirtualMachineConfiguration	以 Azure 虛擬機器 基礎結構為基礎的集區中計算節點的組態。
VMExtension	虛擬機延伸模組的組態。
WindowsConfiguration	要套用至虛擬機的 Windows 作業系統設定。
WindowsUserConfiguration	用來在 Windows 計算節點上建立用戶帳戶的屬性。

AccessScope

令牌授與存取權的 Batch 資源。

名稱	類型	Description
job	string	授與存取權，以在包含工作的作業上執行所有作業。

ApplicationPackageReference

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

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

AuthenticationTokenSettings

工作可用來執行 Batch 服務作業的驗證令牌設定。

名稱	類型	Description
access	AccessScope[]	令牌授與存取權的 Batch 資源。 驗證令牌會將存取權授與一組有限的 Batch 服務作業。 存取屬性目前唯一支援的值是 'job'，可授與與包含Task之作業相關之所有作業的存取權。

AutoPoolSpecification

指定暫存「自動集區」的特性。 提交作業時，Batch 服務會建立此自動集區。

名稱	類型	Description
autoPoolIdPrefix	string	自動建立集區時要新增至唯一標識碼的前置詞。 Batch 服務會在建立時為每個自動集區指派唯一標識符。 若要區分為不同用途建立的集區，您可以指定此元素，以將前置詞新增至指派的標識符。 前置詞的長度最多 20 個字元。
keepAlive	boolean	是否要在存留期到期后讓自動集區保持運作。 如果為 false，Batch 服務會在集區 LifetimeOption 設定所決定的存留期 (刪除集區，) 到期;也就是說，當作業或作業排程完成時。 如果為 true，Batch 服務不會自動刪除集區。 用戶必須刪除使用此選項建立的自動集區。
pool	PoolSpecification	自動集區的集區規格。
poolLifetimeOption	PoolLifetimeOption	建立的自動集區存留期下限，以及如何依排程將多個作業指派給集區。

AutoUserScope

自動用戶的範圍

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

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 Fileshare 的資訊。

名稱	類型	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	錯誤回應中包含的其他資訊。

CachingType

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

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

CertificateReference

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

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

CertificateStoreLocation

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

名稱	類型	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 檔案系統進行驗證的使用者。

CloudJob

Azure Batch作業。

名稱	類型	預設值	Description
allowTaskPreemption	boolean		此作業中的工作是否可以由其他高優先順序工作先佔 如果此值設定為 True，則提交至系統的其他高優先順序工作會優先，而且能夠從此作業重新排入佇列工作。 使用更新作業 API 建立作業之後，您可以更新作業的 allowTaskPreemption。
commonEnvironmentSettings	EnvironmentSetting[]		一般環境變數設定的清單。 這些環境變數會針對作業 (中的所有工作設定，包括作業管理員、作業準備和作業發行工作) 。 個別工作可以藉由使用不同的值來指定相同的設定名稱，來覆寫此處指定的環境設定。
constraints	JobConstraints		作業的執行條件約束。
creationTime	string		作業的建立時間。
displayName	string		工作的顯示名稱。
eTag	string		作業的ETag。 這是不透明的字串。 您可以使用它來偵測作業是否已在要求之間變更。 特別是，您可以在更新作業時傳遞 ETag，以指定只有在沒有其他人同時修改作業時，您的變更才會生效。
executionInfo	JobExecutionInformation		作業的執行資訊。
id	string		可唯一識別帳戶內作業的字串。 標識碼是保留大小寫且不區分大小寫的 (，也就是說，您可能在帳戶中沒有兩個標識符，只有大小寫) 不同。
jobManagerTask	JobManagerTask		啟動作業時要啟動之作業管理員工作的詳細數據。 建立作業時，會自動啟動作業管理員工作。 Batch 服務會先嘗試排程作業管理員工作，再排程作業中的其他任何工作。 壓縮集區時，Batch 服務會嘗試盡可能保留執行作業管理員工作的節點， (也就是說，在執行「正常」工作的計算節點會在執行作業管理員工作的計算節點) 之前移除。 當作業管理員工作失敗且需要重新啟動時，系統會嘗試以最高優先順序排程它。 如果沒有可用的閑置計算節點，系統可能會終止集區中其中一個執行中的工作，並將它傳回佇列，以便讓作業管理員工作重新啟動。 請注意，一個作業中的作業管理員工作不會優先於其他作業中的工作。 在 [作業] 中，只會觀察到作業層級優先順序。 例如，如果優先順序為 0 作業的作業管理員需要重新啟動，它就不會使優先順序為 1 作業的工作無所不在。 批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括 (，但不限於重新啟動狀況不良的節點時) ，或計算節點因主機失敗而消失。 由於復原作業的重試與 無關，且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 為 0，也可能會因為復原作業而發生內部重試。 因此，所有工作都應該具有等冪性。 這表示工作必須容許中斷並重新啟動，而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點檢查。
jobPreparationTask	JobPreparationTask		作業準備工作。 作業準備工作是在作業的任何其他工作之前，在每個計算節點上執行的特殊工作。
jobReleaseTask	JobReleaseTask		作業發行工作。 作業發行工作是在每個執行作業之其他工作之計算節點上，於作業結束時執行的特殊工作。
lastModified	string		作業的最後一次修改時間。 這是作業層級數據上次變更的時間，例如作業狀態或優先順序。 它不會考慮工作層級變更，例如新增工作或工作變更狀態。
maxParallelTasks	integer	-1	工作可以平行執行的工作數目上限。 如果指定 maxParallelTasks 的值必須是 -1 或大於 0。 如果未指定，預設值為 -1，這表示一次可以執行的工作數目沒有限制。 您可以使用更新作業 API 建立作業之後，更新作業的 maxParallelTasks。
metadata	MetadataItem[]		與作業相關聯的名稱/值組清單做為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
networkConfiguration	JobNetworkConfiguration		作業的網路組態。
onAllTasksComplete	OnAllTasksComplete		當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。 預設值為 noaction。
onTaskFailure	OnTaskFailure		當作業中的任何工作失敗時，Batch 服務應該採取的動作。 如果 失敗Info，工作會被視為失敗。 如果 Task 在用完重試計數之後使用非零結束代碼完成，或是啟動 Task 時發生錯誤，例如資源文件下載錯誤，則會設定 failureInfo。 預設值為 noaction。
poolInfo	PoolInformation		與作業相關聯的集區設定。
previousState	JobState		作業的先前狀態。 如果作業處於初始作用中狀態，則不會設定這個屬性。
previousStateTransitionTime	string		作業進入其先前狀態的時間。 如果作業處於初始作用中狀態，則不會設定這個屬性。
priority	integer		作業的優先順序。 優先順序值的範圍從 -1000 到 1000，-1000 表示最低優先順序，1000 表示最高優先順序。 預設值為 0。
state	JobState		作業的目前狀態。
stateTransitionTime	string		作業進入其目前狀態的時間。
stats	JobStatistics		作業整個存留期的資源使用量統計數據。 只有在使用包含 『stats』 屬性的 expand 子句擷取 CloudJob 時，才會填入此屬性;否則為 null。 統計數據可能無法立即使用。 Batch 服務會定期匯總統計數據。 典型的延遲大約是30分鐘。
url	string		作業的 URL。
usesTaskDependencies	boolean		作業中的工作是否可以彼此定義相依性。 預設值為 false。

CloudServiceConfiguration

以 Azure 雲端服務 平台為基礎的集區中計算節點的組態。

名稱	類型	Description
osFamily	string	要安裝在集區中虛擬機上的 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。 6 - OS 系列 6，相當於 Windows Server 2019。 如需詳細資訊，請參閱 Azure 客體 OS 版本 (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) 。
osVersion	string	要安裝在集區中虛擬機上的 Azure 客體 OS 版本。 預設值為 * ，指定指定作業系統系列的最新操作系統版本。

ComputeNodeFillType

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

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

ComputeNodeIdentityReference

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

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

ContainerConfiguration

容器啟用集區的組態。

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

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

容器Task工作目錄的位置。

名稱	類型	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/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的暫時 OS 磁碟大小需求。

DiskEncryptionConfiguration

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

名稱	類型	Description
targets	DiskEncryptionTarget[]	Batch 服務將在計算節點上加密的磁碟目標清單。 如果省略，則不會加密集區中計算節點上的磁碟。 在 Linux 集區上，僅支援 「TemporaryDisk」 ;在 Windows 集區上，必須指定 「OsDisk」 和 「TemporaryDisk」。。

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	環境變數的值。

ErrorCategory

錯誤類別。

名稱	類型	Description
servererror	string	錯誤是因為內部伺服器問題所造成。
usererror	string	錯誤是因為用戶問題所造成，例如設定錯誤。

ErrorMessage

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

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

HttpHeader

HTTP 標頭名稱/值組

名稱	類型	Description
name	string	上傳輸出檔案時要使用的標頭不區分大小寫名稱
value	string	上傳輸出檔案時要使用的標頭值

ImageReference

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

名稱	類型	Description
exactVersion	string	用來建立節點之平臺映像或 Marketplace 映像的特定版本。 只有在建立集區時為 'version' 指定的值是 'latest' 時，這個只讀字段才會與 'version' 不同。
offer	string	Azure 虛擬機器 Marketplace 映像的供應項目類型。 例如，UbuntuServer 或 WindowsServer。
publisher	string	Azure 虛擬機器 Marketplace 映像的發行者。 例如，Canonical 或 MicrosoftWindowsServer。
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/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration。

InboundEndpointProtocol

端點的通訊協定。

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

InboundNATPool

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

名稱	類型	Description
backendPort	integer	計算節點上的埠號碼。 這在 Batch 集區內必須是唯一的。 可接受的值介於 1 到 65535 之間，除了 22、3389、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[]	將套用至端點的網路安全組規則清單。 可在 Batch 集區上所有端點上指定的規則數目上限為 25。 如果未指定網路安全組規則，將會建立默認規則，以允許對指定的 backendPort 進行輸入存取。 如果超過網路安全組規則的數目上限，要求會失敗，並出現 HTTP 狀態代碼 400。
protocol	InboundEndpointProtocol	端點的通訊協定。

IPAddressProvisioningType

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

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

JobConstraints

作業的執行條件約束。

名稱	類型	Description
maxTaskRetryCount	integer	每個工作可能重試的次數上限。 如果 Batch 服務的結束代碼為非零，Batch 服務會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試每個工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試最多 4 次工作， (一次初始嘗試，3 次重試) 。 如果重試計數上限為0，Batch服務不會重試工作。 如果重試計數上限為 -1，Batch 服務會重試沒有限制的工作。 預設值為 0 (不重試)。
maxWallClockTime	string	作業可能執行的經過時間上限，從建立作業的時間算起。 如果作業未在時間限制內完成，Batch 服務會終止它，以及仍在執行的任何工作。 在此情況下，終止原因會是 MaxWallClockTimeExpiry。 如果未指定此屬性，則作業的執行時間長度沒有任何時間限制。

JobExecutionInformation

包含Azure Batch 服務中作業執行的相關信息。

名稱	類型	Description
endTime	string	作業的完成時間。 只有在作業處於已完成狀態時，才會設定這個屬性。
poolId	string	指派此作業之集區的標識碼。 這個專案包含指派作業的實際集區。 當您從服務取得作業詳細數據時，它們也會包含 poolInfo 元素，其中包含新增或更新作業時的集區組態數據。 該 poolInfo 元素也可能包含 poolId 元素。 如果這樣做，則兩個標識符相同。 如果沒有，則表示作業在自動集區上執行，而且此屬性包含該自動集區的標識碼。
schedulingError	JobSchedulingError	啟動作業時服務所遇到的任何錯誤詳細數據。 如果沒有啟動作業時發生錯誤，則不會設定這個屬性。
startTime	string	作業的開始時間。 這是建立作業的時間。
terminateReason	string	描述作業結束原因的字串。 只有在作業處於已完成狀態時，才會設定這個屬性。 如果 Batch 服務終止作業，它會將原因設定如下：JMComplete - 作業管理員工作已完成，並將 killJobOnCompletion 設定為 true。 MaxWallClockTimeExpiry - 作業已達到其 maxWallClockTime 條件約束。 TerminateJobSchedule - 作業是以排程的一部分執行，而排程已終止。 AllTasksComplete - Job 的 onAllTasksComplete 屬性會設定為 terminatejob，且作業中的所有工作都已完成。 TaskFailed - Job 的 onTaskFailure 屬性會設定為 performExitOptionsJobAction，而 Job 中的 Task 失敗，並具有指定 jobAction 為 terminatejob 的結束條件。 任何其他字串都是呼叫「終止作業」作業中指定的使用者定義原因。

JobManagerTask

指定作業管理員工作的詳細數據。

名稱	類型	Description
allowLowPriorityNode	boolean	作業管理員工作是否可以在現成/低優先順序計算節點上執行。 預設值為 true。
applicationPackageReferences	ApplicationPackageReference[]	在執行命令行之前，Batch 服務會部署至計算節點的應用程式套件清單。 應用程式套件會下載並部署到共享目錄，而不是工作工作目錄。 因此，如果參考的應用程式套件已經在計算節點上，而且是最新的，則不會重新下載;會使用計算節點上的現有複本。 如果無法安裝參考的應用程式套件，例如因為套件已刪除或下載失敗，工作就會失敗。
authenticationTokenSettings	AuthenticationTokenSettings	工作可用來執行 Batch 服務作業的驗證令牌設定。 如果已設定此屬性，Batch 服務會提供驗證令牌，以用來驗證 Batch 服務作業，而不需要帳戶存取密鑰。 令牌是透過 AZ_BATCH_AUTHENTICATION_TOKEN 環境變數來提供。 工作可以使用令牌執行的作業取決於設定。 例如，工作可以要求作業許可權，以便將其他工作新增至作業，或檢查作業或作業下其他工作的狀態。
commandLine	string	作業管理員工作的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這類功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或 Linux 中的 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對於Task工作目錄) 的相對路徑 (，或使用 Batch 提供的環境變數 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。
constraints	TaskConstraints	套用至作業管理員工作的條件約束。
containerSettings	TaskContainerSettings	作業管理員工作執行所在容器的設定。 如果將執行此工作的集區已設定 containerConfiguration，也必須設定此設定。 如果將執行此工作的集區未設定 containerConfiguration，則不得設定此設定。 當指定此專案時，節點) 上 Azure Batch 目錄根目錄AZ_BATCH_NODE_ROOT_DIR (递归于容器下方的所有目录，所有 Task 環境變數都會對應至容器，而且工作命令行會在容器中執行。 在AZ_BATCH_NODE_ROOT_DIR外部容器中產生的檔案可能不會反映到主機磁碟，這表示 Batch 檔案 API 將無法存取這些檔案。
displayName	string	作業管理員工作的顯示名稱。 它不需要是唯一的，而且可以包含最多 1024 個 Unicode 字元。
environmentSettings	EnvironmentSetting[]	作業管理員工作的環境變數設定清單。
id	string	字串，可唯一識別作業內的作業管理員工作。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。
killJobOnCompletion	boolean	作業管理員工作是否完成表示整個作業完成。 如果為 true，當作業管理員工作完成時，Batch 服務會將作業標示為完成。 如果任何工作目前仍在執行中， (作業發行) 以外的工作，這些工作就會終止。 如果為 false，作業管理員工作完成不會影響作業狀態。 在此情況下，您應該使用 onAllTasksComplete 屬性來終止 Job，或讓用戶端或使用者明確地終止作業。 其中一個範例是，如果作業管理員建立一組工作，但在執行時不會採取進一步的角色。 預設值為 true。 如果您使用 onAllTasksComplete 和 onTaskFailure 屬性來控制作業存留期，而且只使用作業管理員工作建立工作 (不要監視進度) ，請務必將 killJobOnCompletion 設定為 false。
outputFiles	OutputFile[]	執行命令行之後，Batch 服務將從計算節點上傳的檔案清單。 對於多重實例工作，檔案只會從執行主要工作的計算節點上傳。
requiredSlots	integer	工作需要執行的排程位置數目。 預設值是 1。 如果節點有足夠的可用排程位置可用，則工作只能排程在計算節點上執行。 對於多重實例工作，不支援此屬性，而且不得指定。
resourceFiles	ResourceFile[]	Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 此專案底下的檔案位於Task的工作目錄中。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。
runExclusive	boolean	作業管理員工作是否需要獨佔使用其執行所在的計算節點。 如果為 true，只要作業管理員正在執行，其他工作就不會在相同的節點上執行。 如果為 false，其他工作可以在計算節點上與作業管理員同時執行。 作業管理員工作通常會根據計算節點的並行工作限制計算，因此只有在計算節點允許多個並行工作時才相關。 預設值為 true。
userIdentity	UserIdentity	作業管理員工作執行所在的使用者身分識別。 如果省略，工作會以工作唯一的非系統管理使用者身分執行。

JobNetworkConfiguration

作業的網路組態。

名稱	類型	Description
subnetId	string	從作業執行工作的計算節點將在工作期間聯結之虛擬網路子網的ARM資源識別碼。 這隻適用於 VirtualMachineConfiguration 集區。 虛擬網路必須與 Azure Batch 帳戶位於相同的區域和訂用帳戶。 指定的子網應該有足夠的可用IP位址，以容納將從作業執行工作的計算節點數目。 這最多可達集區中的計算節點數目。 'MicrosoftAzureBatch' 服務主體必須具有指定 VNet 的「傳統虛擬機參與者」Role-Based 存取控制 (RBAC) 角色，讓 Azure Batch 服務可以排程節點上的工作。 您可以藉由檢查指定的 VNet 是否有任何相關聯的網路安全組 (NSG) 來進行驗證。 如果 NSG 拒絕與指定子網中節點的通訊，Batch 服務會將計算節點的狀態設定為無法使用。 格式為 /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。 如果指定的 VNet 具有任何相關聯的網路安全組 (NSG) ，則必須針對來自 Azure Batch 服務的輸入通訊啟用一些保留的系統埠。 針對使用虛擬機設定建立的集區，請啟用埠 29876 和 29877，以及適用於 Linux 的埠 22 和適用於 Windows 的埠 3389。 也必須開啟埠 443，才能對 Azure 記憶體的通訊進行輸出連線。 如需詳細資訊，請參閱： https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

在任何指定計算節點上作業的任何工作之前，要執行的作業準備工作。

名稱	類型	Description
commandLine	string	作業準備工作的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這類功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或 Linux 中的 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對於Task工作目錄) 的相對路徑 (，或使用 Batch 提供的環境變數 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。
constraints	TaskConstraints	套用至作業準備工作的條件約束。
containerSettings	TaskContainerSettings	作業準備工作執行所在容器的設定。 當指定此專案時，節點) 上 Azure Batch 目錄根目錄AZ_BATCH_NODE_ROOT_DIR (递归于容器下方的所有目录，所有 Task 環境變數都會對應至容器，而且工作命令行會在容器中執行。 在AZ_BATCH_NODE_ROOT_DIR外部容器中產生的檔案可能不會反映到主機磁碟，這表示 Batch 檔案 API 將無法存取這些檔案。
environmentSettings	EnvironmentSetting[]	作業準備工作的環境變數設定清單。
id	string	字串，可唯一識別作業內的作業準備工作。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 如果您未指定此屬性，Batch 服務會指派預設值 『jobpreparation』。 作業中的其他工作不能有與作業準備工作相同的標識碼。 如果您嘗試提交具有相同標識符的工作，Batch 服務會拒絕要求，錯誤碼為TaskIdSameAsJobPreparationTask;如果您直接呼叫 REST API，HTTP 狀態代碼為 409 (衝突) 。
rerunOnNodeRebootAfterSuccess	boolean	Batch 服務是否應該在計算節點重新啟動之後重新執行作業準備工作。 如果重新製作計算節點，或作業準備工作未完成 (例如，因為工作執行) 時發生重新啟動，則一律會重新執行作業準備工作。 因此，您應該一律撰寫作業準備工作來等冪，並在執行多次時正常運作。 預設值為 true。
resourceFiles	ResourceFile[]	Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 此專案底下的檔案位於Task的工作目錄中。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。
userIdentity	UserIdentity	工作準備工作執行所在的使用者身分識別。 如果省略，工作會以 Windows 計算節點上工作唯一的非系統管理使用者身分執行，或是 Linux 計算節點上集區唯一的非系統管理使用者。
waitForSuccess	boolean	Batch 服務是否應該等候作業準備工作順利完成，再排程計算節點上作業的任何其他工作。 如果作業準備工作結束且結束代碼為 0，則作業準備工作已順利完成。 如果為 true，且節點上的作業準備工作失敗，Batch 服務會重試作業準備工作，最多重試計數上限 (，如條件約束元素) 中所指定。 如果工作在所有重試之後仍然未順利完成，Batch 服務就不會將作業的工作排程到節點。 節點會維持作用中狀態，且有資格執行其他作業的工作。 如果為 false，Batch 服務將不會等候作業準備工作完成。 在此情況下，作業的其他工作可以在作業準備工作仍在執行時，開始在計算節點上執行;即使作業準備工作失敗，新的工作仍會繼續排程在計算節點上。 預設值為 true。

JobReleaseTask

作業執行所在的任何計算節點上，要於作業完成時執行的作業發行工作。

名稱	類型	Description
commandLine	string	作業發行工作的命令行。 命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這類功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand” 或 Linux 中的 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對於Task工作目錄) 的相對路徑 (，或使用 Batch 提供的環境變數 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。
containerSettings	TaskContainerSettings	作業發行工作執行所在容器的設定。 當指定此專案時，節點) 上 Azure Batch 目錄根目錄AZ_BATCH_NODE_ROOT_DIR (递归于容器下方的所有目录，所有 Task 環境變數都會對應至容器，而且工作命令行會在容器中執行。 在AZ_BATCH_NODE_ROOT_DIR外部容器中產生的檔案可能不會反映到主機磁碟，這表示 Batch 檔案 API 將無法存取這些檔案。
environmentSettings	EnvironmentSetting[]	作業發行工作的環境變數設定清單。
id	string	字串，可唯一識別作業內的作業發行工作。 標識元可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 64 個字元。 如果您未指定此屬性，Batch 服務會指派預設值 『jobrelease』。 作業中的其他工作不能有與作業發行工作相同的標識碼。 如果您嘗試提交具有相同標識符的工作，Batch 服務會拒絕要求，錯誤碼 TaskIdSameAsJobReleaseTask;如果您直接呼叫 REST API，HTTP 狀態代碼為 409 (衝突) 。
maxWallClockTime	string	作業發行工作可以在指定的計算節點上執行的最大經過時間，從工作開始的時間開始計算。 如果工作未在時間限制內完成，Batch 服務就會終止它。 預設值為 15 分鐘。 您可能不會指定超過 15 分鐘的逾時。 如果您這麼做，Batch 服務會拒絕它並出現錯誤;如果您直接呼叫 REST API，HTTP 狀態代碼為 400 (不正確的要求) 。
resourceFiles	ResourceFile[]	Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。 此專案底下的檔案位於Task的工作目錄中。
retentionTime	string	在計算節點上保留作業發行工作的工作目錄的最小時間。 在這段時間之後，Batch 服務可能會刪除Task目錄及其所有內容。 默認值為 7 天，亦即工作目錄會保留 7 天，除非移除計算節點或刪除作業。
userIdentity	UserIdentity	執行作業發行工作的使用者身分識別。 如果省略，工作會以工作唯一的非系統管理使用者身分執行。

JobSchedulingError

排程作業時 Batch 服務所遇到的錯誤。

名稱	類型	Description
category	ErrorCategory	作業排程錯誤的類別。
code	string	作業排程錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
details	NameValuePair[]	與排程錯誤相關的其他錯誤詳細數據清單。
message	string	描述作業排程錯誤的訊息，其適用於在使用者介面中顯示。

JobState

Job 的狀態。

名稱	類型	Description
active	string	作業可供排程工作。
completed	string	所有工作都已終止，而且系統不會接受任何其他 Tasks 或任何對作業的進一步變更。
deleting	string	使用者已要求刪除作業，但刪除作業仍在進行中 (例如，因為系統仍在終止執行工作) 。
disabled	string	使用者已停用作業。 沒有工作正在執行，而且不會排程任何新的工作。
disabling	string	使用者已要求停用作業，但停用作業仍在進行中 (例如，等候工作終止) 。
enabling	string	使用者已要求啟用作業，但啟用作業仍在進行中。
terminating	string	作業即將完成，可能是因為作業管理員工作已完成，或因為使用者已終止作業，但終止作業仍在進行中 (例如，因為作業發行工作正在執行) 。

JobStatistics

作業的資源使用量統計數據。

名稱	類型	Description
kernelCPUTime	string	所有核心和所有工作) 取用的所有計算節點的總核心模式 CPU 時間 (總。
lastUpdateTime	string	上次更新統計數據的時間。 所有統計數據都受限於 startTime 與 lastUpdateTime 之間的範圍。
numFailedTasks	integer	作業中在指定時間範圍內失敗的工作總數。 工作會在未傳回結束代碼 0 的情況下耗盡其最大重試計數時失敗。
numSucceededTasks	integer	在指定時間範圍內作業中成功完成的工作總數。 如果工作傳回結束代碼 0，工作就會順利完成。
numTaskRetries	integer	在指定時間範圍內，作業中所有工作的重試總數。
readIOGiB	number	作業中所有工作從磁碟讀取 GiB 中的數據總量。
readIOps	integer	作業中所有工作所做的磁碟讀取作業總數。
startTime	string	統計數據所涵蓋之時間範圍的開始時間。
url	string	統計數據的 URL。
userCPUTime	string	使用者模式 CPU 時間總計 (在所有核心和所有計算節點之間加總，) 由作業中的所有工作取用。
waitTime	string	作業中所有工作的等候時間總計。 工作的等候時間定義為建立Task與Task執行開始之間的經過時間。 (如果工作因失敗而重試，則等候時間是最新的工作執行時間。) 此值只會在帳戶存留期統計數據中報告;它不包含在作業統計數據中。
wallClockTime	string	作業中所有工作的總時鐘時間。 時鐘時間是從工作在計算節點上開始執行到完成 (或上次更新統計數據的時間所經過的時間，如果工作尚未完成，則) 。 如果重試工作，這包括所有工作重試的時鐘時間。
writeIOGiB	number	GiB 中所有工作寫入磁碟的數據總量。
writeIOps	integer	作業中所有工作所做的磁碟寫入作業總數。

LinuxUserConfiguration

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

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

LoginMode

使用者的登入模式

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

ManagedDisk

名稱	類型	Description
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 集區中計算節點上端點的組態。 只有具有 virtualMachineConfiguration 屬性的集區才支援集區端點設定。
publicIPAddressConfiguration	PublicIPAddressConfiguration	Batch 集區中計算節點的公用IPAddress設定。 只有具有 virtualMachineConfiguration 屬性的集區才支援公用 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 服務會將計算節點的狀態設定為無法使用。 針對僅使用 virtualMachineConfiguration (『Microsoft 的 ARM 虛擬網路所建立的集區。支持網路/virtualNetworks 的 ) ，但支援使用 cloudServiceConfiguration 建立的集區，同時支援 ARM 和傳統虛擬網路。 如果指定的 VNet 有任何相關聯的網路安全性群組 (NSG)，則必須啟用幾個已保留的系統連接埠以供進行輸入通訊。 針對使用虛擬機設定建立的集區，請啟用埠 29876 和 29877，以及適用於 Linux 的埠 22 和適用於 Windows 的埠 3389。 針對使用雲端服務設定建立的集區，啟用埠 10100、20100 和 30100。 同時在埠 443 上啟用對 Azure 記憶體的輸出連線。 如需詳細資訊，請參閱： https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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	集區中的節點將會分散到不同的可用性區域，並盡最大努力平衡。

OnAllTasksComplete

當作業中的所有工作都處於已完成狀態時，Batch 服務應該採取的動作。

名稱	類型	Description
noaction	string	什麼都不做。 除非以其他方式終止或停用作業，否則作業會維持使用中狀態。
terminatejob	string	終止作業。 Job 的 terminateReason 設定為 'AllTasksComplete'。

OnTaskFailure

當作業中的任何工作失敗時，Batch 服務應該採取的動作。

名稱	類型	Description
noaction	string	什麼都不做。 除非以其他方式終止或停用作業，否則作業會維持使用中狀態。
performexitoptionsjobaction	string	在 Task 的 exitConditions 集合中，採取與 Task 結束條件相關聯的動作。 (如果這是 Task 指定的內容，這仍可能會導致不採取任何動作。)

OSDisk

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

名稱	類型	Description
caching	CachingType	指定快取需求。 可能的值為：None、ReadOnly、ReadWrite。 預設值為：標準記憶體的 None。 進階記憶體的 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。

OutputFile

在 Batch 服務完成執行工作程式之後，將檔案從 Azure Batch 計算節點上傳至另一個位置的規格。

名稱	類型	Description
destination	OutputFileDestination	輸出檔案的目的地 () 。
filePattern	string	模式，表示要上傳的檔案 () 。 支援相對路徑和絕對路徑。 相對路徑相對於工作工作目錄。 支援下列通配符：* 比對 0 或更多字元 (，例如模式 abc* 會比對 abc 或 abcdef) ， ** 符合任何目錄？ 會比對任何單一字元 [abc] 比對括號中的一個字元，而 [a-c] 會比對範圍中的一個字元。 括弧可以包含負號來比對未指定的任何字元 (例如 [！abc] 符合任何字元，但 a、b 或 c) 。 如果檔名開頭為 “.”，則預設會忽略它，但可藉由明確指定它 (來比對，例如 ，.gif 不符合 .a.gif，但 ..gif 將會) 。 簡單範例： .txt 會比對任何未在 『.』 中啟動的檔案，並以工作工作目錄或任何子目錄中的 .txt 結尾。 如果檔名包含通配符，則可以使用方括弧 (逸出，例如 abc[] 會比對名為 abc) 的檔案。 請注意，\ 和 / 都會被視為 Windows 上的目錄分隔符，但只有 / 在 Linux 上。 在套用模式之前，會在 Windows 上 (%var% 或 Linux 上的$var) 展開環境變數。
uploadOptions	OutputFileUploadOptions	上傳作業的其他選項，包括執行上傳的條件。

OutputFileBlobContainerDestination

指定 Azure Blob 記憶體容器內的檔案上傳目的地。

名稱	類型	Description
containerUrl	string	Azure Blob 儲存體 內要上傳檔案的容器 URL， (s) 。 如果未使用受控識別，URL 必須包含共用存取簽章 (SAS) 授與容器的寫入許可權。
identityReference	ComputeNodeIdentityReference	用來存取 containerUrl 所指定之 Azure Blob 儲存體 的使用者指派身分識別參考 身分識別必須具有 Azure Blob 儲存體 容器的寫入許可權
path	string	Azure 記憶體容器內的目的地 Blob 或虛擬目錄。 如果 filePattern 參考特定檔案 (亦即不包含任何通配符) ，則 path 是要上傳該檔案的 Blob 名稱。 如果 filePattern 包含一或多個通配符 (，因此可能會比對多個檔案) ，則 path 是 blob 虛擬目錄的名稱 (，其前面會加上每個 Blob 名稱) ，以便上傳檔案 (s) 。 如果省略，檔案 () 會上傳至符合其檔名的 Blob 名稱的容器根目錄。
uploadHeaders	HttpHeader[]	用於上傳輸出檔案中標頭的名稱/值組清單 將檔案上傳至 Azure 記憶體時，將會指定這些標頭。 上傳 Blob 時允許標頭的官方檔： https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

檔案應該上傳至其中的目的地。

名稱	類型	Description
container	OutputFileBlobContainerDestination	Azure Blob 記憶體中上傳檔案的位置。

OutputFileUploadCondition

工作輸出檔案或一組檔案應該上傳的條件。

名稱	類型	Description
taskcompletion	string	不論結束代碼為何，在工作程序結束之後，將檔案上傳 () 。
taskfailure	string	只有在工作進程結束且具有非零結束代碼之後，才能上傳檔案 (s) 。
tasksuccess	string	只有在工作程序結束且結束代碼為 0 之後，才能上傳檔案 (s) 。

OutputFileUploadOptions

輸出檔案上傳作業的詳細數據，包括執行上傳的條件。

名稱	類型	Description
uploadCondition	OutputFileUploadCondition	工作輸出檔案或一組檔案應該上傳的條件。 預設值為 taskcompletion。

PoolEndpointConfiguration

集區的端點組態。

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

PoolInformation

指定如何將作業指派給集區。

名稱	類型	Description
autoPoolSpecification	AutoPoolSpecification	暫存「自動集區」的特性。 提交作業時，Batch 服務會建立此自動集區。 如果自動建立集區失敗，Batch 服務會將作業移至已完成狀態，而且集區建立錯誤是在作業的排程錯誤屬性中設定。 Batch 服務會管理建立 (存留期，除非指定keepAlive，否則刪除) 自動集區。 任何影響自動集區存留期的用戶動作，當作業處於作用中狀態時，將會導致非預期的行為。 您必須指定集區標識碼或自動集區規格，但不能同時指定兩者。
poolId	string	現有集區的標識碼。 作業的所有工作都會在指定的集區上執行。 您必須確定這個屬性所參考的集區存在。 如果 Batch 服務嘗試排程作業時，集區不存在，則在您建立具有該標識符的集區之前，不會執行作業的工作。請注意，Batch 服務不會拒絕作業要求;它只會在集區存在之前不會執行工作。 您必須指定集區標識碼或自動集區規格，但不能同時指定兩者。

PoolLifetimeOption

建立的自動集區存留期下限，以及排程上的多個作業指派給集區的方式。

名稱	類型	Description
job	string	集區存在專用之作業的存留期。 Batch 服務會在建立作業時建立集區。 如果 'job' 選項套用至作業排程，Batch 服務會針對排程上建立的每個作業建立新的自動集區。
jobschedule	string	集區存在作業排程的存留期。 Batch 服務會在排程上建立第一個作業時建立集區。 您只能將此選項套用至作業排程，而不是套用至作業。

PoolSpecification

建立新集區的規格。

名稱	類型	Description
applicationLicenses	string[]	Batch 服務將在集區中的每個計算節點上提供的應用程式授權清單。 應用程式授權清單必須是可用 Batch 服務應用程式授權的子集。 如果要求不支持的授權，則集區建立將會失敗。 集區上可用的允許授權為 'maya'、'vray'、'3dsmax'、'arnold'。 新增至集區的每個應用程式授權都會收取額外費用。
applicationPackageReferences	ApplicationPackageReference[]	要安裝在集區中每個計算節點上的套件清單。 建立集區時，套件的應用程式標識碼必須完整 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) 。 套件參考的變更會影響聯結集區的所有新節點，但不會影響已在集區中的計算節點，直到重新啟動或重新製作映像為止。 任何指定的集區上最多有10個套件參考。
autoScaleEvaluationInterval	string	根據自動調整公式自動調整集區大小的時間間隔。 預設值為 15 分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定小於 5 分鐘或大於 168 小時的值，Batch 服務會拒絕要求，並出現無效的屬性值錯誤;如果您要直接呼叫 REST API，HTTP 狀態代碼為 400 (「不正確的要求」) 。
autoScaleFormula	string	集區中所需計算節點數目的公式。 如果 enableAutoScale 設定為 false，則不得指定這個屬性。 如果 enableAutoScale 設定為 true，則需要它。 在建立集區之前，會先檢查公式是否有效。 如果公式無效，Batch 服務會拒絕要求，並包含詳細的錯誤資訊。
certificateReferences	CertificateReference[]	要安裝在集區中每個計算節點上的憑證清單。 針對 Windows 節點，Batch 服務會將憑證安裝到指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，並將環境變數AZ_BATCH_CERTIFICATES_DIR提供給工作來查詢此位置。 對於可見度為 'remoteUser' 的憑證，會在使用者的主目錄中建立 'certs' 目錄 (，例如 /home/{user-name}/certs) ，而 Certificates 會放在該目錄中。 警告：此屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能 。
cloudServiceConfiguration	CloudServiceConfiguration	集區的雲端服務組態。 如果需要使用 Azure PaaS VM 建立集區，則必須指定這個屬性。 此屬性和 virtualMachineConfiguration 互斥，而且必須指定其中一個屬性。 如果未指定任一項，Batch 服務就會傳回錯誤;如果您要直接呼叫 REST API，HTTP 狀態代碼為 400 (「不正確的要求」) 。 如果 Batch 帳戶是以其 poolAllocationMode 屬性設定為 'UserSubscription' 建立，則無法指定這個屬性。
displayName	string	集區的顯示名稱。 顯示名稱不一定是唯一的，而且可以包含最多 1024 個 Unicode 字元。
enableAutoScale	boolean	集區大小是否應該隨著時間自動調整。 如果為 false，則必須指定至少一個 targetDedicatedNodes 和 targetLowPriorityNodes。 如果為 true，則需要 autoScaleFormula 元素。 集區會根據公式自動重設大小。 預設值為 false。
enableInterNodeCommunication	boolean	集區是否允許計算節點之間的直接通訊。 啟用節點間通訊會限制集區的大小上限，因為集區的計算節點上的部署限制。 這可能會導致集區無法達到所需的大小。 預設值為 false。
metadata	MetadataItem[]	與集區相關聯的名稱/值組清單作為元數據。 Batch 服務不會將任何意義指派給元數據;它僅供使用者程式代碼使用。
mountConfiguration	MountConfiguration[]	要掛接在集區中每個節點上的檔案系統清單。 這支援 Azure 檔案儲存體、NFS、CIFS/SMB 和 Blobfuse。
networkConfiguration	NetworkConfiguration	集區的網路組態。 集區的網路組態。
resizeTimeout	string	將計算節點配置給集區的逾時。 此逾時僅適用於手動調整;當 enableAutoScale 設定為 true 時，它沒有任何作用。 預設值為 15 分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會拒絕要求併發生錯誤;如果您要直接呼叫 REST API，HTTP 狀態代碼為 400 (「不正確的要求」) 。
resourceTags	object	與集區相關聯的使用者指定標籤。 要與 Azure Batch 集區相關聯的使用者定義標籤。 指定時，這些標記會傳播至與集區相關聯的備份 Azure 資源。 只有在使用 poolAllocationMode 屬性設定為 'UserSubscription' 建立 Batch 帳戶時，才能指定這個屬性。
startTask	StartTask	加入集區時，要在每個計算節點上執行的工作。 當計算節點新增至集區或重新啟動計算節點時，工作就會執行。 批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括 (，但不限於重新啟動狀況不良的節點時) ，或因主機失敗而計算節點消失。 由於復原作業的重試與 無關，而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 為 0，也可能發生因復原作業而造成內部重試。 因此，所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動，而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點檢查。 在某些情況下，即使計算節點未重新啟動，StartTask 仍可能會重新執行。 請特別小心避免從 StartTask 工作目錄建立中斷進程或安裝/啟動服務的 StartTask，因為這樣會阻止 Batch 重新執行 StartTask。
targetDedicatedNodes	integer	集區中所需的專用計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定這個屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
targetLowPriorityNodes	integer	集區中所需的現成/低優先順序計算節點數目。 如果 enableAutoScale 設定為 true，則不得指定這個屬性。 如果 enableAutoScale 設定為 false，則您必須設定 targetDedicatedNodes、targetLowPriorityNodes 或兩者。
targetNodeCommunicationMode	NodeCommunicationMode	集區所需的節點通訊模式。 如果省略，預設值為 Default。
taskSchedulingPolicy	TaskSchedulingPolicy	工作如何分散到集區中的計算節點。 如果未指定，則預設值為散佈。
taskSlotsPerNode	integer	可用於在集區中單一計算節點上執行並行工作的工作位置數目。 預設值為 1。 最大值為 4 倍的 vmSize 集區核心數目或 256 倍。
userAccounts	UserAccount[]	要建立於集區中每個計算節點上的用戶帳戶清單。
virtualMachineConfiguration	VirtualMachineConfiguration	集區的虛擬機組態。 如果需要使用 Azure IaaS VM 建立集區，則必須指定這個屬性。 此屬性和 cloudServiceConfiguration 互斥，而且必須指定其中一個屬性。 如果未指定任一項，Batch 服務就會傳回錯誤;如果您要直接呼叫 REST API，HTTP 狀態代碼為 400 (「不正確的要求」) 。
vmSize	string	集區中的虛擬機大小。 集區中的所有虛擬機大小都相同。 如需集區中虛擬機可用大小的相關信息，請參閱選擇 Azure Batch 集區中計算節點的 VM 大小 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes) 。

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。

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 目錄。 指定的相對路徑無法中斷工作的工作目錄，例如使用 『.』 (。) 。
httpUrl	string	要下載的檔案 URL。 autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，而且必須指定其中一個屬性。 如果 URL 指向 Azure Blob 儲存體，則必須從計算節點讀取它。 有三種方式可在 Azure 記憶體中取得 Blob 的這類 URL：包括共用存取簽章 (SAS) 授與 Blob 的讀取許可權、使用具有讀取許可權的受控識別，或為 Blob 或其容器設定 ACL 以允許公用存取。
identityReference	ComputeNodeIdentityReference	使用者指派的身分識別參考，用來存取 storageContainerUrl 或 HTTPUrl 所指定的 Azure Blob 儲存體 與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。
storageContainerUrl	string	Azure Blob 儲存體 內的 Blob 容器 URL。 autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，而且必須指定其中一個屬性。 此 URL 必須是可讀取且可從計算節點列出。 有三種方式可以取得 Azure 記憶體中容器的這類 URL：包括共用存取簽章 (SAS) 授與容器的讀取和列表許可權、使用具有讀取和列出許可權的受控識別，或為容器設定 ACL 以允許公用存取。

SecurityProfile

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

名稱	類型	Description
encryptionAtHost	boolean	用戶可以在要求中使用此屬性，以啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。
securityType	SecurityTypes	指定虛擬機的 SecurityType。 它必須設定為任何指定的值，才能啟用 UefiSettings。
uefiSettings	UefiSettings	指定安全性設定，例如建立虛擬機時所使用的安全開機和 vTPM。 指定安全性設定，例如建立虛擬機時所使用的安全開機和 vTPM。

SecurityTypes

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

名稱	類型	Description
trustedLaunch	string	可信啟動會防止進階和持續性攻擊技術侵擾。

ServiceArtifactReference

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

名稱	類型	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/en-us/azure/batch/batch-compute-node-environment-variables) 。
containerSettings	TaskContainerSettings	StartTask 執行所在容器的設定。 指定此專案時，節點) 上AZ_BATCH_NODE_ROOT_DIR (Azure Batch 目錄根目錄遞歸地對應至容器，所有 Task 環境變數都會對應至容器，而且工作命令行會在容器中執行。 在AZ_BATCH_NODE_ROOT_DIR外部容器中產生的檔案可能不會反映到主機磁碟，這表示 Batch 檔案 API 將無法存取這些檔案。
environmentSettings	EnvironmentSetting[]	StartTask 的環境變數設定清單。
maxTaskRetryCount	integer	重試工作的最大次數。 如果 Batch 服務的結束代碼為非零，Batch 服務會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次， (一次初始嘗試，3 次重試) 。 如果重試計數上限為0，Batch服務不會重試工作。 如果重試計數上限為 -1，Batch 服務會重試工作，但不建議用於啟動工作或任何工作。 預設值為 0 (不重試)。
resourceFiles	ResourceFile[]	Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。 此專案底下的檔案位於Task的工作目錄中。
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 本地備援記憶體。

TaskConstraints

要套用至工作的執行條件約束。

名稱	類型	Description
maxTaskRetryCount	integer	重試工作的最大次數。 如果 Batch 服務的結束代碼為非零，Batch 服務會重試工作。 請注意，此值特別控制工作可執行檔的重試次數，因為非零結束代碼。 Batch 服務會嘗試工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次， (一次初始嘗試，3 次重試) 。 如果重試計數上限為0，Batch服務不會在第一次嘗試之後重試工作。 如果重試計數上限為 -1，Batch 服務會重試工作，但不建議用於啟動工作或任何工作。 預設值為 0 (不重試)。
maxWallClockTime	string	工作可能執行的最大經過時間，從工作開始的時間開始計算。 如果工作未在時間限制內完成，Batch 服務就會終止它。 如果未指定此專案，則工作可能執行的時間長度沒有時間限制。
retentionTime	string	在計算節點上保留工作目錄執行的時間下限，從完成執行的時間開始。 在這段時間之後，Batch 服務可能會刪除Task目錄及其所有內容。 默認值為 7 天，亦即工作目錄會保留 7 天，除非移除計算節點或刪除作業。

TaskContainerSettings

Task 的容器設定。

名稱	類型	Description
containerRunOptions	string	容器 create 命令的其他選項。 除了 Batch 服務所控制的自變數之外，這些額外的選項也會提供為 「docker create」 命令的自變數。
imageName	string	要用來建立工作執行所在容器的映像。 這是完整的映像參考，如同指定為 “docker pull”。 如果未提供標籤作為映像名稱的一部分，則會使用標籤 “：latest” 作為預設值。
registry	ContainerRegistry	包含容器映像的私人登錄。 如果已在集區建立時提供，則可以省略此設定。
workingDirectory	ContainerWorkingDirectory	容器Task工作目錄的位置。 默認值為 『taskWorkingDirectory』。

TaskSchedulingPolicy

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

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

UefiSettings

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

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

UserAccount

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

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

UserIdentity

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

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

VirtualMachineConfiguration

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

名稱	類型	Description
containerConfiguration	ContainerConfiguration	集區的容器組態。 如果指定，則會在集區中的每個計算節點上執行安裝程式，以允許工作在容器中執行。 此集區上執行的所有一般工作和作業管理員工作都必須指定 containerSettings 屬性，而所有其他工作都可以指定它。
dataDisks	DataDisk[]	連結至集區中計算節點的數據磁碟組態。 如果集區中的計算節點必須連結空的數據磁碟，則必須指定這個屬性。 這無法更新。 每個計算節點都會在磁碟不是檔案共享) (取得自己的磁碟。 無法連結現有的磁碟，每個連結的磁碟都是空的。 從集區中移除計算節點時，也會刪除磁碟及其相關聯的所有數據。 磁碟在連接之後未格式化，必須先格式化再使用 - 如需詳細資訊，請參閱 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux 和 https://docs.microsoft.com/en-us/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 計算節點代理程式是在集區中的每個計算節點上執行的程式，並提供計算節點與 Batch 服務之間的命令與控制介面。 針對不同的操作系統，計算節點代理程式有不同的實作，稱為 SKU。 您必須指定符合選取的映像參考的計算節點代理程式 SKU。 To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation.
nodePlacementConfiguration	NodePlacementConfiguration	集區的節點放置組態。 此設定會指定集區中節點實際配置方式的規則。
osDisk	OSDisk	虛擬機操作系統磁碟的設定。
securityProfile	SecurityProfile	指定虛擬機或虛擬機擴展集的安全性配置檔設定。 指定虛擬機或虛擬機擴展集的安全性配置檔設定。
serviceArtifactReference	ServiceArtifactReference	指定使用「最新」映像版本時，用來為擴展集中的所有虛擬機設定相同映射版本的服務成品參考標識符。 服務成品參考標識符的格式為 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	虛擬機上的 Windows 作業系統設定。 如果 imageReference 屬性指定 Linux OS 映射，則不得指定這個屬性。

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	使用者的登入模式 VirtualMachineConfiguration 集區的預設值為 'batch'，而 CloudServiceConfiguration 集區的預設值為 'interactive'。