PoolOperations interface
PoolOperations を表すインターフェイス。
メソッド
| begin |
指定したプールを削除します。 |
| begin |
指定したプールを削除します。 |
| create(string, string, string, Pool, Pool |
指定したアカウント内に新しいプールを作成します。 |
| disable |
プールの自動スケーリングを無効にします。 |
| get(string, string, string, Pool |
指定したプールに関する情報を取得します。 |
| list |
指定されたアカウント内のすべてのプールを一覧表示します。 |
| stop |
これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。それ以降の変更が停止されるだけで、プールは現在の状態を維持します。 停止後、プールは停止操作が行われた時点のノード数で安定します。 停止操作中に、プール割り当ての状態が最初に停止状態に変わり、次に安定状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API を使用して、プールの作成時にプールの初期サイズ設定を停止することもできます。 |
| update(string, string, string, Pool, Pool |
既存のプールのプロパティを更新します。 |
メソッドの詳細
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
プール名。 これはアカウント内で一意である必要があります。
オプション パラメーター。
戻り値
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 アカウントの名前。
オプション パラメーター。
戻り値
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>