@azure/arm-batch package

类

BatchManagementClient

接口

AccessRule	网络安全外围配置文件中的访问规则
AccessRuleProperties	访问规则的属性
AccessRulePropertiesSubscriptionsItem	访问规则的订阅资源ID。
ActivateApplicationPackageParameters	激活应用程序包的参数。
Application	包含有关 Batch 帐户中的应用程序的信息。
ApplicationCreateOptionalParams	可选参数。
ApplicationDeleteOptionalParams	可选参数。
ApplicationGetOptionalParams	可选参数。
ApplicationListOptionalParams	可选参数。
ApplicationOperations	表示应用操作的接口。
ApplicationPackage	表示应用程序的特定版本的应用程序包。
ApplicationPackageActivateOptionalParams	可选参数。
ApplicationPackageCreateOptionalParams	可选参数。
ApplicationPackageDeleteOptionalParams	可选参数。
ApplicationPackageGetOptionalParams	可选参数。
ApplicationPackageListOptionalParams	可选参数。
ApplicationPackageOperations	表示 ApplicationPackage 操作的接口。
ApplicationPackageProperties	应用包的属性
ApplicationPackageReference	链接到批处理帐户中的应用程序包
ApplicationProperties	与应用程序关联的属性。
ApplicationUpdateOptionalParams	可选参数。
AutoScaleRun	池自动缩放公式执行的结果和错误。
AutoScaleRunError	自动缩放池时发生的错误。
AutoScaleSettings	池的自动缩放设置。
AutoStorageBaseProperties	与自动存储帐户相关的属性。
AutoStorageProperties	包含有关与 Batch 帐户关联的自动存储帐户的信息。
AutoUserSpecification	指定在 Batch 服务上运行任务的自动用户的参数。
AutomaticOSUpgradePolicy	用于执行自动 OS 升级的配置参数。
AzureBlobFileSystemConfiguration	用于使用 Blobfuse 连接到 Azure 存储容器的信息。
AzureFileShareConfiguration	用于连接到 Azure 文件共享的信息。
BatchAccount	包含有关 Azure Batch 帐户的信息。
BatchAccountCreateOptionalParams	可选参数。
BatchAccountCreateParameters	提供给“创建”操作的参数。
BatchAccountCreateProperties	批处理账户的属性。
BatchAccountDeleteOptionalParams	可选参数。
BatchAccountGetDetectorOptionalParams	可选参数。
BatchAccountGetKeysOptionalParams	可选参数。
BatchAccountGetOptionalParams	可选参数。
BatchAccountIdentity	Batch 帐户的标识（如果已配置）。 当用户将“Microsoft.KeyVault”指定为其 Batch 帐户加密配置或选择 ManagedIdentity 作为自动存储身份验证模式时，则使用此方法。
BatchAccountKeys	一组 Azure Batch 帐户密钥。
BatchAccountListByResourceGroupOptionalParams	可选参数。
BatchAccountListDetectorsOptionalParams	可选参数。
BatchAccountListOptionalParams	可选参数。
BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams	可选参数。
BatchAccountOperations	表示批处理账户操作的接口。
BatchAccountProperties	账户特定属性。
BatchAccountRegenerateKeyOptionalParams	可选参数。
BatchAccountRegenerateKeyParameters	提供给 RegenerateKey 操作的参数。
BatchAccountSynchronizeAutoStorageKeysOptionalParams	可选参数。
BatchAccountUpdateOptionalParams	可选参数。
BatchAccountUpdateParameters	用于更新 Azure Batch 帐户的参数。
BatchAccountUpdateProperties	批处理账户的属性。
BatchLocationQuota	与特定订阅的 Batch 区域关联的配额。
BatchManagementClientOptionalParams	客户端的可选参数。
BatchPoolIdentity	Batch 池的标识（如果已配置）。 如果在更新现有池期间更新池标识，则只有池收缩到 0 后创建的新 VM 才会有更新的标识
CheckNameAvailabilityParameters	检查名称可用性请求的参数。
CheckNameAvailabilityResult	CheckNameAvailability 操作响应。
CifsMountConfiguration	用于连接到 CIFS 文件系统的信息。
CloudError	Batch 服务的错误响应。
CloudErrorBody	Batch 服务的错误响应。
ComputeNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
ContainerConfiguration	已启用容器的池的配置。
ContainerHostBatchBindMountEntry	要装载到任务容器的路径和装载模式的条目。
ContainerRegistry	专用容器注册表。
DataDisk	与池中的计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时，需要从 VM 中装载磁盘并设置磁盘格式才能使用这些磁盘。
DeploymentConfiguration	部署配置属性。
DetectorResponse	包含检测器的信息。
DetectorResponseProperties	探测器响应特性。
DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
DiskCustomerManagedKey	用于加密磁盘的客户管理的密钥引用。
DiskEncryptionConfiguration	在池中的计算节点上应用的磁盘加密配置。 使用虚拟机映像或 Azure 计算库映像创建的 Linux 池不支持磁盘加密配置。
DiskEncryptionSetParameters	磁盘加密集的 ARM 资源 ID。
EncryptionProperties	配置客户数据在 Batch 帐户内加密的方式。 默认情况下，帐户使用Microsoft托管密钥进行加密。 对于其他控制，可以改用客户管理的密钥。
EndpointAccessProfile	Batch 终结点的网络访问配置文件。
EndpointDependency	用于访问依赖项的域名和连接详细信息。
EndpointDetail	有关 Batch 服务与终结点之间的连接的详细信息。
EnvironmentSetting	要对任务进程设置的环境变量。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。
FixedScaleSettings	修复了池的缩放设置。
HostEndpointSettings	指定特定的主机终结点设置。
IPRule	用于筛选客户端 IP 地址的规则。
IPTag	指定应如何跨计算节点分配任务。
ImageReference	对 Azure 虚拟机市场映像或自定义虚拟机的 Azure 映像资源的引用。 若要获取 Azure Batch 验证的所有 imageReference 的列表，请参阅“列出支持的节点代理 SKU”操作。
InboundNatPool	入站 NAT 池，可用于在外部处理 Batch 池中计算节点上的特定端口。
KeyVaultProperties	使用 Microsoft.KeyVault 的加密密钥来源时，KeyVault 配置。
KeyVaultReference	标识与 Batch 帐户关联的 Azure 密钥保管库。
LinuxUserConfiguration	用于在 Linux 节点上创建用户帐户的属性。
LocationCheckNameAvailabilityOptionalParams	可选参数。
LocationGetQuotasOptionalParams	可选参数。
LocationListSupportedVirtualMachineSkusOptionalParams	可选参数。
LocationOperations	表示位置操作的接口。
ManagedDisk	托管磁盘参数。
MetadataItem	Batch 服务不为此元数据分配任何含义;它仅用于使用用户代码。
MountConfiguration	要在每个节点上装载的文件系统。
NFSMountConfiguration	用于连接到 NFS 文件系统的信息。
NetworkConfiguration	池的网络配置。
NetworkProfile	Batch 帐户的网络配置文件，其中包含每个终结点的网络规则设置。
NetworkSecurityGroupRule	要应用于入站终结点的网络安全组规则。
NetworkSecurityPerimeter	有关网络安全外围（NSP）的信息
NetworkSecurityPerimeterConfiguration	网络安全外围 （NSP） 配置资源
NetworkSecurityPerimeterConfigurationProperties	网络安全配置属性。
NetworkSecurityPerimeterGetConfigurationOptionalParams	可选参数。
NetworkSecurityPerimeterListConfigurationsOptionalParams	可选参数。
NetworkSecurityPerimeterOperations	表示网络安全周边操作的接口。
NetworkSecurityPerimeterReconcileConfigurationOptionalParams	可选参数。
NetworkSecurityProfile	网络安全外围配置文件
NodePlacementConfiguration	Batch 服务用于预配节点的分配配置。
OSDisk	虚拟机操作系统磁盘的设置。
Operation	REST API 操作
OperationDisplay	描述操作的对象。
OperationsListOptionalParams	可选参数。
OperationsOperations	表示操作操作的接口。
OutboundEnvironmentEndpoint	Batch 服务需要出站访问的同一服务中相关终结点的集合。
PageSettings	byPage 方法的选项
PagedAsyncIterableIterator	允许异步迭代到完成和逐页迭代的接口。
Pool	包含有关池的信息。
PoolCreateOptionalParams	可选参数。
PoolDeleteOptionalParams	可选参数。
PoolDisableAutoScaleOptionalParams	可选参数。
PoolEndpointConfiguration	池的终结点配置。
PoolGetOptionalParams	可选参数。
PoolListByBatchAccountOptionalParams	可选参数。
PoolOperations	表示一个池操作的接口。
PoolProperties	泳池房产。
PoolStopResizeOptionalParams	可选参数。
PoolUpdateOptionalParams	可选参数。
PrivateEndpoint	专用终结点连接的专用终结点。
PrivateEndpointConnection	包含有关专用链接资源的信息。
PrivateEndpointConnectionDeleteOptionalParams	可选参数。
PrivateEndpointConnectionGetOptionalParams	可选参数。
PrivateEndpointConnectionListByBatchAccountOptionalParams	可选参数。
PrivateEndpointConnectionOperations	表示PrivateEndpointConnection操作的接口。
PrivateEndpointConnectionProperties	专用终结点连接属性。
PrivateEndpointConnectionUpdateOptionalParams	可选参数。
PrivateLinkResource	包含有关专用链接资源的信息。
PrivateLinkResourceGetOptionalParams	可选参数。
PrivateLinkResourceListByBatchAccountOptionalParams	可选参数。
PrivateLinkResourceOperations	表示PrivateLinkResource操作的接口。
PrivateLinkResourceProperties	私有链接资源属性。
PrivateLinkServiceConnectionState	专用终结点连接的专用链接服务连接状态
ProvisioningIssue	介绍网络安全外围配置的预配问题
ProvisioningIssueProperties	网络安全外围（NSP）配置的预配问题的详细信息。 资源提供程序应为每个检测到的单独问题生成单独的预配问题元素，并包含有意义的独特说明，以及任何适当的 suggestedResourceIds 和 suggestedAccessRules
ProxyAgentSettings	在创建虚拟机时指定 ProxyAgent 设置。
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置
PublicIPAddressConfiguration	池的网络配置的公共 IP 地址配置。
ResizeError	调整池大小时发生的错误。
ResizeOperationStatus	描述当前操作（如果池 AllocationState 调整大小）或之前完成的操作（如果 AllocationState 为稳定）。
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
ResourceAssociation	有关资源关联的信息
ResourceFile	要下载到计算节点的单个文件或多个文件。
RestorePollerOptions
RollingUpgradePolicy	执行滚动升级时使用的配置参数。
ScaleSettings	定义池的所需大小。 这可以是指定所请求的目标DedicatedNode 的“fixedScale”，也可以是定义定期重新计算的公式的“autoScale”。 如果未指定此属性，则池将具有具有 0 个 targetDedicatedNodes 的固定缩放。
SecurityProfile	指定虚拟机或虚拟机规模集的安全配置文件设置。
ServiceArtifactReference	指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。
SimplePollerLike	可用于轮询长时间运行的操作的简单轮询程序。
SkuCapability	SKU 功能，例如核心数。
StartTask	在某些情况下，即使节点未重新启动，启动任务也可能重新运行。 因此，启动任务应是幂等的，如果它们正在执行的设置已经完成，则正常退出。 应特别注意避免从启动任务工作目录创建分离进程或安装/启动服务的启动任务，因为这会阻止 Batch 重新运行启动任务。
SupportedSku	介绍 Batch 支持的 SKU。
SystemData	与创建和上次修改资源相关的元数据。
TaskContainerSettings	任务的容器设置。
TaskSchedulingPolicy	指定应如何跨计算节点分配任务。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
UefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。
UpgradePolicy	描述升级策略 - 自动、手动或滚动。
UserAccount	用于在 Azure Batch 节点上创建用户的属性。
UserAssignedIdentities	关联的用户标识列表。
UserIdentity	指定 userName 或 autoUser 属性，但不能同时指定这两者。
VMDiskSecurityProfile	指定托管磁盘的安全配置文件设置。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。
VMExtension	虚拟机扩展的配置。
VirtualMachineConfiguration	基于 Azure 虚拟机基础结构的池中计算节点的配置。
VirtualMachineFamilyCoreQuota	VM 系列及其 Batch 帐户的相关核心配额。
WindowsConfiguration	要应用于虚拟机的 Windows 操作系统设置。
WindowsUserConfiguration	用于在 Windows 节点上创建用户帐户的属性。

