Compute Node - Get

服務:

Batch Service

API 版本:

2024-07-01.20.0

取得指定計算節點的相關信息。

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

含選擇性參數:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
nodeId	path	True	string	您想要取得相關信息之計算節點的識別碼。
poolId	path	True	string	包含計算節點的集區識別碼。
api-version	query	True	string	用戶端 API 版本。
$select	query		string	OData $select 子句。
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	ComputeNode	包含計算節點的回應。 標題 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

範例

Node get

範例要求

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2024-07-01.20.0

範例回覆

狀態碼:

200

{
  "id": "tvm-1695681911_2-20161122t193202z",
  "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
  "state": "idle",
  "schedulingState": "enabled",
  "stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
  "lastBootTime": "2016-11-22T19:37:28.623369Z",
  "allocationTime": "2016-11-22T19:32:02.8155319Z",
  "ipAddress": "1.1.1.1",
  "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
  "vmSize": "small",
  "totalTasksRun": 0,
  "totalTasksSucceeded": 0,
  "runningTasksCount": 0,
  "isDedicated": true,
  "startTask": {
    "commandLine": "cmd /c echo hello",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "startTaskInfo": {
    "state": "completed",
    "startTime": "2016-11-22T19:37:31.4285526Z",
    "endTime": "2016-11-22T19:37:31.838028Z",
    "exitCode": 0,
    "retryCount": 0
  },
  "nodeAgentInfo": {
    "version": "1.2.0.0",
    "lastUpdateTime": "2016-11-22T19:37:28.623369Z"
  }
}

定義

名稱	Description
AutoUserScope	自動用戶的範圍
AutoUserSpecification	指定在 Batch 服務上執行工作之自動用戶的參數。
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
CertificateReference	要安裝在集區中計算節點上之憑證的參考。
CertificateStoreLocation	要安裝憑證之計算節點上的證書存儲位置。
CertificateVisibility	計算節點上的哪些用戶帳戶應該可以存取憑證的私用數據。
ComputeNode	Batch 服務中的計算節點。
ComputeNodeEndpointConfiguration	計算節點的端點組態。
ComputeNodeError	計算節點所遇到的錯誤。
ComputeNodeIdentityReference	與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。
ComputeNodeState	計算節點的目前狀態。
ContainerHostBatchBindMountEntry	您想要掛接至工作容器的路徑和掛接模式專案。
ContainerHostDataPath	要掛接至容器工作容器的路徑。
ContainerRegistry	私人容器登錄。
ContainerWorkingDirectory	容器工作工作目錄的位置。
ElevationLevel	使用者的提高許可權層級。
EnvironmentSetting	要設定於工作進程的環境變數。
ErrorCategory	錯誤的類別。
ErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
ImageReference	Azure 虛擬機 Marketplace 映像或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 映像參考清單，請參閱「列出支援的映像」作業。
InboundEndpoint	計算節點上的輸入端點。
InboundEndpointProtocol	端點的通訊協定。
NameValuePair	表示名稱/值組。
NodeAgentInformation	計算節點代理程式的相關信息。
ResourceFile	要下載至計算節點的單一檔案或多個檔案。
SchedulingState	計算節點是否可供工作排程使用。
StartTask	當節點加入 Azure Batch 服務中的集區，或計算節點重新啟動或重新映像時執行的工作。
StartTaskInformation	在計算節點上執行的 StartTask 相關信息。
StartTaskState	計算節點上 StartTask 的狀態。
TaskContainerExecutionInformation	包含工作執行所在的容器相關信息。
TaskContainerSettings	工作的容器設定。
TaskExecutionInformation	工作執行的相關信息。
TaskExecutionResult	工作執行的結果。
TaskFailureInformation	工作失敗的相關信息。
TaskInformation	計算節點上執行之工作的相關信息。
TaskState	Task 的狀態。
UserIdentity	執行工作的使用者身分識別定義。
VirtualMachineInfo	虛擬機目前狀態的相關信息。

AutoUserScope

自動用戶的範圍

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

AutoUserSpecification

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

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

BatchError

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

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

BatchErrorDetail

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

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	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	執行作業工作的用戶帳戶應該可以看到憑證。

ComputeNode

Batch 服務中的計算節點。

名稱	類型	Description
affinityId	string	新增工作以要求在此計算節點上排程工作時傳遞的標識碼。 請注意，這隻是軟親和性。 如果目標計算節點在排程工作時忙碌或無法使用，則會將工作排程到別處。
allocationTime	string	此計算節點配置給集區的時間。 這是一開始配置計算節點且未變更一次設定的時間。 計算節點在服務癒合或先佔時不會更新。
certificateReferences	CertificateReference[]	安裝在計算節點上的憑證清單。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。 警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能。
endpointConfiguration	ComputeNodeEndpointConfiguration	計算節點的端點組態。
errors	ComputeNodeError[]	計算節點目前遇到的錯誤清單。
id	string	計算節點的識別碼。 新增至集區的每個計算節點都會獲指派唯一標識符。 每當從集區中移除計算節點時，就會刪除其所有本機檔案，並回收標識符，並可以重複使用給新的計算節點。
ipAddress	string	其他節點可用來與此計算節點通訊的IP位址。 新增至集區的每個計算節點都會獲指派唯一的IP位址。 每當從集區中移除計算節點時，就會刪除其所有本機檔案，並回收IP位址，並可以重複使用給新的計算節點。
isDedicated	boolean	此計算節點是否為專用計算節點。 如果為 false，計算節點是現成/低優先順序計算節點。
lastBootTime	string	上次啟動計算節點的時間。 如果計算節點狀態無法使用，這個屬性可能不存在。
nodeAgentInfo	NodeAgentInformation	計算節點代理程式版本的相關信息，以及計算節點升級至新版本的時間。 Batch Compute Node 代理程式是一個程式，可在集區中的每個計算節點上執行，並提供計算節點上的 Batch 功能。
recentTasks	TaskInformation[]	最近變更狀態的工作清單。 只有在指派給集區之後，至少有一個工作在此計算節點上執行，這個屬性才會存在。
runningTaskSlotsCount	integer	目前在計算節點上執行作業工作所使用的排程位置總數。 這包括作業管理員工作和一般工作，但不包括作業準備、作業發行或啟動工作。
runningTasksCount	integer	目前在計算節點上執行的作業工作總數。 這包括作業管理員工作和一般工作，但不包括作業準備、作業發行或啟動工作。
schedulingState	SchedulingState	計算節點是否可供工作排程使用。
startTask	StartTask	在加入集區時，指定在計算節點上執行的工作。 批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時，包括 （但不限於） 。 由於復原作業的重試與 無關，而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0，由於復原作業，可能會發生內部重試。 因此，所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動，而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 在某些情況下，即使計算節點未重新啟動，StartTask 仍可能會重新執行。 請特別小心，以避免 StartTasks 從 StartTask 工作目錄建立中斷程式或安裝/啟動服務，因為這樣會阻止 Batch 重新執行 StartTask。
startTaskInfo	StartTaskInformation	在計算節點上執行 StartTask 的運行時間資訊。
state	ComputeNodeState	計算節點的目前狀態。 現成/低優先順序計算節點已先佔。 當另一個計算節點可供使用時，系統會重新排程在計算節點上執行的工作。
stateTransitionTime	string	計算節點進入其目前狀態的時間。
totalTasksRun	integer	計算節點上已完成的作業工作總數。 這包括作業管理員工作和一般工作，但不包括作業準備、作業發行或啟動工作。
totalTasksSucceeded	integer	計算節點上成功完成的作業工作總數（含 exitCode 0）。 這包括作業管理員工作和一般工作，但不包括作業準備、作業發行或啟動工作。
url	string	計算節點的 URL。
virtualMachineInfo	VirtualMachineInfo	虛擬機目前狀態的相關信息。
vmSize	string	裝載計算節點的虛擬機大小。 如需集區中虛擬機可用大小的相關信息，請參閱在 Azure Batch 集區中為計算節點選擇 VM 大小（https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes）。

ComputeNodeEndpointConfiguration

計算節點的端點組態。

名稱	類型	Description
inboundEndpoints	InboundEndpoint[]	計算節點上可存取的輸入端點清單。

ComputeNodeError

計算節點所遇到的錯誤。

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

ComputeNodeIdentityReference

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

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

ComputeNodeState

計算節點的目前狀態。

名稱	類型	Description
creating	string	Batch 服務已從 Azure 計算取得基礎虛擬機，但尚未開始加入集區。
deallocated	string	計算節點已解除分配。
deallocating	string	計算節點正在解除分配。
idle	string	計算節點目前未執行工作。
leavingpool	string	計算節點會離開集區，可能是因為使用者已明確移除集區，或是因為集區重設大小或自動調整。
offline	string	計算節點目前未執行工作，且已停用對計算節點的新工作排程。
preempted	string	現成/低優先順序計算節點已先佔。 當另一個計算節點可供使用時，系統會重新排程在計算節點上執行的工作。
rebooting	string	計算節點正在重新啟動。
reimaging	string	計算節點正在重新映像。
running	string	計算節點正在執行一或多個工作（除了 StartTask 以外）。
starting	string	Batch 服務正在基礎虛擬機上啟動。
starttaskfailed	string	StartTask 在計算節點上失敗（且已耗盡所有重試），並已設定 waitForSuccess。 計算節點無法用於執行工作。
unknown	string	Batch 服務已失去與計算節點的連絡，且不知道其真實狀態。
unusable	string	計算節點因錯誤而無法用於工作執行。
upgradingos	string	計算節點正在進行作業系統升級作業。
waitingforstarttask	string	StartTask 已開始在計算節點上執行，但 waitForSuccess 已設定，而且 StartTask 尚未完成。

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	要登入登錄伺服器的用戶名稱。

ContainerWorkingDirectory

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

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

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	訊息的文字。

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。

InboundEndpoint

計算節點上的輸入端點。

名稱	類型	Description
backendPort	integer	端點的後埠號碼。
frontendPort	integer	端點的公用埠號碼。
name	string	端點的名稱。
protocol	InboundEndpointProtocol	端點的通訊協定。
publicFQDN	string	計算節點的公用完整功能變數名稱。
publicIPAddress	string	計算節點的公用IP位址。

InboundEndpointProtocol

端點的通訊協定。

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

NameValuePair

表示名稱/值組。

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

NodeAgentInformation

計算節點代理程式的相關信息。

名稱	類型	Description
lastUpdateTime	string	計算節點代理程式在計算節點上更新的時間。 這是計算節點代理程式最近更新為新版本的時間。
version	string	在計算節點上執行的 Batch 計算節點代理程式版本。 您可以針對位於 https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md的計算節點代理程式版本資訊檢查此版本號碼。

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 以允許公用存取。

SchedulingState

計算節點是否可供工作排程使用。

名稱	類型	Description
disabled	string	計算節點上不會排程任何新的工作。 已在計算節點上執行的工作可能仍會執行到完成。 所有計算節點都會從啟用排程開始。
enabled	string	工作可以在計算節點上排程。

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。

StartTaskInformation

在計算節點上執行的 StartTask 相關信息。

名稱	類型	Description
containerInfo	TaskContainerExecutionInformation	工作執行所在的容器相關信息。 只有當 Task 在容器內容中執行時，才會設定這個屬性。
endTime	string	StartTask 停止執行的時間。 這是最近一次 StartTask 執行的結束時間，如果該回合已完成（即使該執行失敗，且重試擱置中也一樣）。 如果 StartTask 目前正在執行，則此元素不存在。
exitCode	integer	StartTask 命令行上指定之程序的結束代碼。 只有當 StartTask 處於已完成狀態時，才會設定此屬性。 一般而言，進程的結束代碼會反映應用程式開發人員針對該程序實作的特定慣例。 如果您使用結束代碼值在程式碼中做出決策，請確定您知道應用程式程式所使用的結束代碼慣例。 不過，如果 Batch 服務終止 StartTask （因為逾時或使用者透過 API 終止），您可能會看到操作系統定義的結束代碼。
failureInfo	TaskFailureInformation	描述工作失敗的資訊，如果有的話。 只有當 Task 處於已完成狀態且發生失敗時，才會設定這個屬性。
lastRetryTime	string	工作開始執行的最近一次重試。 只有在重試 Task 時，才會有此元素（亦即 retryCount 為非零值）。 如果存在，這通常與 startTime 相同，但如果工作因為重試以外的原因而重新啟動，則可能會不同;例如，如果計算節點在重試期間重新啟動，則會更新 startTime，但 lastRetryTime 不是。
result	TaskExecutionResult	工作執行的結果。 如果值為 『failed』，則可以在 failureInfo 屬性中找到失敗的詳細數據。
retryCount	integer	Batch 服務重試工作次數。 工作應用程式失敗（非零結束代碼）會重試、前置處理錯誤（無法執行工作），而且不會重試檔案上傳錯誤。 Batch 服務會將工作重試到條件約束所指定的限制。
startTime	string	StartTask 開始執行的時間。 每次重新啟動或重試工作時，都會重設此值（也就是說，這是 StartTask 開始執行的最新時間）。
state	StartTaskState	計算節點上 StartTask 的狀態。

StartTaskState

計算節點上 StartTask 的狀態。

名稱	類型	Description
completed	string	StartTask 已結束，結束代碼為 0，或 StartTask 失敗，且已達到重試限制，或 StartTask 程式因工作準備錯誤而未執行（例如資源文件下載失敗）。
running	string	StartTask 目前正在執行中。

TaskContainerExecutionInformation

包含工作執行所在的容器相關信息。

名稱	類型	Description
containerId	string	容器的標識碼。
error	string	容器的詳細錯誤資訊。 如果有的話，這是 Docker 服務的詳細錯誤字串。 它相當於 「docker inspect」 所傳回的錯誤欄位。
state	string	容器的狀態。 這是根據 Docker 服務的狀態容器。 它相當於 「docker inspect」 所傳回的狀態欄位。

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』。

TaskExecutionInformation

工作執行的相關信息。

名稱	類型	Description
containerInfo	TaskContainerExecutionInformation	工作執行所在的容器相關信息。 只有當 Task 在容器內容中執行時，才會設定這個屬性。
endTime	string	工作完成的時間。 只有當 Task 處於 [已完成] 狀態時，才會設定此屬性。
exitCode	integer	Task 命令行上指定之程序的結束代碼。 只有當 Task 處於已完成狀態時，才會設定這個屬性。 一般而言，進程的結束代碼會反映應用程式開發人員針對該程序實作的特定慣例。 如果您使用結束代碼值在程式碼中做出決策，請確定您知道應用程式程式所使用的結束代碼慣例。 不過，如果 Batch 服務終止工作（因為逾時或使用者透過 API 終止），您可能會看到作業系統定義的結束代碼。
failureInfo	TaskFailureInformation	描述工作失敗的資訊，如果有的話。 只有當 Task 處於已完成狀態且發生失敗時，才會設定這個屬性。
lastRequeueTime	string	根據使用者要求，Batch 服務已重新排入佇列工作的最新時間。 只有當 requeueCount 為非零時，才會設定此屬性。
lastRetryTime	string	工作開始執行的最近一次重試。 只有在重試 Task 時，才會有此元素（亦即 retryCount 為非零值）。 如果存在，這通常與 startTime 相同，但如果工作因為重試以外的原因而重新啟動，則可能會不同;例如，如果計算節點在重試期間重新啟動，則會更新 startTime，但 lastRetryTime 不是。
requeueCount	integer	Batch 服務因使用者要求而重新排入佇列的次數。 當使用者從集區中移除計算節點（藉由調整/壓縮集區）或停用作業時，使用者可以指定在計算節點上執行的工作重新排入佇列以供執行。 此計數會追蹤工作因這些原因重新排入佇列的次數。
result	TaskExecutionResult	工作執行的結果。 如果值為 『failed』，則可以在 failureInfo 屬性中找到失敗的詳細數據。
retryCount	integer	Batch 服務重試工作次數。 工作應用程式失敗（非零結束代碼）會重試、前置處理錯誤（無法執行工作），而且不會重試檔案上傳錯誤。 Batch 服務會將工作重試到條件約束所指定的限制。
startTime	string	工作開始執行的時間。 'Running' 會對應至執行狀態，因此如果 Task 指定資源檔或套件，則開始時間會反映工作開始下載或部署這些資源文件的時間。 如果工作已重新啟動或重試，這是工作開始執行的最新時間。 此屬性僅適用於處於執行中或已完成狀態的工作。

TaskExecutionResult

工作執行的結果。

名稱	類型	Description
failure	string	處理工作時發生錯誤。 在啟動工作進程、執行工作進程或工作進程結束之後，可能會發生失敗。
success	string	工作已成功執行。

TaskFailureInformation

工作失敗的相關信息。

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

TaskInformation

計算節點上執行之工作的相關信息。

名稱	類型	Description
executionInfo	TaskExecutionInformation	工作執行的相關信息。
jobId	string	工作所屬之作業的標識碼。
subtaskId	integer	如果Task是多重實例工作，則子工作的標識碼。
taskId	string	工作的標識碼。
taskState	TaskState	Task 的目前狀態。
taskUrl	string	工作的 URL。

TaskState

Task 的狀態。

名稱	類型	Description
active	string	工作已排入佇列且能夠執行，但目前未指派給計算節點。 工作會在建立時、停用后啟用時，或是在失敗執行后等候重試時輸入此狀態。
completed	string	工作已不再有資格執行，通常是因為工作已順利完成，或工作已順利完成，且已用盡其重試限制。 如果啟動工作時發生錯誤，或工作已終止，工作也會標示為已完成。
preparing	string	工作已指派給計算節點，但正在等候必要的作業準備工作在計算節點上完成。 如果作業準備工作成功，工作將會移至執行中。 如果作業準備工作失敗，工作會返回作用中，而且有資格指派給不同的計算節點。
running	string	工作正在計算節點上執行。 這包括工作層級的準備工作，例如下載資源檔或部署工作上指定的套件 - 這不一定表示 Task 命令行已開始執行。

UserIdentity

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

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

VirtualMachineInfo

虛擬機目前狀態的相關信息。

名稱	類型	Description
imageReference	ImageReference	Azure 虛擬機 Marketplace 映像的參考。
scaleSetVmResourceId	string	計算節點目前虛擬機擴展集 VM 的資源識別碼。 只有在 Batch 帳戶建立時，才會將其 poolAllocationMode 屬性設定為 『UserSubscription』。