PoolOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

BatchManagementClient's

<xref:pool> 属性を使用する。

継承

builtins.object

PoolOperations

コンストラクター

PoolOperations(*args, **kwargs)

メソッド

begin_delete	指定したプールを削除します。
create	指定したアカウント内に新しいプールを作成します。
disable_auto_scale	プールの自動スケーリングを無効にします。
get	指定したプールに関する情報を取得します。
list_by_batch_account	指定されたアカウント内のすべてのプールの一覧を取得します。
stop_resize	プールで実行中のサイズ変更操作を停止します。 これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。それ以降の変更のみが停止され、プールは現在の状態を維持します。 停止後、停止操作が行われた時点のノード数でプールが安定します。 停止操作中に、プール割り当ての状態が最初に停止状態に変わり、次に安定した状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API を使用して、作成時にプールの初期サイズ設定を停止することもできます。
update	既存のプールのプロパティを更新します。

begin_delete

指定したプールを削除します。

async begin_delete(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> AsyncLROPoller[None]

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

pool_name

str

必須

プール名。 これは、アカウント内で一意である必要があります。 必須。

cls

callable

直接応答が渡されるカスタム型または関数

continuation_token

str

保存された状態からポーリングを再開するための継続トークン。

polling

bool または AsyncPollingMethod

既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。

polling_interval

int

Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

None または cls(response) の結果を返す AsyncLROPoller のインスタンス

の戻り値の型 :

AsyncLROPoller[None]

例外

HttpResponseError

create

指定したアカウント内に新しいプールを作成します。

async create(resource_group_name: str, account_name: str, pool_name: str, parameters: _models.Pool, if_match: str | None = None, if_none_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Pool

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

pool_name

str

必須

プール名。 これは、アカウント内で一意である必要があります。 必須。

parameters

Pool または IO

必須

プール作成用の追加パラメーター。 プール型または IO 型のいずれかです。 必須。

if_match

str

必須

更新するプールのエンティティ状態 (ETag) バージョン。 値 "*" は、プールが既に存在する場合にのみ操作を適用するために使用できます。 省略すると、この操作は常に適用されます。 既定値は [なし] です。

if_none_match

str

必須

新しいプールを作成できるようにするが、既存のプールを更新できないようにするには、'*' に設定します。 その他の値は無視されます。 既定値は [なし] です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

プールまたは cls(response) の結果

の戻り値の型 :

Pool

例外

HttpResponseError

disable_auto_scale

プールの自動スケーリングを無効にします。

async disable_auto_scale(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> Pool

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

pool_name

str

必須

プール名。 これは、アカウント内で一意である必要があります。 必須。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

プールまたは cls(response) の結果

の戻り値の型 :

Pool

例外

HttpResponseError

get

指定したプールに関する情報を取得します。

async get(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> Pool

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

pool_name

str

必須

プール名。 これは、アカウント内で一意である必要があります。 必須。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

プールまたは cls(response) の結果

の戻り値の型 :

Pool

例外

HttpResponseError

list_by_batch_account

指定されたアカウント内のすべてのプールの一覧を取得します。

list_by_batch_account(resource_group_name: str, account_name: str, maxresults: int | None = None, select: str | None = None, filter: str | None = None, **kwargs: Any) -> AsyncIterable[Pool]

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

maxresults

int

必須

応答で返される項目の最大数。 既定値は [なし] です。

select

str

必須

返されるプロパティのコンマ区切りの一覧。 例: "properties/provisioningState" プロパティ/ の最上位レベルのプロパティのみが選択に対して有効です。 既定値は [なし] です。

filter

str

必須

OData フィルター式。 フィルター処理の有効なプロパティは次のとおりです。

name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState Properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

Pool のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

AsyncItemPaged[Pool]

例外

HttpResponseError

stop_resize

プールで実行中のサイズ変更操作を停止します。

これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。それ以降の変更のみが停止され、プールは現在の状態を維持します。 停止後、停止操作が行われた時点のノード数でプールが安定します。 停止操作中に、プール割り当ての状態が最初に停止状態に変わり、次に安定した状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API を使用して、作成時にプールの初期サイズ設定を停止することもできます。

async stop_resize(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> Pool

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

pool_name

str

必須

プール名。 これは、アカウント内で一意である必要があります。 必須。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

プールまたは cls(response) の結果

の戻り値の型 :

Pool

例外

HttpResponseError

update

既存のプールのプロパティを更新します。

async update(resource_group_name: str, account_name: str, pool_name: str, parameters: _models.Pool, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Pool

パラメーター

resource_group_name

str

必須

Batch アカウントを含むリソース グループの名前。 必須。

account_name

str

必須

Batch アカウントの名前。 必須。

pool_name

str

必須

プール名。 これは、アカウント内で一意である必要があります。 必須。

parameters

Pool または IO

必須

更新する必要があるプール プロパティ。 指定されたプロパティは更新され、指定されていないプロパティは変更されません。 プールの種類または IO の種類です。 必須。

if_match

str

必須

更新するプールのエンティティ状態 (ETag) バージョン。 この値を省略するか、"*" に設定すると、無条件に操作を適用できます。 既定値は [なし] です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

プールまたは cls(response) の結果

の戻り値の型 :

Pool

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\batch\\models\\__init__.py'>