@azure/batch package
類別
| Account |
代表 Account 的類別。 |
| Application |
代表應用程式的類別。 |
| BatchServiceClient | |
| BatchServiceClientContext | |
| BatchSharedKeyCredentials |
建立新的 BatchSharedKeyCredentials 物件。 |
| CertificateOperations |
代表 CertificateOperations 的類別。 |
| ComputeNodeOperations |
代表 ComputeNodeOperations 的類別。 |
| File |
代表檔案的類別。 |
| Job |
代表作業的類別。 |
| JobSchedule |
代表 JobSchedule 的類別。 |
| Pool |
代表集區的類別。 |
| Task |
代表Task的類別。 |
介面
| AccountListPoolNodeCountsHeaders |
定義 ListPoolNodeCounts 作業的標頭。 |
| AccountListPoolNodeCountsNextOptionalParams |
選擇性參數。 |
| AccountListPoolNodeCountsNextOptions |
listPoolNodeCountsNext 作業的其他參數。 |
| AccountListPoolNodeCountsOptionalParams |
選擇性參數。 |
| AccountListPoolNodeCountsOptions |
listPoolNodeCounts 作業的其他參數。 |
| AccountListSupportedImagesHeaders |
定義 ListSupportedImages 作業的標頭。 |
| AccountListSupportedImagesNextOptionalParams |
選擇性參數。 |
| AccountListSupportedImagesNextOptions |
listSupportedImagesNext 作業的其他參數。 |
| AccountListSupportedImagesOptionalParams |
選擇性參數。 |
| AccountListSupportedImagesOptions |
listSupportedImages 作業的其他參數。 |
| AccountListSupportedImagesResult | |
| AffinityInformation |
表示 AffinityInformation 的介面。 |
| ApplicationGetHeaders |
定義取得作業的標頭。 |
| ApplicationGetOptionalParams |
選擇性參數。 |
| ApplicationGetOptions |
取得作業的其他參數。 |
| ApplicationListHeaders |
定義清單作業的標頭。 |
| ApplicationListNextOptionalParams |
選擇性參數。 |
| ApplicationListNextOptions |
listNext 作業的其他參數。 |
| ApplicationListOptionalParams |
選擇性參數。 |
| ApplicationListOptions |
清單作業的其他參數。 |
| ApplicationListResult | |
| ApplicationPackageReference |
表示 ApplicationPackageReference 的介面。 |
| ApplicationSummary |
代表 ApplicationSummary 的介面。 |
| AuthenticationTokenSettings |
表示 AuthenticationTokenSettings 的介面。 |
| AutoPoolSpecification |
表示 AutoPoolSpecification 的介面。 |
| AutoScaleRun |
表示 AutoScaleRun 的介面。 |
| AutoScaleRunError |
表示 AutoScaleRunError 的介面。 |
| AutoUserSpecification |
表示 AutoUserSpecification 的介面。 |
| AzureBlobFileSystemConfiguration |
代表 AzureBlobFileSystemConfiguration 的介面。 |
| AzureFileShareConfiguration |
代表 AzureFileShareConfiguration 的介面。 |
| BaseResource | |
| BatchError |
代表 BatchError 的介面。 |
| BatchErrorDetail |
代表 BatchErrorDetail 的介面。 |
| Certificate |
可在計算節點上安裝的憑證,可用來驗證計算機上的作業。 |
| CertificateAddHeaders |
定義 Add 作業的標頭。 |
| CertificateAddOptionalParams |
選擇性參數。 |
| CertificateAddOptions |
新增作業的其他參數。 |
| CertificateAddParameter |
表示 CertificateAddParameter 的介面。 |
| CertificateCancelDeletionHeaders |
定義 CancelDeletion 作業的標頭。 |
| CertificateCancelDeletionOptionalParams |
選擇性參數。 |
| CertificateCancelDeletionOptions |
cancelDeletion 作業的其他參數。 |
| CertificateDeleteHeaders |
定義Delete作業的標頭。 |
| CertificateDeleteMethodOptionalParams |
選擇性參數。 |
| CertificateDeleteMethodOptions |
deleteMethod 作業的其他參數。 |
| CertificateGetHeaders |
定義取得作業的標頭。 |
| CertificateGetOptionalParams |
選擇性參數。 |
| CertificateGetOptions |
取得作業的其他參數。 |
| CertificateListHeaders |
定義清單作業的標頭。 |
| CertificateListNextOptionalParams |
選擇性參數。 |
| CertificateListNextOptions |
listNext 作業的其他參數。 |
| CertificateListOptionalParams |
選擇性參數。 |
| CertificateListOptions |
清單作業的其他參數。 |
| CertificateListResult | |
| CertificateReference |
表示 CertificateReference 的介面。 |
| CIFSMountConfiguration |
表示 CIFSMountConfiguration 的介面。 |
| CloudError | |
| CloudJob |
代表 CloudJob 的介面。 |
| CloudJobListPreparationAndReleaseTaskStatusResult | |
| CloudJobListResult | |
| CloudJobSchedule |
代表 CloudJobSchedule 的介面。 |
| CloudJobScheduleListResult | |
| CloudPool |
代表 CloudPool 的介面。 |
| CloudPoolListResult | |
| CloudServiceConfiguration |
代表 CloudServiceConfiguration 的介面。 |
| CloudTask |
批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時,包括 (但不限於) 。 由於復原作業的重試與 無關,而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0,由於復原作業,可能會發生內部重試。 因此,所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動,而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 |
| CloudTaskListResult | |
| CloudTaskListSubtasksResult |
代表 CloudTaskListSubtasksResult 的介面。 |
| ComputeNode |
表示 ComputeNode 的介面。 |
| ComputeNodeAddUserHeaders |
定義 AddUser 作業的標頭。 |
| ComputeNodeAddUserOptionalParams |
選擇性參數。 |
| ComputeNodeAddUserOptions |
addUser 作業的其他參數。 |
| ComputeNodeDeleteUserHeaders |
定義DeleteUser作業的標頭。 |
| ComputeNodeDeleteUserOptionalParams |
選擇性參數。 |
| ComputeNodeDeleteUserOptions |
deleteUser 作業的其他參數。 |
| ComputeNodeDisableSchedulingHeaders |
定義 DisableScheduling 作業的標頭。 |
| ComputeNodeDisableSchedulingOptionalParams |
選擇性參數。 |
| ComputeNodeDisableSchedulingOptions |
disableScheduling 作業的其他參數。 |
| ComputeNodeEnableSchedulingHeaders |
定義 EnableScheduling 作業的標頭。 |
| ComputeNodeEnableSchedulingOptionalParams |
選擇性參數。 |
| ComputeNodeEnableSchedulingOptions |
enableScheduling 作業的其他參數。 |
| ComputeNodeEndpointConfiguration |
表示 ComputeNodeEndpointConfiguration 的介面。 |
| ComputeNodeError |
表示 ComputeNodeError 的介面。 |
| ComputeNodeGetHeaders |
定義取得作業的標頭。 |
| ComputeNodeGetOptionalParams |
選擇性參數。 |
| ComputeNodeGetOptions |
取得作業的其他參數。 |
| ComputeNodeGetRemoteDesktopHeaders |
定義 GetRemoteDesktop 作業的標頭。 |
| ComputeNodeGetRemoteDesktopOptionalParams |
選擇性參數。 |
| ComputeNodeGetRemoteDesktopOptions |
getRemoteDesktop 作業的其他參數。 |
| ComputeNodeGetRemoteLoginSettingsHeaders |
定義 GetRemoteLoginSettings 作業的標頭。 |
| ComputeNodeGetRemoteLoginSettingsOptionalParams |
選擇性參數。 |
| ComputeNodeGetRemoteLoginSettingsOptions |
getRemoteLoginSettings 作業的其他參數。 |
| ComputeNodeGetRemoteLoginSettingsResult |
表示 ComputeNodeGetRemoteLoginSettingsResult 的介面。 |
| ComputeNodeInformation |
表示 ComputeNodeInformation 的介面。 |
| ComputeNodeListHeaders |
定義清單作業的標頭。 |
| ComputeNodeListNextOptionalParams |
選擇性參數。 |
| ComputeNodeListNextOptions |
listNext 作業的其他參數。 |
| ComputeNodeListOptionalParams |
選擇性參數。 |
| ComputeNodeListOptions |
清單作業的其他參數。 |
| ComputeNodeListResult | |
| ComputeNodeRebootHeaders |
定義重新啟動作業的標頭。 |
| ComputeNodeRebootOptionalParams |
選擇性參數。 |
| ComputeNodeRebootOptions |
重新啟動作業的其他參數。 |
| ComputeNodeReimageHeaders |
定義 Reimage 作業的標頭。 |
| ComputeNodeReimageOptionalParams |
選擇性參數。 |
| ComputeNodeReimageOptions |
重新安裝映像作業的其他參數。 |
| ComputeNodeUpdateUserHeaders |
定義UpdateUser作業的標頭。 |
| ComputeNodeUpdateUserOptionalParams |
選擇性參數。 |
| ComputeNodeUpdateUserOptions |
updateUser 作業的其他參數。 |
| ComputeNodeUploadBatchServiceLogsHeaders |
定義 UploadBatchServiceLogs 作業的標頭。 |
| ComputeNodeUploadBatchServiceLogsOptionalParams |
選擇性參數。 |
| ComputeNodeUploadBatchServiceLogsOptions |
uploadBatchServiceLogs 作業的其他參數。 |
| ComputeNodeUser |
表示 ComputeNodeUser 的介面。 |
| ContainerConfiguration |
表示 ContainerConfiguration 的介面。 |
| ContainerRegistry |
代表 ContainerRegistry 的介面。 |
| DataDisk |
表示 DataDisk 的介面。 |
| DeleteCertificateError |
代表 DeleteCertificateError 的介面。 |
| DiskEncryptionConfiguration |
在集區中的計算節點上套用的磁碟加密組態。 使用共用映像庫映像建立的Linux集區不支援磁碟加密設定。 |
| EnvironmentSetting |
代表 EnvironmentSetting 的介面。 |
| ErrorMessage |
表示 ErrorMessage 的介面。 |
| ExitCodeMapping |
代表 ExitCodeMapping 的介面。 |
| ExitCodeRangeMapping |
代表 ExitCodeRangeMapping 的介面。 |
| ExitConditions |
代表 ExitConditions 的介面。 |
| ExitOptions |
代表 ExitOptions 的介面。 |
| FileDeleteFromComputeNodeHeaders |
定義DeleteFromComputeNode作業的標頭。 |
| FileDeleteFromComputeNodeOptionalParams |
選擇性參數。 |
| FileDeleteFromComputeNodeOptions |
deleteFromComputeNode 作業的其他參數。 |
| FileDeleteFromTaskHeaders |
定義DeleteFromTask作業的標頭。 |
| FileDeleteFromTaskOptionalParams |
選擇性參數。 |
| FileDeleteFromTaskOptions |
deleteFromTask 作業的其他參數。 |
| FileGetFromComputeNodeHeaders |
定義 GetFromComputeNode 作業的標頭。 |
| FileGetFromComputeNodeOptionalParams |
選擇性參數。 |
| FileGetFromComputeNodeOptions |
getFromComputeNode 作業的其他參數。 |
| FileGetFromTaskHeaders |
定義 GetFromTask 作業的標頭。 |
| FileGetFromTaskOptionalParams |
選擇性參數。 |
| FileGetFromTaskOptions |
getFromTask 作業的其他參數。 |
| FileGetPropertiesFromComputeNodeHeaders |
定義 GetPropertiesFromComputeNode 作業的標頭。 |
| FileGetPropertiesFromComputeNodeOptionalParams |
選擇性參數。 |
| FileGetPropertiesFromComputeNodeOptions |
getPropertiesFromComputeNode 作業的其他參數。 |
| FileGetPropertiesFromTaskHeaders |
定義 GetPropertiesFromTask 作業的標頭。 |
| FileGetPropertiesFromTaskOptionalParams |
選擇性參數。 |
| FileGetPropertiesFromTaskOptions |
getPropertiesFromTask 作業的其他參數。 |
| FileListFromComputeNodeHeaders |
定義 ListFromComputeNode 作業的標頭。 |
| FileListFromComputeNodeNextOptionalParams |
選擇性參數。 |
| FileListFromComputeNodeNextOptions |
listFromComputeNodeNext 作業的其他參數。 |
| FileListFromComputeNodeOptionalParams |
選擇性參數。 |
| FileListFromComputeNodeOptions |
listFromComputeNode 作業的其他參數。 |
| FileListFromTaskHeaders |
定義 ListFromTask 作業的標頭。 |
| FileListFromTaskNextOptionalParams |
選擇性參數。 |
| FileListFromTaskNextOptions |
listFromTaskNext 作業的其他參數。 |
| FileListFromTaskOptionalParams |
選擇性參數。 |
| FileListFromTaskOptions |
listFromTask 作業的其他參數。 |
| FileProperties |
表示 FileProperties 的介面。 |
| ImageInformation |
表示 ImageInformation 的介面。 |
| ImageReference |
表示 ImageReference 的介面。 |
| InboundEndpoint |
表示 InboundEndpoint 的介面。 |
| InboundNATPool |
表示 InboundNATPool 的介面。 |
| JobAddHeaders |
定義 Add 作業的標頭。 |
| JobAddOptionalParams |
選擇性參數。 |
| JobAddOptions |
新增作業的其他參數。 |
| JobAddParameter |
表示 JobAddParameter 的介面。 |
| JobConstraints |
代表 JobConstraints 的介面。 |
| JobDeleteHeaders |
定義Delete作業的標頭。 |
| JobDeleteMethodOptionalParams |
選擇性參數。 |
| JobDeleteMethodOptions |
deleteMethod 作業的其他參數。 |
| JobDisableHeaders |
定義 Disable 作業的標頭。 |
| JobDisableOptionalParams |
選擇性參數。 |
| JobDisableOptions |
停用作業的其他參數。 |
| JobDisableParameter |
代表 JobDisableParameter 的介面。 |
| JobEnableHeaders |
定義啟用作業的標頭。 |
| JobEnableOptionalParams |
選擇性參數。 |
| JobEnableOptions |
啟用作業的其他參數。 |
| JobExecutionInformation |
表示 JobExecutionInformation 的介面。 |
| JobGetAllLifetimeStatisticsHeaders |
定義 GetAllLifetimeStatistics 作業的標頭。 |
| JobGetAllLifetimeStatisticsOptionalParams |
選擇性參數。 |
| JobGetAllLifetimeStatisticsOptions |
getAllLifetimeStatistics 作業的其他參數。 |
| JobGetHeaders |
定義取得作業的標頭。 |
| JobGetOptionalParams |
選擇性參數。 |
| JobGetOptions |
取得作業的其他參數。 |
| JobGetTaskCountsHeaders |
定義 GetTaskCounts 作業的標頭。 |
| JobGetTaskCountsOptionalParams |
選擇性參數。 |
| JobGetTaskCountsOptions |
getTaskCounts 作業的其他參數。 |
| JobListFromJobScheduleHeaders |
定義 ListFromJobSchedule 作業的標頭。 |
| JobListFromJobScheduleNextOptionalParams |
選擇性參數。 |
| JobListFromJobScheduleNextOptions |
listFromJobScheduleNext 作業的其他參數。 |
| JobListFromJobScheduleOptionalParams |
選擇性參數。 |
| JobListFromJobScheduleOptions |
listFromJobSchedule 作業的其他參數。 |
| JobListHeaders |
定義清單作業的標頭。 |
| JobListNextOptionalParams |
選擇性參數。 |
| JobListNextOptions |
listNext 作業的其他參數。 |
| JobListOptionalParams |
選擇性參數。 |
| JobListOptions |
清單作業的其他參數。 |
| JobListPreparationAndReleaseTaskStatusHeaders |
定義 ListPreparationAndReleaseTaskStatus 作業的標頭。 |
| JobListPreparationAndReleaseTaskStatusNextOptionalParams |
選擇性參數。 |
| JobListPreparationAndReleaseTaskStatusNextOptions |
listPreparationAndReleaseTaskStatusNext 作業的其他參數。 |
| JobListPreparationAndReleaseTaskStatusOptionalParams |
選擇性參數。 |
| JobListPreparationAndReleaseTaskStatusOptions |
listPreparationAndReleaseTaskStatus 作業的其他參數。 |
| JobManagerTask |
作業管理員工作會在建立作業時自動啟動。 Batch 服務會嘗試在作業的任何其他工作之前排程作業管理員工作。 壓縮集區時,Batch 服務會嘗試保留作業管理員工作儘可能長時間執行的節點(也就是在執行作業管理員工作的計算節點之前,會移除執行「一般」工作的計算節點)。 當作業管理員工作失敗且需要重新啟動時,系統會嘗試以最高優先順序排程它。 如果沒有可用的閑置計算節點,系統可能會終止集區中其中一個執行中的工作,並將它傳回佇列,以便讓作業管理員工作能夠重新啟動。 請注意,一個作業中的作業管理員工作不會優先於其他作業中的工作。 跨作業,只會觀察到作業層級優先順序。 例如,如果優先順序為 0 作業的作業管理員需要重新啟動,則不會取代優先順序 1 作業的工作。 批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時,包括 (但不限於) 。 由於復原作業的重試與 無關,而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0,由於復原作業,可能會發生內部重試。 因此,所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動,而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 |
| JobNetworkConfiguration |
代表 JobNetworkConfiguration 的介面。 |
| JobPatchHeaders |
定義 Patch 作業的標頭。 |
| JobPatchOptionalParams |
選擇性參數。 |
| JobPatchOptions |
修補作業的其他參數。 |
| JobPatchParameter |
代表 JobPatchParameter 的介面。 |
| JobPreparationAndReleaseTaskExecutionInformation |
代表 JobPreparationAndReleaseTaskExecutionInformation 的介面。 |
| JobPreparationTask |
您可以使用作業準備來準備節點以執行作業的工作。 作業準備中通常執行的活動包括:下載作業中所有工作所使用的通用資源檔。 作業準備工作可以將這些通用資源檔下載到節點上的共用位置。 (AZ_BATCH_NODE_ROOT_DIR\shared),或啟動節點上的本地服務,讓該作業的所有工作都可以與其通訊。 如果作業準備工作失敗(也就是說,在結束代碼 0 之前耗盡重試計數),Batch 將不會在節點上執行此作業的工作。 計算節點仍無法執行此作業的工作,直到重新製作映像為止。 計算節點會維持使用中狀態,並可用於其他作業。 作業準備工作可以在相同的節點上執行多次。 因此,您應該撰寫作業準備工作來處理重新執行。 如果節點重新啟動,作業準備工作會在排程作業的任何其他工作之前,於計算節點上再次執行,如果 rerunOnNodeRebootAfterSuccess 為 true,或作業準備工作先前未完成。 如果重新製作節點映像,作業準備工作會在排程作業的任何工作之前再次執行。 批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時,包括 (但不限於) 。 由於復原作業的重試與 無關,而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0,由於復原作業,可能會發生內部重試。 因此,所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動,而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 |
| JobPreparationTaskExecutionInformation |
代表 JobPreparationTaskExecutionInformation 的介面。 |
| JobReleaseTask |
作業發行工作會在作業結束時執行,因為下列其中一項原因:使用者呼叫終止作業 API,或在作業仍在使用中時刪除作業 API、達到作業的時鐘時間限制上限,且作業仍在使用中,或作業的作業管理員工作完成,且作業設定為在作業管理員完成時終止。 作業發行工作會在作業的工作執行所在的每個節點上執行,以及作業準備工作執行並完成。 如果您在執行作業準備工作之後重新設定節點的映像,而作業會在該節點上執行的任何進一步工作結束(因此作業準備工作不會重新執行),則作業發行工作不會在該計算節點上執行。 如果節點在作業發行工作仍在執行時重新啟動,當計算節點啟動時,作業發行工作會再次執行。 在完成所有作業發行工作之前,作業不會標示為完成。 作業發行工作會在背景執行。 它不會佔用排程位置;也就是說,它不會計入集區上指定的 taskSlotsPerNode 限制。 |
| JobReleaseTaskExecutionInformation |
代表 JobReleaseTaskExecutionInformation 的介面。 |
| JobScheduleAddHeaders |
定義 Add 作業的標頭。 |
| JobScheduleAddOptionalParams |
選擇性參數。 |
| JobScheduleAddOptions |
新增作業的其他參數。 |
| JobScheduleAddParameter |
代表 JobScheduleAddParameter 的介面。 |
| JobScheduleDeleteHeaders |
定義Delete作業的標頭。 |
| JobScheduleDeleteMethodOptionalParams |
選擇性參數。 |
| JobScheduleDeleteMethodOptions |
deleteMethod 作業的其他參數。 |
| JobScheduleDisableHeaders |
定義 Disable 作業的標頭。 |
| JobScheduleDisableOptionalParams |
選擇性參數。 |
| JobScheduleDisableOptions |
停用作業的其他參數。 |
| JobScheduleEnableHeaders |
定義啟用作業的標頭。 |
| JobScheduleEnableOptionalParams |
選擇性參數。 |
| JobScheduleEnableOptions |
啟用作業的其他參數。 |
| JobScheduleExecutionInformation |
代表 JobScheduleExecutionInformation 的介面。 |
| JobScheduleExistsHeaders |
定義 Exists 作業的標頭。 |
| JobScheduleExistsOptionalParams |
選擇性參數。 |
| JobScheduleExistsOptions |
存在作業的其他參數。 |
| JobScheduleGetHeaders |
定義取得作業的標頭。 |
| JobScheduleGetOptionalParams |
選擇性參數。 |
| JobScheduleGetOptions |
取得作業的其他參數。 |
| JobScheduleListHeaders |
定義清單作業的標頭。 |
| JobScheduleListNextOptionalParams |
選擇性參數。 |
| JobScheduleListNextOptions |
listNext 作業的其他參數。 |
| JobScheduleListOptionalParams |
選擇性參數。 |
| JobScheduleListOptions |
清單作業的其他參數。 |
| JobSchedulePatchHeaders |
定義 Patch 作業的標頭。 |
| JobSchedulePatchOptionalParams |
選擇性參數。 |
| JobSchedulePatchOptions |
修補作業的其他參數。 |
| JobSchedulePatchParameter |
代表 JobSchedulePatchParameter 的介面。 |
| JobScheduleStatistics |
代表 JobScheduleStatistics 的介面。 |
| JobScheduleTerminateHeaders |
定義 Terminate 作業的標頭。 |
| JobScheduleTerminateOptionalParams |
選擇性參數。 |
| JobScheduleTerminateOptions |
終止作業的其他參數。 |
| JobScheduleUpdateHeaders |
定義更新作業的標頭。 |
| JobScheduleUpdateOptionalParams |
選擇性參數。 |
| JobScheduleUpdateOptions |
更新作業的其他參數。 |
| JobScheduleUpdateParameter |
代表 JobScheduleUpdateParameter 的介面。 |
| JobSchedulingError |
代表 JobSchedulingError 的介面。 |
| JobSpecification |
表示 JobSpecification 的介面。 |
| JobStatistics |
表示JobStatistics的介面。 |
| JobTerminateHeaders |
定義 Terminate 作業的標頭。 |
| JobTerminateOptionalParams |
選擇性參數。 |
| JobTerminateOptions |
終止作業的其他參數。 |
| JobTerminateParameter |
表示 JobTerminateParameter 的介面。 |
| JobUpdateHeaders |
定義更新作業的標頭。 |
| JobUpdateOptionalParams |
選擇性參數。 |
| JobUpdateOptions |
更新作業的其他參數。 |
| JobUpdateParameter |
表示JobUpdateParameter的介面。 |
| LinuxUserConfiguration |
代表 LinuxUserConfiguration 的介面。 |
| MetadataItem |
Batch 服務不會指派任何意義給此元數據;它僅供使用者程式代碼使用。 |
| MountConfiguration |
表示 MountConfiguration 的介面。 |
| MultiInstanceSettings |
多重實例工作通常用於支援 MPI 工作。 在 MPI 案例中,如果任一子工作失敗(例如,由於以非零結束代碼結束),則整個多重實例工作會失敗。 然後,多實例工作會終止並重試,達到其重試限制。 |
| NameValuePair |
代表 NameValuePair 的介面。 |
| NetworkConfiguration |
集區的網路組態。 |
| NetworkSecurityGroupRule |
代表 NetworkSecurityGroupRule 的介面。 |
| NFSMountConfiguration |
表示 NFSMountConfiguration 的介面。 |
| NodeAgentInformation |
Batch Compute Node 代理程式是一個程式,可在集區中的每個計算節點上執行,並提供計算節點上的 Batch 功能。 |
| NodeCounts |
代表 NodeCounts 的介面。 |
| NodeDisableSchedulingParameter |
代表 NodeDisableSchedulingParameter 的介面。 |
| NodeFile |
代表 NodeFile 的介面。 |
| NodeFileListResult | |
| NodeRebootParameter |
代表 NodeRebootParameter 的介面。 |
| NodeReimageParameter |
代表 NodeReimageParameter 的介面。 |
| NodeRemoveParameter |
代表 NodeRemoveParameter 的介面。 |
| NodeUpdateUserParameter |
代表 NodeUpdateUserParameter 的介面。 |
| OutputFile |
在每個檔案上傳上,Batch 服務會將兩個記錄檔寫入計算節點 'fileuploadout.txt' 和 'fileuploaderr.txt'。 這些記錄檔可用來深入瞭解特定失敗。 |
| OutputFileBlobContainerDestination |
代表 OutputFileBlobContainerDestination 的介面。 |
| OutputFileDestination |
表示 OutputFileDestination 的介面。 |
| OutputFileUploadOptions |
代表 OutputFileUploadOptions 的介面。 |
| PoolAddHeaders |
定義 Add 作業的標頭。 |
| PoolAddOptionalParams |
選擇性參數。 |
| PoolAddOptions |
新增作業的其他參數。 |
| PoolAddParameter |
代表 PoolAddParameter 的介面。 |
| PoolDeleteHeaders |
定義Delete作業的標頭。 |
| PoolDeleteMethodOptionalParams |
選擇性參數。 |
| PoolDeleteMethodOptions |
deleteMethod 作業的其他參數。 |
| PoolDisableAutoScaleHeaders |
定義 DisableAutoScale 作業的標頭。 |
| PoolDisableAutoScaleOptionalParams |
選擇性參數。 |
| PoolDisableAutoScaleOptions |
disableAutoScale 作業的其他參數。 |
| PoolEnableAutoScaleHeaders |
定義 EnableAutoScale 作業的標頭。 |
| PoolEnableAutoScaleOptionalParams |
選擇性參數。 |
| PoolEnableAutoScaleOptions |
enableAutoScale 作業的其他參數。 |
| PoolEnableAutoScaleParameter |
代表 PoolEnableAutoScaleParameter 的介面。 |
| PoolEndpointConfiguration |
代表PoolEndpointConfiguration的介面。 |
| PoolEvaluateAutoScaleHeaders |
定義 EvaluateAutoScale 作業的標頭。 |
| PoolEvaluateAutoScaleOptionalParams |
選擇性參數。 |
| PoolEvaluateAutoScaleOptions |
evaluateAutoScale 作業的其他參數。 |
| PoolEvaluateAutoScaleParameter |
代表 PoolEvaluateAutoScaleParameter 的介面。 |
| PoolExistsHeaders |
定義 Exists 作業的標頭。 |
| PoolExistsOptionalParams |
選擇性參數。 |
| PoolExistsOptions |
存在作業的其他參數。 |
| PoolGetAllLifetimeStatisticsHeaders |
定義 GetAllLifetimeStatistics 作業的標頭。 |
| PoolGetAllLifetimeStatisticsOptionalParams |
選擇性參數。 |
| PoolGetAllLifetimeStatisticsOptions |
getAllLifetimeStatistics 作業的其他參數。 |
| PoolGetHeaders |
定義取得作業的標頭。 |
| PoolGetOptionalParams |
選擇性參數。 |
| PoolGetOptions |
取得作業的其他參數。 |
| PoolInformation |
表示PoolInformation的介面。 |
| PoolListHeaders |
定義清單作業的標頭。 |
| PoolListNextOptionalParams |
選擇性參數。 |
| PoolListNextOptions |
listNext 作業的其他參數。 |
| PoolListOptionalParams |
選擇性參數。 |
| PoolListOptions |
清單作業的其他參數。 |
| PoolListUsageMetricsHeaders |
定義 ListUsageMetrics 作業的標頭。 |
| PoolListUsageMetricsNextOptionalParams |
選擇性參數。 |
| PoolListUsageMetricsNextOptions |
listUsageMetricsNext 作業的其他參數。 |
| PoolListUsageMetricsOptionalParams |
選擇性參數。 |
| PoolListUsageMetricsOptions |
listUsageMetrics 作業的其他參數。 |
| PoolListUsageMetricsResult | |
| PoolNodeCounts |
代表 PoolNodeCounts 的介面。 |
| PoolNodeCountsListResult | |
| PoolPatchHeaders |
定義 Patch 作業的標頭。 |
| PoolPatchOptionalParams |
選擇性參數。 |
| PoolPatchOptions |
修補作業的其他參數。 |
| PoolPatchParameter |
代表PoolPatchParameter的介面。 |
| PoolRemoveNodesHeaders |
定義 RemoveNodes 作業的標頭。 |
| PoolRemoveNodesOptionalParams |
選擇性參數。 |
| PoolRemoveNodesOptions |
removeNodes 作業的其他參數。 |
| PoolResizeHeaders |
定義 Resize 作業的標頭。 |
| PoolResizeOptionalParams |
選擇性參數。 |
| PoolResizeOptions |
用於重設大小作業的其他參數。 |
| PoolResizeParameter |
代表 PoolResizeParameter 的介面。 |
| PoolSpecification |
表示 PoolSpecification 的介面。 |
| PoolStatistics |
表示PoolStatistics的介面。 |
| PoolStopResizeHeaders |
定義 StopResize 作業的標頭。 |
| PoolStopResizeOptionalParams |
選擇性參數。 |
| PoolStopResizeOptions |
stopResize 作業的其他參數。 |
| PoolUpdatePropertiesHeaders |
定義UpdateProperties作業的標頭。 |
| PoolUpdatePropertiesOptionalParams |
選擇性參數。 |
| PoolUpdatePropertiesOptions |
updateProperties 作業的其他參數。 |
| PoolUpdatePropertiesParameter |
代表 PoolUpdatePropertiesParameter 的介面。 |
| PoolUsageMetrics |
代表 PoolUsageMetrics 的介面。 |
| PublicIPAddressConfiguration |
集區網路設定的公用IP位址組態。 |
| RecentJob |
代表 RecentJob 的介面。 |
| ResizeError |
表示 ResizeError 的介面。 |
| ResourceFile |
代表 ResourceFile 的介面。 |
| ResourceStatistics |
表示 ResourceStatistics 的介面。 |
| Schedule |
表示排程的介面。 |
| StartTask |
批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時,包括 (但不限於) 。 由於復原作業的重試與 無關,而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0,由於復原作業,可能會發生內部重試。 因此,所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動,而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 在某些情況下,即使計算節點未重新啟動,StartTask 仍可能會重新執行。 請特別小心,以避免 StartTasks 從 StartTask 工作目錄建立中斷程式或安裝/啟動服務,因為這樣會阻止 Batch 重新執行 StartTask。 |
| StartTaskInformation |
表示 StartTaskInformation 的介面。 |
| SubtaskInformation |
表示 SubtaskInformation 的介面。 |
| TaskAddCollectionHeaders |
定義 AddCollection 作業的標頭。 |
| TaskAddCollectionOptionalParams |
選擇性參數。 |
| TaskAddCollectionOptions |
addCollection 作業的其他參數。 |
| TaskAddCollectionParameter |
代表TaskAddCollectionParameter的介面。 |
| TaskAddCollectionResult |
代表TaskAddCollectionResult的介面。 |
| TaskAddHeaders |
定義 Add 作業的標頭。 |
| TaskAddOptionalParams |
選擇性參數。 |
| TaskAddOptions |
新增作業的其他參數。 |
| TaskAddParameter |
批次會在節點上觸發復原作業時重試工作。 復原作業的範例包括當狀況不良的節點重新啟動或計算節點因主機失敗而消失時,包括 (但不限於) 。 由於復原作業的重試與 無關,而且不會計入 maxTaskRetryCount。 即使 maxTaskRetryCount 是 0,由於復原作業,可能會發生內部重試。 因此,所有工作都應該是等冪的。 這表示工作必須容許中斷並重新啟動,而不會造成任何損毀或重複的數據。 長時間執行工作的最佳做法是使用某種形式的檢查點。 |
| TaskAddResult |
代表 TaskAddResult 的介面。 |
| TaskConstraints |
代表TaskConstraints的介面。 |
| TaskContainerExecutionInformation |
代表TaskContainerExecutionInformation的介面。 |
| TaskContainerSettings |
代表 TaskContainerSettings 的介面。 |
| TaskCounts |
代表TaskCounts的介面。 |
| TaskCountsResult |
代表 TaskCountsResult 的介面。 |
| TaskDeleteHeaders |
定義Delete作業的標頭。 |
| TaskDeleteMethodOptionalParams |
選擇性參數。 |
| TaskDeleteMethodOptions |
deleteMethod 作業的其他參數。 |
| TaskDependencies |
代表 TaskDependencies 的介面。 |
| TaskExecutionInformation |
代表TaskExecutionInformation的介面。 |
| TaskFailureInformation |
代表 TaskFailureInformation 的介面。 |
| TaskGetHeaders |
定義取得作業的標頭。 |
| TaskGetOptionalParams |
選擇性參數。 |
| TaskGetOptions |
取得作業的其他參數。 |
| TaskIdRange |
範圍的開始和結尾是內含的。 例如,如果範圍有 9 開始和結束 12,則它代表工作 '9'、'10'、'11' 和 '12'。 |
| TaskInformation |
代表TaskInformation的介面。 |
| TaskListHeaders |
定義清單作業的標頭。 |
| TaskListNextOptionalParams |
選擇性參數。 |
| TaskListNextOptions |
listNext 作業的其他參數。 |
| TaskListOptionalParams |
選擇性參數。 |
| TaskListOptions |
清單作業的其他參數。 |
| TaskListSubtasksHeaders |
定義 ListSubtasks 作業的標頭。 |
| TaskListSubtasksOptionalParams |
選擇性參數。 |
| TaskListSubtasksOptions |
listSubtasks 作業的其他參數。 |
| TaskReactivateHeaders |
定義重新啟用作業的標頭。 |
| TaskReactivateOptionalParams |
選擇性參數。 |
| TaskReactivateOptions |
重新啟用作業的其他參數。 |
| TaskSchedulingPolicy |
代表 TaskSchedulingPolicy 的介面。 |
| TaskSlotCounts |
代表TaskSlotCounts的介面。 |
| TaskStatistics |
表示TaskStatistics的介面。 |
| TaskTerminateHeaders |
定義 Terminate 作業的標頭。 |
| TaskTerminateOptionalParams |
選擇性參數。 |
| TaskTerminateOptions |
終止作業的其他參數。 |
| TaskUpdateHeaders |
定義更新作業的標頭。 |
| TaskUpdateOptionalParams |
選擇性參數。 |
| TaskUpdateOptions |
更新作業的其他參數。 |
| TaskUpdateParameter |
代表TaskUpdateParameter的介面。 |
| UploadBatchServiceLogsConfiguration |
表示 UploadBatchServiceLogsConfiguration 的介面。 |
| UploadBatchServiceLogsResult |
代表 UploadBatchServiceLogsResult 的介面。 |
| UsageStatistics |
表示 UsageStatistics 的介面。 |
| UserAccount |
代表 UserAccount 的介面。 |
| UserIdentity |
指定userName或 autoUser 屬性,但不能同時指定兩者。 |
| VirtualMachineConfiguration |
代表 VirtualMachineConfiguration 的介面。 |
| WindowsConfiguration |
表示 WindowsConfiguration 的介面。 |
| WindowsUserConfiguration |
代表 WindowsUserConfiguration 的介面。 |
類型別名
| AccessScope |
定義 AccessScope 的值。 可能的值包括:'job' |
| AccountListPoolNodeCountsResponse |
包含 listPoolNodeCounts 作業的響應數據。 |
| AccountListSupportedImagesResponse |
包含 listSupportedImages 作業的響應數據。 |
| AllocationState |
定義 AllocationState 的值。 可能的值包括:'steady'、'resizing'、'stopping' |
| ApplicationGetResponse |
包含取得作業的回應數據。 |
| ApplicationListResponse |
包含清單作業的回應數據。 |
| AutoUserScope |
定義 AutoUserScope 的值。 可能的值包括:'task'、'pool' |
| CachingType |
定義 CachingType 的值。 可能的值包括:'none'、'readOnly'、'readWrite' |
| CertificateAddResponse |
包含新增作業的響應數據。 |
| CertificateCancelDeletionResponse |
包含 cancelDeletion 作業的響應數據。 |
| CertificateDeleteResponse |
包含 deleteMethod 作業的響應數據。 |
| CertificateFormat |
定義 CertificateFormat 的值。 可能的值包括:'pfx'、'cer' |
| CertificateGetResponse |
包含取得作業的回應數據。 |
| CertificateListResponse |
包含清單作業的回應數據。 |
| CertificateState |
定義 CertificateState 的值。 可能的值包括:'active'、'delete'、'deleteFailed' |
| CertificateStoreLocation |
定義 CertificateStoreLocation 的值。 可能的值包括:'currentUser'、'localMachine' |
| CertificateVisibility |
定義 CertificateVisibility 的值。 可能的值包括:'startTask'、'task'、'remoteUser' |
| ComputeNodeAddUserResponse |
包含 addUser 作業的響應數據。 |
| ComputeNodeDeallocationOption |
定義 ComputeNodeDeallocationOption 的值。 可能的值包括:'requeue'、'terminate'、'taskCompletion'、'retainedData' |
| ComputeNodeDeleteUserResponse |
包含 deleteUser 作業的響應數據。 |
| ComputeNodeDisableSchedulingResponse |
包含 disableScheduling 作業的響應數據。 |
| ComputeNodeEnableSchedulingResponse |
包含 enableScheduling 作業的響應數據。 |
| ComputeNodeFillType |
定義 ComputeNodeFillType 的值。 可能的值包括:'spread'、'pack' |
| ComputeNodeGetRemoteDesktopResponse |
包含 getRemoteDesktop 作業的響應數據。 |
| ComputeNodeGetRemoteLoginSettingsResponse |
包含 getRemoteLoginSettings 作業的響應數據。 |
| ComputeNodeGetResponse |
包含取得作業的回應數據。 |
| ComputeNodeListResponse |
包含清單作業的回應數據。 |
| ComputeNodeRebootOption |
定義 ComputeNodeRebootOption 的值。 可能的值包括:'requeue'、'terminate'、'taskCompletion'、'retainedData' |
| ComputeNodeRebootResponse |
包含重新啟動作業的響應數據。 |
| ComputeNodeReimageOption |
定義 ComputeNodeReimageOption 的值。 可能的值包括:'requeue'、'terminate'、'taskCompletion'、'retainedData' |
| ComputeNodeReimageResponse |
包含重新映像作業的響應數據。 |
| ComputeNodeState |
定義 ComputeNodeState 的值。 可能的值包括:'idle'、'rebooting'、'reimaging'、'running'、'unusable'、'creating'、'starting'、'waitingForStartTask'、'startTaskFailed'、'unknown'、'leavingPool'、'offline'、'preempted' |
| ComputeNodeUpdateUserResponse |
包含 updateUser 作業的響應數據。 |
| ComputeNodeUploadBatchServiceLogsResponse |
包含 uploadBatchServiceLogs 作業的響應數據。 |
| ContainerWorkingDirectory |
定義 ContainerWorkingDirectory 的值。 可能的值包括:'taskWorkingDirectory'、'containerImageDefault' |
| DependencyAction |
定義DependencyAction的值。 可能的值包括:'滿足'、'block' |
| DisableComputeNodeSchedulingOption |
定義 DisableComputeNodeSchedulingOption 的值。 可能的值包括:'requeue'、'terminate'、'taskCompletion' |
| DisableJobOption |
定義 DisableJobOption 的值。 可能的值包括:'requeue'、'terminate'、'wait' |
| DiskEncryptionTarget |
定義 DiskEncryptionTarget 的值。 可能的值包括:'OsDisk'、'TemporaryDisk' |
| DynamicVNetAssignmentScope |
定義 DynamicVNetAssignmentScope 的值。 可能的值包括:'none'、'job' |
| ElevationLevel |
定義 ElevationLevel 的值。 可能的值包括:'nonAdmin'、'admin' |
| ErrorCategory |
定義 ErrorCategory 的值。 可能的值包括:'userError'、'serverError' |
| FileDeleteFromComputeNodeResponse |
包含 deleteFromComputeNode 作業的響應數據。 |
| FileDeleteFromTaskResponse |
包含 deleteFromTask 作業的響應數據。 |
| FileGetFromComputeNodeResponse |
包含 getFromComputeNode 作業的響應數據。 |
| FileGetFromTaskResponse |
包含 getFromTask 作業的響應數據。 |
| FileGetPropertiesFromComputeNodeResponse |
包含 getPropertiesFromComputeNode 作業的響應數據。 |
| FileGetPropertiesFromTaskResponse |
包含 getPropertiesFromTask 作業的響應數據。 |
| FileListFromComputeNodeResponse |
包含 listFromComputeNode 作業的響應數據。 |
| FileListFromTaskResponse |
包含 listFromTask 作業的響應數據。 |
| InboundEndpointProtocol |
定義 InboundEndpointProtocol 的值。 可能的值包括:'tcp'、'udp' |
| IPAddressProvisioningType |
定義IPAddressProvisioningType的值。 可能的值包括:'batchManaged'、'userManaged'、'noPublicIPAddresses' |
| JobAction |
定義 JobAction 的值。 可能的值包括:'none'、'disable'、'terminate' |
| JobAddResponse |
包含新增作業的響應數據。 |
| JobDeleteResponse |
包含 deleteMethod 作業的響應數據。 |
| JobDisableResponse |
包含停用作業的響應數據。 |
| JobEnableResponse |
包含啟用作業的響應數據。 |
| JobGetAllLifetimeStatisticsResponse |
包含 getAllLifetimeStatistics 作業的響應數據。 |
| JobGetResponse |
包含取得作業的回應數據。 |
| JobGetTaskCountsResponse |
包含 getTaskCounts 作業的響應數據。 |
| JobListFromJobScheduleResponse |
包含 listFromJobSchedule 作業的響應數據。 |
| JobListPreparationAndReleaseTaskStatusResponse |
包含 listPreparationAndReleaseTaskStatus 作業的響應數據。 |
| JobListResponse |
包含清單作業的回應數據。 |
| JobPatchResponse |
包含修補作業的響應數據。 |
| JobPreparationTaskState |
定義 JobPreparationTaskState 的值。 可能的值包括:'running'、'completed' |
| JobReleaseTaskState |
定義 JobReleaseTaskState 的值。 可能的值包括:'running'、'completed' |
| JobScheduleAddResponse |
包含新增作業的響應數據。 |
| JobScheduleDeleteResponse |
包含 deleteMethod 作業的響應數據。 |
| JobScheduleDisableResponse |
包含停用作業的響應數據。 |
| JobScheduleEnableResponse |
包含啟用作業的響應數據。 |
| JobScheduleExistsResponse |
包含存在作業的回應數據。 |
| JobScheduleGetResponse |
包含取得作業的回應數據。 |
| JobScheduleListResponse |
包含清單作業的回應數據。 |
| JobSchedulePatchResponse |
包含修補作業的響應數據。 |
| JobScheduleState |
定義 JobScheduleState 的值。 可能的值包括:'active'、'completed'、'disabled'、'terminating'、'刪除' |
| JobScheduleTerminateResponse |
包含終止作業的回應數據。 |
| JobScheduleUpdateResponse |
包含更新作業的回應數據。 |
| JobState |
定義 JobState 的值。 可能的值包括:'active'、'disableing'、'disabled'、'enabling'、'terminating'、'completed'、'刪除' |
| JobTerminateResponse |
包含終止作業的回應數據。 |
| JobUpdateResponse |
包含更新作業的回應數據。 |
| LoginMode |
定義 LoginMode 的值。 可能的值包括:'batch'、'interactive' |
| NetworkSecurityGroupRuleAccess |
定義 NetworkSecurityGroupRuleAccess 的值。 可能的值包括:'allow'、'deny' |
| OnAllTasksComplete |
定義 OnAllTasksComplete 的值。 可能的值包括:'noAction'、'terminateJob' |
| OnTaskFailure |
定義 OnTaskFailure 的值。 可能的值包括:'noAction'、'performExitOptionsJobAction' |
| OSType |
定義OSType的值。 可能的值包括:'linux'、'windows' |
| OutputFileUploadCondition |
定義 OutputFileUploadCondition 的值。 可能的值包括:'taskSuccess'、'taskFailure'、'taskCompletion' |
| PoolAddResponse |
包含新增作業的響應數據。 |
| PoolDeleteResponse |
包含 deleteMethod 作業的響應數據。 |
| PoolDisableAutoScaleResponse |
包含 disableAutoScale 作業的響應數據。 |
| PoolEnableAutoScaleResponse |
包含 enableAutoScale 作業的響應數據。 |
| PoolEvaluateAutoScaleResponse |
包含 evaluateAutoScale 作業的響應數據。 |
| PoolExistsResponse |
包含存在作業的回應數據。 |
| PoolGetAllLifetimeStatisticsResponse |
包含 getAllLifetimeStatistics 作業的響應數據。 |
| PoolGetResponse |
包含取得作業的回應數據。 |
| PoolLifetimeOption |
定義 PoolLifetimeOption 的值。 可能的值包括:'jobSchedule'、'job' |
| PoolListResponse |
包含清單作業的回應數據。 |
| PoolListUsageMetricsResponse |
包含 listUsageMetrics 作業的響應數據。 |
| PoolPatchResponse |
包含修補作業的響應數據。 |
| PoolRemoveNodesResponse |
包含 removeNodes 作業的響應數據。 |
| PoolResizeResponse |
包含重設大小作業的響應數據。 |
| PoolState |
定義PoolState的值。 可能的值包括:'active'、'刪除' |
| PoolStopResizeResponse |
包含 stopResize 作業的響應數據。 |
| PoolUpdatePropertiesResponse |
包含 updateProperties 作業的響應數據。 |
| SchedulingState |
定義 SchedulingState 的值。 可能的值包括:'enabled'、'disabled' |
| StartTaskState |
定義 StartTaskState 的值。 可能的值包括:'running'、'completed' |
| StorageAccountType |
定義 StorageAccountType 的值。 可能的值包括:'StandardLRS'、'PremiumLRS' |
| SubtaskState |
定義 SubtaskState 的值。 可能的值包括:'正在準備'、'running'、'completed' |
| TaskAddCollectionResponse |
包含 addCollection 作業的響應數據。 |
| TaskAddResponse |
包含新增作業的響應數據。 |
| TaskAddStatus |
定義TaskAddStatus的值。 可能的值包括:'success'、'clientError'、'serverError' |
| TaskDeleteResponse |
包含 deleteMethod 作業的響應數據。 |
| TaskExecutionResult |
定義TaskExecutionResult的值。 可能的值包括:'success'、'failure' |
| TaskGetResponse |
包含取得作業的回應數據。 |
| TaskListResponse |
包含清單作業的回應數據。 |
| TaskListSubtasksResponse |
包含 listSubtasks 作業的響應數據。 |
| TaskReactivateResponse |
包含重新啟用作業的響應數據。 |
| TaskState |
定義TaskState的值。 可能的值包括:'active'、'preparing'、'running'、'completed' |
| TaskTerminateResponse |
包含終止作業的回應數據。 |
| TaskUpdateResponse |
包含更新作業的回應數據。 |
| VerificationType |
定義 VerificationType 的值。 可能的值包括:'verified'、'unverified' |