共用方式為

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<@azure/core-lro.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>