类型别名

AccessRuleDirection	访问方向规则 KnownAccessRuleDirection 可与 AccessRuleDirection 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 入站：适用于安全资源的入站网络流量。 出站：适用于来自受保护资源的出站网络流量
AccountKeyType	要重新生成的帐户密钥的类型。
AllocationState	池是否调整大小。
AuthenticationMode	Batch 帐户的身份验证模式。
AutoStorageAuthenticationMode	Batch 服务用于管理自动存储帐户的身份验证模式。
AutoUserScope	默认值为 Pool。 如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。 例如，如果任务以可能影响其他任务的方式更改注册表。
AzureSupportedClouds	云设置为字符串文字类型的支持值
CachingType	要为磁盘启用的缓存类型。
ComputeNodeDeallocationOption	确定在为解除分配选择节点后如何处理节点及其正在运行的任务。
ComputeNodeFillType	如何跨计算节点分配任务。
ContainerHostDataPath	将装载到容器任务的容器的路径。 KnownContainerHostDataPath 可与 ContainerHostDataPath 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 共享：用于共享其文件的多实例任务的路径。 启动：启动任务的路径。 VfsMounts：路径包含此节点上装载的所有虚拟文件系统。 任务：任务路径。 JobPrep：作业准备任务路径。 应用程序：应用程序路径。
ContainerType	要使用的容器技术。 KnownContainerType 可与 ContainerType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 DockerCompatible：Docker 兼容的容器技术将用于启动容器。 CriCompatible：基于 CRI 的技术将用于启动容器。
ContainerWorkingDirectory	用于指示容器任务工作目录所在的位置的标志。 默认值为“taskWorkingDirectory”。
ContinuablePage	描述结果页的接口。
CreatedByType	创建资源的实体类型。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：实体是由用户创建的。 应用程序：实体是由应用程序创建的。 ManagedIdentity：实体是由托管标识创建的。 密钥：实体是由密钥创建的。
DiffDiskPlacement	作系统磁盘应该放置的位置。
DiskEncryptionTarget	如果省略，池中的计算节点上没有磁盘将被加密。
DynamicVNetAssignmentScope	动态 vnet 分配的范围。
ElevationLevel	用户的提升级别。
EndpointAccessDefaultAction	终结点访问的默认操作。 仅当启用了 publicNetworkAccess 时，它才适用。
HostEndpointSettingsModeTypes	指定访问控制策略执行模式。 KnownHostEndpointSettingsModeTypes 可以与 HostEndpointSettingsModeTypes 互换使用，该枚举包含服务支持的已知值。 服务支持的已知值 审计：在审计模式下，系统表现得好像在执行访问控制策略，包括在日志中发布访问拒绝条目，但实际上并未拒绝任何寄宿端点的请求。 强制执行：强制模式是推荐的操作模式，系统将执行访问控制策略。 该属性不能与“inVMAccessControlProfileReferenceId”一起使用。
IPAddressProvisioningType	Batch 池的公共 IP 地址的预配类型。
IPFamily	用于指定池可用的 IP 版本的 IP 系列。 KnownIPFamily 可以与 IPFamily 互换使用，该枚举包含服务支持的已知值。 服务支持的已知值 IPv4：池中可用IPv4。 IPv6：池中可用IPv6。
IPRuleAction	当客户端IP地址匹配时的作。
InboundEndpointProtocol	终结点的协议。
InterNodeCommunicationState	这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。
IssueType	问题类型 KnownIssueType 可与 IssueType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未知：未知问题类型 ConfigurationPropagationFailure：应用网络安全外围（NSP）配置时出错。 MissingPerimeterConfiguration：通过向网络安全外围（NSP）添加新资源或通过修改访问规则来解决网络连接问题。 MissingIdentityConfiguration：托管标识尚未与资源关联。 该资源仍能够验证来自网络安全外围（NSP）或匹配入站访问规则的入站流量，但无法将出站访问作为 NSP 的成员执行。
JobDefaultOrder	从具有相同优先级的不同作业中调度任务的顺序。 KnownJobDefaultOrder 可以与 JobDefaultOrder 互换使用，该枚举包含服务支持的已知值。 服务支持的已知值 无：任务应从池中所有同等优先级的作业统一调度。 创建时间：如果作业优先级相等，应优先调度之前创建的任务。
KeySource	密钥源的类型。
LoginMode	指定用户的登录模式。 默认值为 Interactive。
NameAvailabilityReason	获取无法使用 Batch 帐户名称的原因。 仅当 NameAvailable 为 false 时，才返回 Reason 元素。
NetworkSecurityGroupRuleAccess	应对指定 IP 地址、子网范围或标记执行的操作。
NetworkSecurityPerimeterConfigurationProvisioningState	正在创建或更新的网络安全外围配置的预配状态。 KnownNetworkSecurityPerimeterConfigurationProvisioningState 可与 NetworkSecurityPerimeterConfigurationProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功 创建 更新 删除 已接受 失败 已取消
NodePlacementPolicyType	默认值是区域性的。
PackageState	应用程序包的当前状态。
PoolAllocationMode	用于在 Batch 帐户中创建池的分配模式。
PoolIdentityType	用于 Batch 池的标识类型。
PoolProvisioningState	池的当前状态。
PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
PrivateLinkServiceConnectionStatus	Batch 专用终结点连接的状态
ProvisioningState	资源的预配状态
PublicNetworkAccessType	用于在 Batch 帐户中的资源上运行的网络访问类型。
ResourceAssociationAccessMode	资源关联的访问模式 KnownResourceAssociationAccessMode 可与 ResourceAssociationAccessMode 互换，此枚举包含服务支持的已知值。 服务支持的已知值 强制：强制访问模式 - 阻止访问检查失败的资源的流量 学习：学习访问模式 - 资源流量已启用分析，但未阻止 审核：审核访问模式 - 记录访问检查失败但未阻止的资源的流量
ResourceIdentityType	用于 Batch 帐户的标识类型。
ResourceType	这是请求列出作的结果。
SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 用于加密管理磁盘和 VMGuestState blob，设置为 VMGuestStateOnly 用于仅加密 VMGuestState blob，以及 NonPersistedTPM 用于不保持 VMGuestState blob 中的固件状态。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。 KnownSecurityEncryptionTypes 可与 SecurityEncryptionTypes 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 NonPersistedTPM：托管磁盘的 EncryptionType 设置为 NonPersistedTPM，以便不在 VMGuestState blob 中保留固件状态。 VMGuestStateOnly：托管磁盘的 EncryptionType 设置为 VMGuestStateOnly，以便仅对 VMGuestState blob 进行加密。 DiskWithVMGuestState：托管磁盘的 EncryptionType 设置为 DiskWithVMGuestState，以便对托管磁盘和 VMGuestState blob 进行加密。 数据磁盘不支持此功能。
SecurityTypes	指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。
Severity	问题的严重性。 KnownSeverity 可以互换与严重性一起使用，此枚举包含服务支持的已知值。 服务支持的已知值 警告 错误
StorageAccountType	用于创建数据磁盘或 OS 磁盘的存储帐户类型。
UpgradeMode	指定升级到规模集中虚拟机的模式。 可能的值为： 手动 - 控制对规模集中虚拟机的更新的应用程序。 使用 manualUpgrade 操作执行此操作。 自动 - 规模集中的所有虚拟机同时自动更新。 滚动 - 规模集按批执行更新，并在两者之间有可选的暂停时间。

