你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/batch package
类
Account |
表示 Account 的类。 |
Application |
表示应用程序的类。 |
BatchServiceClient | |
BatchServiceClientContext | |
BatchSharedKeyCredentials |
创建新的 BatchSharedKeyCredentials 对象。 |
CertificateOperations |
表示 CertificateOperations 的类。 |
ComputeNodeOperations |
表示 ComputeNodeOperations 的类。 |
File |
表示 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 |
定义 Get 操作的标头。 |
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 |
定义 Get 操作的标头。 |
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 |
在节点上触发恢复操作时,Batch 将重试任务。 恢复操作的示例包括 (但不限于在重新启动不正常的节点或计算节点因主机故障而消失时) 。 由于恢复操作而进行的重试独立于 ,并且不计入 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 |
定义 Get 操作的标头。 |
ComputeNodeGetOptionalParams |
可选参数。 |
ComputeNodeGetOptions |
获取操作的其他参数。 |
ComputeNodeGetRemoteDesktopHeaders |
定义 GetRemoteDesktop 操作的标头。 |
ComputeNodeGetRemoteDesktopOptionalParams |
可选参数。 |
ComputeNodeGetRemoteDesktopOptions |
getRemoteDesktop 操作的其他参数。 |
ComputeNodeGetRemoteLoginSettingsHeaders |
定义 GetRemoteLoginSettings 操作的标头。 |
ComputeNodeGetRemoteLoginSettingsOptionalParams |
可选参数。 |
ComputeNodeGetRemoteLoginSettingsOptions |
getRemoteLoginSettings 操作的其他参数。 |
ComputeNodeGetRemoteLoginSettingsResult |
表示 ComputeNodeGetRemoteLoginSettingsResult 的接口。 |
ComputeNodeInformation |
表示 ComputeNodeInformation 的接口。 |
ComputeNodeListHeaders |
定义 List 操作的标头。 |
ComputeNodeListNextOptionalParams |
可选参数。 |
ComputeNodeListNextOptions |
listNext 操作的其他参数。 |
ComputeNodeListOptionalParams |
可选参数。 |
ComputeNodeListOptions |
列表操作的其他参数。 |
ComputeNodeListResult | |
ComputeNodeRebootHeaders |
定义重新启动操作的标头。 |
ComputeNodeRebootOptionalParams |
可选参数。 |
ComputeNodeRebootOptions |
重新启动操作的其他参数。 |
ComputeNodeReimageHeaders |
定义重映像操作的标头。 |
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 |
定义禁用操作的标头。 |
JobDisableOptionalParams |
可选参数。 |
JobDisableOptions |
禁用操作的其他参数。 |
JobDisableParameter |
表示 JobDisableParameter 的接口。 |
JobEnableHeaders |
定义 Enable 操作的标头。 |
JobEnableOptionalParams |
可选参数。 |
JobEnableOptions |
启用操作的其他参数。 |
JobExecutionInformation |
表示 JobExecutionInformation 的接口。 |
JobGetAllLifetimeStatisticsHeaders |
定义 GetAllLifetimeStatistics 操作的标头。 |
JobGetAllLifetimeStatisticsOptionalParams |
可选参数。 |
JobGetAllLifetimeStatisticsOptions |
getAllLifetimeStatistics 操作的其他参数。 |
JobGetHeaders |
定义 Get 操作的标头。 |
JobGetOptionalParams |
可选参数。 |
JobGetOptions |
获取操作的其他参数。 |
JobGetTaskCountsHeaders |
定义 GetTaskCounts 操作的标头。 |
JobGetTaskCountsOptionalParams |
可选参数。 |
JobGetTaskCountsOptions |
getTaskCounts 操作的其他参数。 |
JobListFromJobScheduleHeaders |
定义 ListFromJobSchedule 操作的标头。 |
JobListFromJobScheduleNextOptionalParams |
可选参数。 |
JobListFromJobScheduleNextOptions |
listFromJobScheduleNext 操作的其他参数。 |
JobListFromJobScheduleOptionalParams |
可选参数。 |
JobListFromJobScheduleOptions |
listFromJobSchedule 操作的其他参数。 |
JobListHeaders |
定义 List 操作的标头。 |
JobListNextOptionalParams |
可选参数。 |
JobListNextOptions |
listNext 操作的其他参数。 |
JobListOptionalParams |
可选参数。 |
JobListOptions |
列表操作的其他参数。 |
JobListPreparationAndReleaseTaskStatusHeaders |
定义 ListPreparationAndReleaseTaskStatus 操作的标头。 |
JobListPreparationAndReleaseTaskStatusNextOptionalParams |
可选参数。 |
JobListPreparationAndReleaseTaskStatusNextOptions |
listPreparationAndReleaseTaskStatusNext 操作的其他参数。 |
JobListPreparationAndReleaseTaskStatusOptionalParams |
可选参数。 |
JobListPreparationAndReleaseTaskStatusOptions |
listPreparationAndReleaseTaskStatus 操作的其他参数。 |
JobManagerTask |
作业管理器任务在创建作业时自动启动。 Batch 服务尝试在作业中任何其他任务之前计划作业管理器任务。 收缩池时,Batch 服务会尽可能长时间地保留运行作业管理器任务的节点 (也就是说,在运行作业管理器任务的计算节点) 之前,将删除运行“正常”任务的计算节点。 当作业管理器任务失败且需要重启时,系统会尝试以最高优先级计划它。 如果没有可用的空闲计算节点,系统可能会终止池中正在运行的任务之一,并将其返回到队列,以便为作业管理器任务重新启动腾出空间。 请注意,一个作业中的作业管理器任务不优先于其他作业中的任务。 在作业中,仅观察到作业级别的优先级。 例如,如果优先级为 0 的作业管理器需要重启,则它不会取代优先级为 1 的作业。 在节点上触发恢复操作时,Batch 将重试任务。 恢复操作的示例包括 (但不限于重新启动不正常的节点或计算节点因主机故障而消失时) 。 由于恢复操作导致的重试独立于 ,并且不计入 maxTaskRetryCount。 即使 maxTaskRetryCount 为 0,也可能发生由于恢复操作而导致的内部重试。 因此,所有任务都应是幂等的。 这意味着任务需要容忍中断和重启,而不会导致任何损坏或重复数据。 对于长时间运行的任务,最佳做法是使用某种形式的检查点。 |
JobNetworkConfiguration |
表示 JobNetworkConfiguration 的接口。 |
JobPatchHeaders |
定义修补操作的标头。 |
JobPatchOptionalParams |
可选参数。 |
JobPatchOptions |
修补操作的其他参数。 |
JobPatchParameter |
表示 JobPatchParameter 的接口。 |
JobPreparationAndReleaseTaskExecutionInformation |
表示 JobPreparationAndReleaseTaskExecutionInformation 的接口。 |
JobPreparationTask |
可以使用作业准备来准备节点以运行作业的任务。 在作业准备中通常执行的活动包括:下载作业中的所有任务使用的通用资源文件。 作业准备任务可以将这些常见资源文件下载到节点上的共享位置。 (AZ_BATCH_NODE_ROOT_DIR\共享) ,或在节点上启动本地服务,以便该作业的所有任务都可以与其通信。 如果作业准备任务失败 (即,在退出之前用完其重试计数,退出代码为 0) ,Batch 将不会在节点上运行此作业的任务。 在重置映像之前,计算节点仍然没有资格运行此作业的任务。 计算节点保持活动状态,可用于其他作业。 作业准备任务可以在同一节点上多次运行。 因此,应编写作业准备任务来处理重新执行。 如果重新启动节点,则作业准备任务在计划作业的任何其他任务之前,在计算节点上再次运行,如果 rerunOnNodeRebootAfterSuccess 为 true,或者作业准备任务以前未完成。 如果节点重置映像,则会在计划作业的任何任务之前再次运行作业准备任务。 在节点上触发恢复操作时,Batch 将重试任务。 恢复操作的示例包括 (但不限于在重新启动不正常的节点或计算节点因主机故障而消失时) 。 由于恢复操作而进行的重试独立于 ,并且不计入 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 |
定义 Enable 操作的标头。 |
JobScheduleEnableOptionalParams |
可选参数。 |
JobScheduleEnableOptions |
用于启用操作的其他参数。 |
JobScheduleExecutionInformation |
表示 JobScheduleExecutionInformation 的接口。 |
JobScheduleExistsHeaders |
定义 Exists 操作的标头。 |
JobScheduleExistsOptionalParams |
可选参数。 |
JobScheduleExistsOptions |
存在操作的其他参数。 |
JobScheduleGetHeaders |
定义 Get 操作的标头。 |
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 计算节点代理是在池中的每个计算节点上运行的程序,并在计算节点上提供 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 |
定义 Get 操作的标头。 |
PoolGetOptionalParams |
可选参数。 |
PoolGetOptions |
获取操作的其他参数。 |
PoolInformation |
表示 PoolInformation 的接口。 |
PoolListHeaders |
定义 List 操作的标头。 |
PoolListNextOptionalParams |
可选参数。 |
PoolListNextOptions |
listNext 操作的其他参数。 |
PoolListOptionalParams |
可选参数。 |
PoolListOptions |
列表操作的其他参数。 |
PoolListUsageMetricsHeaders |
定义 ListUsageMetrics 操作的标头。 |
PoolListUsageMetricsNextOptionalParams |
可选参数。 |
PoolListUsageMetricsNextOptions |
listUsageMetricsNext 操作的其他参数。 |
PoolListUsageMetricsOptionalParams |
可选参数。 |
PoolListUsageMetricsOptions |
listUsageMetrics 操作的其他参数。 |
PoolListUsageMetricsResult | |
PoolNodeCounts |
表示 PoolNodeCounts 的接口。 |
PoolNodeCountsListResult | |
PoolPatchHeaders |
定义修补操作的标头。 |
PoolPatchOptionalParams |
可选参数。 |
PoolPatchOptions |
修补操作的其他参数。 |
PoolPatchParameter |
表示 PoolPatchParameter 的接口。 |
PoolRemoveNodesHeaders |
定义 RemoveNodes 操作的标头。 |
PoolRemoveNodesOptionalParams |
可选参数。 |
PoolRemoveNodesOptions |
removeNodes 操作的其他参数。 |
PoolResizeHeaders |
定义调整大小操作的标头。 |
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 |
表示 Schedule 的接口。 |
StartTask |
在节点上触发恢复操作时,Batch 将重试任务。 恢复操作的示例包括 (但不限于重新启动不正常的节点或计算节点因主机故障而消失时) 。 由于恢复操作导致的重试独立于 ,并且不计入 maxTaskRetryCount。 即使 maxTaskRetryCount 为 0,也可能发生由于恢复操作而导致的内部重试。 因此,所有任务都应是幂等的。 这意味着任务需要容忍中断和重启,而不会导致任何损坏或重复数据。 对于长时间运行的任务,最佳做法是使用某种形式的检查点。 在某些情况下,即使计算节点未重新启动,StartTask 也可能重新运行。 应特别注意避免 StartTask 创建分离进程或从 StartTask 工作目录安装/启动服务,因为这会阻止 Batch 重新运行 StartTask。 |
StartTaskInformation |
表示 StartTaskInformation 的接口。 |
SubtaskInformation |
表示 SubtaskInformation 的接口。 |
TaskAddCollectionHeaders |
定义 AddCollection 操作的标头。 |
TaskAddCollectionOptionalParams |
可选参数。 |
TaskAddCollectionOptions |
addCollection 操作的其他参数。 |
TaskAddCollectionParameter |
表示 TaskAddCollectionParameter 的接口。 |
TaskAddCollectionResult |
表示 TaskAddCollectionResult 的接口。 |
TaskAddHeaders |
定义 Add 操作的标头。 |
TaskAddOptionalParams |
可选参数。 |
TaskAddOptions |
添加操作的其他参数。 |
TaskAddParameter |
在节点上触发恢复操作时,Batch 将重试任务。 恢复操作的示例包括 (但不限于重新启动不正常的节点或计算节点因主机故障而消失时) 。 由于恢复操作导致的重试独立于 ,并且不计入 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 |
定义 Get 操作的标头。 |
TaskGetOptionalParams |
可选参数。 |
TaskGetOptions |
获取操作的其他参数。 |
TaskIdRange |
范围的开始和结束是非独占的。 例如,如果范围从 9 开始到结束 12,则表示任务“9”、“10”、“11”和“12”。 |
TaskInformation |
表示 TaskInformation 的接口。 |
TaskListHeaders |
定义 List 操作的标头。 |
TaskListNextOptionalParams |
可选参数。 |
TaskListNextOptions |
listNext 操作的其他参数。 |
TaskListOptionalParams |
可选参数。 |
TaskListOptions |
列表操作的其他参数。 |
TaskListSubtasksHeaders |
定义 ListSubtask 操作的标头。 |
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”、“create”、“starting”、“waitingForStartTask”、“startsk”、“startTaskFailed”、“unknown”、“leavingPool”、“offline”、“preempted” |
ComputeNodeUpdateUserResponse |
包含 updateUser 操作的响应数据。 |
ComputeNodeUploadBatchServiceLogsResponse |
包含 uploadBatchServiceLogs 操作的响应数据。 |
ContainerWorkingDirectory |
定义 ContainerWorkingDirectory 的值。 可能的值包括:“taskWorkingDirectory”、“containerImageDefault” |
DependencyAction |
定义 DependencyAction 的值。 可能的值包括:“satisfy”、“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”、“deleting” |
JobScheduleTerminateResponse |
包含终止操作的响应数据。 |
JobScheduleUpdateResponse |
包含更新操作的响应数据。 |
JobState |
定义 JobState 的值。 可能的值包括:“active”、“disableing”、“disabled”、“enableing”、“terminating”、“completed”、“deleting” |
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 |
包含 exists 操作的响应数据。 |
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” |