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

PoolOperations interface

  • 参考
包:
@azure/arm-batch

表示 PoolOperations 的接口。

方法

beginDelete(string, string, string, PoolDeleteOptionalParams)

删除指定的池。
beginDeleteAndWait(string, string, string, PoolDeleteOptionalParams)

删除指定的池。
create(string, string, string, Pool, PoolCreateOptionalParams)

在指定的帐户内创建新池。
disableAutoScale(string, string, string, PoolDisableAutoScaleOptionalParams)

禁用池的自动缩放。
get(string, string, string, PoolGetOptionalParams)

获取有关指定池的信息。
listByBatchAccount(string, string, PoolListByBatchAccountOptionalParams)

列出指定帐户中的所有池。
stopResize(string, string, string, PoolStopResizeOptionalParams)

这不会在重设大小操作之前将池还原到其以前的状态：它只会停止正在进行的任何进一步更改，并且池会保持其当前状态。 停止后，池会稳定在停止操作完成时的节点数。 在停止操作期间，池分配状态首先更改为“正在停止”，然后更改为“稳定”。 调整大小操作不需要是显式调整池大小请求;此 API 还可用于在创建池时停止池的初始大小调整。
update(string, string, string, Pool, PoolUpdateOptionalParams)

汇报现有池的属性。

方法详细信息

beginDelete(string, string, string, PoolDeleteOptionalParams)

删除指定的池。

function beginDelete(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

options
PoolDeleteOptionalParams

选项参数。

返回

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, PoolDeleteOptionalParams)

删除指定的池。

function beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

options
PoolDeleteOptionalParams

选项参数。

返回

Promise<void>

create(string, string, string, Pool, PoolCreateOptionalParams)

在指定的帐户内创建新池。

function create(resourceGroupName: string, accountName: string, poolName: string, parameters: Pool, options?: PoolCreateOptionalParams): Promise<PoolCreateResponse>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

parameters
Pool

用于创建池的其他参数。

options
PoolCreateOptionalParams

选项参数。

返回

Promise<PoolCreateResponse>

disableAutoScale(string, string, string, PoolDisableAutoScaleOptionalParams)

禁用池的自动缩放。

function disableAutoScale(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

options
PoolDisableAutoScaleOptionalParams

选项参数。

返回

Promise<PoolDisableAutoScaleResponse>

get(string, string, string, PoolGetOptionalParams)

获取有关指定池的信息。

function get(resourceGroupName: string, accountName: string, poolName: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

options
PoolGetOptionalParams

选项参数。

返回

Promise<PoolGetResponse>

listByBatchAccount(string, string, PoolListByBatchAccountOptionalParams)

列出指定帐户中的所有池。

function listByBatchAccount(resourceGroupName: string, accountName: string, options?: PoolListByBatchAccountOptionalParams): PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

options
PoolListByBatchAccountOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

stopResize(string, string, string, PoolStopResizeOptionalParams)

这不会在重设大小操作之前将池还原到其以前的状态：它只会停止正在进行的任何进一步更改，并且池会保持其当前状态。 停止后，池会稳定在停止操作完成时的节点数。 在停止操作期间，池分配状态首先更改为“正在停止”，然后更改为“稳定”。 调整大小操作不需要是显式调整池大小请求;此 API 还可用于在创建池时停止池的初始大小调整。

function stopResize(resourceGroupName: string, accountName: string, poolName: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

options
PoolStopResizeOptionalParams

选项参数。

返回

Promise<PoolStopResizeResponse>

update(string, string, string, Pool, PoolUpdateOptionalParams)

汇报现有池的属性。

function update(resourceGroupName: string, accountName: string, poolName: string, parameters: Pool, options?: PoolUpdateOptionalParams): Promise<PoolUpdateResponse>

参数

resourceGroupName

string

包含 Batch 帐户的资源组的名称。

accountName

string

Batch 帐户的名称。

poolName

string

池名称。 这在帐户中必须是唯一的。

parameters
Pool

应更新的池属性。 提供的属性将更新，未提供的任何属性都将保持不变。

options
PoolUpdateOptionalParams

选项参数。

返回

Promise<PoolUpdateResponse>