枚举

AzureClouds	用于描述 Azure 云环境的枚举。
KnownAccessRuleDirection	访问规则的方向
KnownContainerHostDataPath	将装载到容器任务的容器的路径。
KnownContainerType	要使用的容器技术。
KnownCreatedByType	创建资源的实体类型。
KnownHostEndpointSettingsModeTypes	指定访问控制策略执行模式。
KnownIPFamily	用于指定池可用的 IP 版本的 IP 系列。
KnownIssueType	问题类型
KnownJobDefaultOrder	从具有相同优先级的不同作业中调度任务的顺序。
KnownNetworkSecurityPerimeterConfigurationProvisioningState	正在创建或更新的网络安全外围配置的预配状态。
KnownResourceAssociationAccessMode	资源关联的访问模式
KnownSecurityEncryptionTypes	指定托管磁盘的 EncryptionType。 它设置为 DiskWithVMGuestState 用于加密管理磁盘和 VMGuestState blob，设置为 VMGuestStateOnly 用于仅加密 VMGuestState blob，以及 NonPersistedTPM 用于不保持 VMGuestState blob 中的固件状态。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。
KnownSeverity	问题的严重性。
KnownVersions	可用的 API 版本。

函数

restorePoller<TResponse, TResult>(BatchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

函数详细信息

restorePoller<TResponse, TResult>(BatchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

function restorePoller<TResponse, TResult>(client: BatchManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

client

BatchManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

返回

PollerLike<OperationState<TResult>, TResult>