你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/arm-batch package

类

BatchManagementClient

接口

ActivateApplicationPackageParameters	激活应用程序包的参数。
Application	包含有关 Batch 帐户中的应用程序的信息。
ApplicationCreateOptionalParams	可选参数。
ApplicationDeleteOptionalParams	可选参数。
ApplicationGetOptionalParams	可选参数。
ApplicationListNextOptionalParams	可选参数。
ApplicationListOptionalParams	可选参数。
ApplicationOperations	表示 ApplicationOperations 的接口。
ApplicationPackage	表示应用程序的特定版本的应用程序包。
ApplicationPackageActivateOptionalParams	可选参数。
ApplicationPackageCreateOptionalParams	可选参数。
ApplicationPackageDeleteOptionalParams	可选参数。
ApplicationPackageGetOptionalParams	可选参数。
ApplicationPackageListNextOptionalParams	可选参数。
ApplicationPackageListOptionalParams	可选参数。
ApplicationPackageOperations	表示 ApplicationPackageOperations 的接口。
ApplicationPackageReference	链接到批处理帐户中的应用程序包
ApplicationUpdateOptionalParams	可选参数。
AutoScaleRun	池自动缩放公式执行的结果和错误。
AutoScaleRunError	自动缩放池时发生的错误。
AutoScaleSettings	池的自动缩放设置。
AutoStorageBaseProperties	与自动存储帐户相关的属性。
AutoStorageProperties	包含有关与 Batch 帐户关联的自动存储帐户的信息。
AutoUserSpecification	为在 Batch 服务上运行任务的自动用户指定参数。
AutomaticOSUpgradePolicy	用于执行自动 OS 升级的配置参数。
AzureBlobFileSystemConfiguration	用于使用 Blobfuse 连接到 Azure 存储容器的信息。
AzureFileShareConfiguration	用于连接到 Azure 文件共享的信息。
BatchAccount	包含有关Azure Batch帐户的信息。
BatchAccountCreateHeaders	定义BatchAccount_create操作的标头。
BatchAccountCreateOptionalParams	可选参数。
BatchAccountCreateParameters	提供给创建操作的参数。
BatchAccountDeleteHeaders	定义BatchAccount_delete操作的标头。
BatchAccountDeleteOptionalParams	可选参数。
BatchAccountGetDetectorOptionalParams	可选参数。
BatchAccountGetKeysOptionalParams	可选参数。
BatchAccountGetOptionalParams	可选参数。
BatchAccountIdentity	Batch 帐户的标识（如果已配置）。 当用户指定“Microsoft.KeyVault”作为其 Batch 帐户加密配置或选择作为自动存储身份验证模式时 ManagedIdentity ，会使用此方法。
BatchAccountKeys	一组Azure Batch帐户密钥。
BatchAccountListByResourceGroupNextOptionalParams	可选参数。
BatchAccountListByResourceGroupOptionalParams	可选参数。
BatchAccountListDetectorsNextOptionalParams	可选参数。
BatchAccountListDetectorsOptionalParams	可选参数。
BatchAccountListNextOptionalParams	可选参数。
BatchAccountListOptionalParams	可选参数。
BatchAccountListOutboundNetworkDependenciesEndpointsNextOptionalParams	可选参数。
BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams	可选参数。
BatchAccountListResult	List 操作返回的值。
BatchAccountOperations	表示 BatchAccountOperations 的接口。
BatchAccountRegenerateKeyOptionalParams	可选参数。
BatchAccountRegenerateKeyParameters	提供给 RegenerateKey 操作的参数。
BatchAccountSynchronizeAutoStorageKeysOptionalParams	可选参数。
BatchAccountUpdateOptionalParams	可选参数。
BatchAccountUpdateParameters	用于更新Azure Batch帐户的参数。
BatchLocationQuota	与特定订阅的 Batch 区域关联的配额。
BatchManagementClientOptionalParams	可选参数。
BatchPoolIdentity	Batch 池的标识（如果已配置）。 如果在更新现有池期间更新池标识，则只有池收缩到 0 后创建的新 VM 才会具有更新的标识
Certificate	包含有关证书的信息。
CertificateBaseProperties	基本证书属性。
CertificateCancelDeletionHeaders	定义Certificate_cancelDeletion操作的标头。
CertificateCancelDeletionOptionalParams	可选参数。
CertificateCreateHeaders	定义Certificate_create操作的标头。
CertificateCreateOptionalParams	可选参数。
CertificateCreateOrUpdateParameters	包含有关证书的信息。
CertificateCreateOrUpdateProperties	创建操作的证书属性
CertificateDeleteHeaders	定义Certificate_delete操作的标头。
CertificateDeleteOptionalParams	可选参数。
CertificateGetHeaders	定义Certificate_get操作的标头。
CertificateGetOptionalParams	可选参数。
CertificateListByBatchAccountNextOptionalParams	可选参数。
CertificateListByBatchAccountOptionalParams	可选参数。
CertificateOperations	表示 CertificateOperations 的接口。
CertificateProperties	证书属性。
CertificateReference	警告：此对象已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展 。
CertificateUpdateHeaders	定义Certificate_update操作的标头。
CertificateUpdateOptionalParams	可选参数。
CheckNameAvailabilityParameters	检查名称可用性请求的参数。
CheckNameAvailabilityResult	CheckNameAvailability 操作响应。
CifsMountConfiguration	用于连接到 CIFS 文件系统的信息。
CloudError	来自 Batch 服务的错误响应。
CloudErrorBody	来自 Batch 服务的错误响应。
CloudServiceConfiguration	基于 Azure 云服务 平台的池中节点的配置。
ComputeNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
ContainerConfiguration	已启用容器的池的配置。
ContainerRegistry	专用容器注册表。
DataDisk	与池中的计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时，需要从 VM 中装载和格式化磁盘，才能使用它们。
DeleteCertificateError	来自 Batch 服务的错误响应。
DeploymentConfiguration	部署配置属性。
DetectorListResult	List 操作返回的值。
DetectorResponse	包含检测器的信息。
DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
DiskEncryptionConfiguration	在池中的计算节点上应用的磁盘加密配置。 使用虚拟机映像或 Azure Compute Gallery 映像创建的 Linux 池不支持磁盘加密配置。
EncryptionProperties	配置如何在 Batch 帐户中加密客户数据。 默认情况下，使用 Microsoft 托管密钥对帐户进行加密。 对于其他控制，可以改用客户管理的密钥。
EndpointAccessProfile	Batch 终结点的网络访问配置文件。
EndpointDependency	用于访问依赖项的域名和连接详细信息。
EndpointDetail	有关 Batch 服务和终结点之间的连接的详细信息。
EnvironmentSetting	要对任务进程设置的环境变量。
FixedScaleSettings	修复了池的缩放设置。
IPRule	用于筛选客户端 IP 地址的规则。
ImageReference	对 Azure 虚拟机 市场映像或自定义虚拟机的 Azure 映像资源的引用。 若要获取Azure Batch验证的所有 imageReference 的列表，请参阅“列出支持的节点代理 SKU”操作。
InboundNatPool	入站 NAT 池，可用于在外部 Batch 池中对计算节点上的特定端口进行寻址。
KeyVaultProperties	使用 Microsoft.KeyVault 加密密钥源时的 KeyVault 配置。
KeyVaultReference	标识与 Batch 帐户关联的 Azure 密钥保管库。
LinuxUserConfiguration	用于在 Linux 节点上创建用户帐户的属性。
ListApplicationPackagesResult	执行列表应用程序包的结果。
ListApplicationsResult	执行列表应用程序的结果。
ListCertificatesResult	List 操作返回的值。
ListPoolsResult	List 操作返回的值。
ListPrivateEndpointConnectionsResult	List 操作返回的值。
ListPrivateLinkResourcesResult	List 操作返回的值。
Location	表示位置的接口。
LocationCheckNameAvailabilityOptionalParams	可选参数。
LocationGetQuotasOptionalParams	可选参数。
LocationListSupportedCloudServiceSkusNextOptionalParams	可选参数。
LocationListSupportedCloudServiceSkusOptionalParams	可选参数。
LocationListSupportedVirtualMachineSkusNextOptionalParams	可选参数。
LocationListSupportedVirtualMachineSkusOptionalParams	可选参数。
ManagedDisk
MetadataItem	Batch 服务不为此元数据分配任何含义;它仅用于使用用户代码。
MountConfiguration	要在每个节点上装载的文件系统。
NFSMountConfiguration	用于连接到 NFS 文件系统的信息。
NetworkConfiguration	池的网络配置。
NetworkProfile	Batch 帐户的网络配置文件，其中包含每个终结点的网络规则设置。
NetworkSecurityGroupRule	要应用于入站终结点的网络安全组规则。
NodePlacementConfiguration	Batch 服务用于预配节点的分配配置。
OSDisk	虚拟机操作系统磁盘的设置。
Operation	REST API 操作
OperationDisplay	描述操作的 对象。
OperationListResult	列出 REST API 操作的请求的结果。 它包含一个操作列表和一个 URL nextLink，用于获取下一组结果。
Operations	表示操作的接口。
OperationsListNextOptionalParams	可选参数。
OperationsListOptionalParams	可选参数。
OutboundEnvironmentEndpoint	Batch 服务需要出站访问权限的同一服务中相关终结点的集合。
OutboundEnvironmentEndpointCollection	List 操作返回的值。
Pool	包含有关池的信息。
PoolCreateHeaders	定义Pool_create操作的标头。
PoolCreateOptionalParams	可选参数。
PoolDeleteHeaders	定义Pool_delete操作的标头。
PoolDeleteOptionalParams	可选参数。
PoolDisableAutoScaleHeaders	定义Pool_disableAutoScale操作的标头。
PoolDisableAutoScaleOptionalParams	可选参数。
PoolEndpointConfiguration	池的终结点配置。
PoolGetHeaders	定义Pool_get操作的标头。
PoolGetOptionalParams	可选参数。
PoolListByBatchAccountNextOptionalParams	可选参数。
PoolListByBatchAccountOptionalParams	可选参数。
PoolOperations	表示 PoolOperations 的接口。
PoolStopResizeHeaders	定义Pool_stopResize操作的标头。
PoolStopResizeOptionalParams	可选参数。
PoolUpdateHeaders	定义Pool_update操作的标头。
PoolUpdateOptionalParams	可选参数。
PrivateEndpoint	专用终结点连接的专用终结点。
PrivateEndpointConnection	包含有关专用链接资源的信息。
PrivateEndpointConnectionDeleteHeaders	定义PrivateEndpointConnection_delete操作的标头。
PrivateEndpointConnectionDeleteOptionalParams	可选参数。
PrivateEndpointConnectionGetOptionalParams	可选参数。
PrivateEndpointConnectionListByBatchAccountNextOptionalParams	可选参数。
PrivateEndpointConnectionListByBatchAccountOptionalParams	可选参数。
PrivateEndpointConnectionOperations	表示 PrivateEndpointConnectionOperations 的接口。
PrivateEndpointConnectionUpdateHeaders	定义PrivateEndpointConnection_update操作的标头。
PrivateEndpointConnectionUpdateOptionalParams	可选参数。
PrivateLinkResource	包含有关专用链接资源的信息。
PrivateLinkResourceGetOptionalParams	可选参数。
PrivateLinkResourceListByBatchAccountNextOptionalParams	可选参数。
PrivateLinkResourceListByBatchAccountOptionalParams	可选参数。
PrivateLinkResourceOperations	表示 PrivateLinkResourceOperations 的接口。
PrivateLinkServiceConnectionState	专用终结点连接的专用链接服务连接状态
ProxyResource	Azure 资源的定义。
PublicIPAddressConfiguration	池网络配置的公共 IP 地址配置。
ResizeError	调整池大小时发生的错误。
ResizeOperationStatus	描述当前操作 (是否池 AllocationState 正在调整大小) ，或者如果 AllocationState 为“稳定) ”，则描述以前完成的操作 (。
Resource	Azure 资源的定义。
ResourceFile	要下载到计算节点的单个文件或多个文件。
RollingUpgradePolicy	执行滚动升级时使用的配置参数。
ScaleSettings	定义所需的池大小。 这可以是“fixedScale”，其中指定了请求的 targetDedicatedNodes，也可以是定义定期重新计算的公式的“autoScale”。 如果未指定此属性，池将具有 0 targetDedicatedNodes 的固定规模。
SecurityProfile	指定虚拟机或虚拟机规模集的安全配置文件设置。
ServiceArtifactReference	指定使用“最新”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。
SkuCapability	SKU 功能，例如核心数。
StartTask	在某些情况下，即使节点未重新启动，启动任务也可能重新运行。 因此，启动任务应是幂等的，如果它们正在执行的设置已经完成，则应正常退出。 应特别注意避免启动任务创建分离进程或从启动任务工作目录安装/启动服务，因为这会阻止 Batch 重新运行启动任务。
SupportedSku	介绍 Batch 支持的 SKU。
SupportedSkusResult	批处理列表支持的 SKU 操作响应。
TaskContainerSettings	任务的容器设置。
TaskSchedulingPolicy	指定任务应如何跨计算节点分布。
UefiSettings	指定创建虚拟机时使用的安全启动和 vTPM 等安全设置。
UpgradePolicy	描述升级策略 - 自动、手动或滚动。
UserAccount	用于在Azure Batch节点上创建用户的属性。
UserAssignedIdentities	关联用户标识的列表。
UserIdentity	指定 userName 或 autoUser 属性，但不能同时指定两者。
VMExtension	虚拟机扩展的配置。
VirtualMachineConfiguration	基于 Azure 虚拟机基础结构的池中计算节点的配置。
VirtualMachineFamilyCoreQuota	BATCH 帐户的 VM 系列及其关联的核心配额。
WindowsConfiguration	要应用于虚拟机的 Windows 操作系统设置。
WindowsUserConfiguration	用于在 Windows 节点上创建用户帐户的属性。

类型别名

AccountKeyType	定义 AccountKeyType 的值。
AllocationState	定义 AllocationState 的值。
ApplicationCreateResponse	包含创建操作的响应数据。
ApplicationGetResponse	包含获取操作的响应数据。
ApplicationListNextResponse	包含 listNext 操作的响应数据。
ApplicationListResponse	包含列表操作的响应数据。
ApplicationPackageActivateResponse	包含激活操作的响应数据。
ApplicationPackageCreateResponse	包含创建操作的响应数据。
ApplicationPackageGetResponse	包含获取操作的响应数据。
ApplicationPackageListNextResponse	包含 listNext 操作的响应数据。
ApplicationPackageListResponse	包含列表操作的响应数据。
ApplicationUpdateResponse	包含更新操作的响应数据。
AuthenticationMode	定义 AuthenticationMode 的值。
AutoStorageAuthenticationMode	定义 AutoStorageAuthenticationMode 的值。
AutoUserScope	定义 AutoUserScope 的值。
BatchAccountCreateResponse	包含创建操作的响应数据。
BatchAccountGetDetectorResponse	包含 getDetector 操作的响应数据。
BatchAccountGetKeysResponse	包含 getKeys 操作的响应数据。
BatchAccountGetResponse	包含获取操作的响应数据。
BatchAccountListByResourceGroupNextResponse	包含 listByResourceGroupNext 操作的响应数据。
BatchAccountListByResourceGroupResponse	包含 listByResourceGroup 操作的响应数据。
BatchAccountListDetectorsNextResponse	包含 listDetectorsNext 操作的响应数据。
BatchAccountListDetectorsResponse	包含 listDetectors 操作的响应数据。
BatchAccountListNextResponse	包含 listNext 操作的响应数据。
BatchAccountListOutboundNetworkDependenciesEndpointsNextResponse	包含 listOutboundNetworkDependenciesEndpointsNext 操作的响应数据。
BatchAccountListOutboundNetworkDependenciesEndpointsResponse	包含 listOutboundNetworkDependenciesEndpoints 操作的响应数据。
BatchAccountListResponse	包含列表操作的响应数据。
BatchAccountRegenerateKeyResponse	包含 regenerateKey 操作的响应数据。
BatchAccountUpdateResponse	包含更新操作的响应数据。
CachingType	定义 CachingType 的值。
CertificateCancelDeletionResponse	包含 cancelDeletion 操作的响应数据。
CertificateCreateResponse	包含创建操作的响应数据。
CertificateFormat	定义 CertificateFormat 的值。
CertificateGetResponse	包含获取操作的响应数据。
CertificateListByBatchAccountNextResponse	包含 listByBatchAccountNext 操作的响应数据。
CertificateListByBatchAccountResponse	包含 listByBatchAccount 操作的响应数据。
CertificateProvisioningState	定义 CertificateProvisioningState 的值。
CertificateStoreLocation	定义 CertificateStoreLocation 的值。
CertificateUpdateResponse	包含更新操作的响应数据。
CertificateVisibility	定义 CertificateVisibility 的值。
ComputeNodeDeallocationOption	定义 ComputeNodeDeallocationOption 的值。
ComputeNodeFillType	定义 ComputeNodeFillType 的值。
ContainerType	定义 ContainerType 的值。 KnownContainerType 可与 ContainerType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 DockerCompatible：Docker 兼容的容器技术将用于启动容器。 CriCompatible：基于 CRI 的技术将用于启动容器。
ContainerWorkingDirectory	定义 ContainerWorkingDirectory 的值。
DiskEncryptionTarget	定义 DiskEncryptionTarget 的值。
DynamicVNetAssignmentScope	定义 DynamicVNetAssignmentScope 的值。
ElevationLevel	定义 ElevationLevel 的值。
EndpointAccessDefaultAction	定义 EndpointAccessDefaultAction 的值。
IPAddressProvisioningType	定义 IPAddressProvisioningType 的值。
InboundEndpointProtocol	定义 InboundEndpointProtocol 的值。
InterNodeCommunicationState	定义 InterNodeCommunicationState 的值。
KeySource	定义 KeySource 的值。
LocationCheckNameAvailabilityResponse	包含 checkNameAvailability 操作的响应数据。
LocationGetQuotasResponse	包含 getQuotas 操作的响应数据。
LocationListSupportedCloudServiceSkusNextResponse	包含 listSupportedCloudServiceSkusNext 操作的响应数据。
LocationListSupportedCloudServiceSkusResponse	包含 listSupportedCloudServiceSkus 操作的响应数据。
LocationListSupportedVirtualMachineSkusNextResponse	包含 listSupportedVirtualMachineSkusNext 操作的响应数据。
LocationListSupportedVirtualMachineSkusResponse	包含 listSupportedVirtualMachineSkus 操作的响应数据。
LoginMode	定义 LoginMode 的值。
NameAvailabilityReason	定义 NameAvailabilityReason 的值。
NetworkSecurityGroupRuleAccess	定义 NetworkSecurityGroupRuleAccess 的值。
NodeCommunicationMode	定义 NodeCommunicationMode 的值。
NodePlacementPolicyType	定义 NodePlacementPolicyType 的值。
OperationsListNextResponse	包含 listNext 操作的响应数据。
OperationsListResponse	包含列表操作的响应数据。
PackageState	定义 PackageState 的值。
PoolAllocationMode	定义 PoolAllocationMode 的值。
PoolCreateResponse	包含创建操作的响应数据。
PoolDisableAutoScaleResponse	包含 disableAutoScale 操作的响应数据。
PoolGetResponse	包含获取操作的响应数据。
PoolIdentityType	定义 PoolIdentityType 的值。
PoolListByBatchAccountNextResponse	包含 listByBatchAccountNext 操作的响应数据。
PoolListByBatchAccountResponse	包含 listByBatchAccount 操作的响应数据。
PoolProvisioningState	定义 PoolProvisioningState 的值。
PoolStopResizeResponse	包含 stopResize 操作的响应数据。
PoolUpdateResponse	包含更新操作的响应数据。
PrivateEndpointConnectionDeleteResponse	包含删除操作的响应数据。
PrivateEndpointConnectionGetResponse	包含获取操作的响应数据。
PrivateEndpointConnectionListByBatchAccountNextResponse	包含 listByBatchAccountNext 操作的响应数据。
PrivateEndpointConnectionListByBatchAccountResponse	包含 listByBatchAccount 操作的响应数据。
PrivateEndpointConnectionProvisioningState	定义 PrivateEndpointConnectionProvisioningState 的值。
PrivateEndpointConnectionUpdateResponse	包含更新操作的响应数据。
PrivateLinkResourceGetResponse	包含获取操作的响应数据。
PrivateLinkResourceListByBatchAccountNextResponse	包含 listByBatchAccountNext 操作的响应数据。
PrivateLinkResourceListByBatchAccountResponse	包含 listByBatchAccount 操作的响应数据。
PrivateLinkServiceConnectionStatus	定义 PrivateLinkServiceConnectionStatus 的值。
ProvisioningState	定义 ProvisioningState 的值。
PublicNetworkAccessType	定义 PublicNetworkAccessType 的值。
ResourceIdentityType	定义 ResourceIdentityType 的值。
StorageAccountType	定义 StorageAccountType 的值。
UpgradeMode	定义 UpgradeMode 的值。

枚举

KnownContainerType

服务接受的 ContainerType 的已知值。

函数

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个，将返回一个可用于稍后从该点开始分页的延续标记。

函数详细信息

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个，将返回一个可用于稍后从该点开始分页的延续标记。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

从迭代器访问 value IteratorResult byPage 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage () 的延续标记。