PoolOperations クラス
PoolOperations 操作。
このクラスを直接インスタンス化するのではなく、クライアント インスタンスを作成して属性としてアタッチします。
- 継承
-
builtins.objectPoolOperations
コンストラクター
PoolOperations(client, config, serializer, deserializer)パラメーター
- client
サービス要求のクライアント。
- config
サービス クライアントの構成。
- serializer
オブジェクト モデル シリアライザー。
- deserializer
オブジェクト モデル逆シリアライザー。
変数
- api_version
要求で使用する API のバージョン。 定数値: "2023-05-01.17.0"
メソッド
| add |
指定したアカウントにプールを追加します。 プールに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示されることがあります。 |
| delete |
指定したアカウントからプールを削除します。 プールの削除を要求すると、次のアクションが発生します。プールの状態は削除中に設定されています。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティング ノードに変更し始めます。既存のコンピューティング ノードで実行されているタスクはすべて終了し、再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。 実行中のタスクはキューに入れ直されるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。 その後、タスクは新しいプールで実行できます。 リキューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出して、プールを 0 サイズに縮小する必要があります。 削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラー コード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。 |
| disable_auto_scale |
プールの自動スケーリングを無効にします。 |
| enable_auto_scale |
プールの自動スケーリングを有効にします。 プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。 プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケーリング式を指定する必要があります。 プールの自動スケーリングが既に有効になっている場合は、新しい自動スケーリング式または新しい評価間隔を指定できます。 30 秒ごとに同じプールに対してこの API を複数回呼び出すことはできません。 |
| evaluate_auto_scale |
プールの自動スケーリング式を評価した結果を取得します。 この API は、プールに数式を適用せずに単に結果を返すので、主に自動スケーリング式を検証するための API です。 数式を評価するには、プールで自動スケーリングが有効になっている必要があります。 |
| exists |
プールの基本プロパティを取得します。 |
| get |
指定したプールに関する情報を取得します。 |
| list |
指定したアカウント内のすべてのプールを一覧表示します。 |
| list_usage_metrics |
指定されたアカウントの個々の時間間隔にわたってプールによって集計された使用状況メトリックを一覧表示します。 poolId を含む$filter句を指定しない場合、応答には、返される集計間隔の時間範囲内の Account に存在するすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは既定で、現在使用可能な最後の集計間隔の開始時刻と終了時刻になります。つまり、最後の集計間隔のみが返されます。 |
| patch |
指定した Pool のプロパティを更新します。 これは、要求で指定された Pool プロパティのみを置き換えます。 たとえば、プールに StartTask が関連付けられている場合、要求で StartTask 要素が指定されていない場合、プールは既存の StartTask を保持します。 |
| remove_nodes |
指定したプールからコンピューティング ノードを削除します。 この操作は、プールの割り当て状態が安定している場合にのみ実行できます。 この操作を実行すると、割り当ての状態が安定した状態からサイズ変更に変わります。 各要求では、最大 100 個のノードを削除できます。 |
| resize |
プールに割り当てられているコンピューティング ノードの数を変更します。 プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。 プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。 プールのサイズを変更すると、プールの割り当て状態が安定した状態からサイズ変更に変わります。 自動スケーリング用に構成されているプールのサイズを変更することはできません。 これを行おうとすると、Batch サービスからエラー 409 が返されます。 プールのサイズを下方向に変更すると、Batch サービスによって削除するコンピューティング ノードが選択されます。 特定のコンピューティング ノードを削除するには、代わりにプールのコンピューティング ノードの削除 API を使用します。 |
| stop_resize |
プールで進行中のサイズ変更操作を停止します。 これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。変更が加えられるのはそれ以上停止し、プールは現在の状態を維持します。 停止後、プールは停止操作が行われた時点のコンピューティング ノードの数で安定します。 停止操作中に、プール割り当ての状態が最初に停止状態に変わり、次に安定した状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API は、作成時にプールの初期サイズ設定を停止するためにも使用できます。 |
| update_properties |
指定した Pool のプロパティを更新します。 これにより、Pool のすべての更新可能なプロパティが完全に置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。 |
add
指定したアカウントにプールを追加します。
プールに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示されることがあります。
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
delete
指定したアカウントからプールを削除します。
プールの削除を要求すると、次のアクションが発生します。プールの状態は削除中に設定されています。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティング ノードに変更し始めます。既存のコンピューティング ノードで実行されているタスクはすべて終了し、再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。 実行中のタスクはキューに入れ直されるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。 その後、タスクは新しいプールで実行できます。 リキューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出して、プールを 0 サイズに縮小する必要があります。 削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラー コード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
disable_auto_scale
プールの自動スケーリングを無効にします。
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
enable_auto_scale
プールの自動スケーリングを有効にします。
プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。 プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケーリング式を指定する必要があります。 プールの自動スケーリングが既に有効になっている場合は、新しい自動スケーリング式または新しい評価間隔を指定できます。 30 秒ごとに同じプールに対してこの API を複数回呼び出すことはできません。
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- auto_scale_formula
- str
式は、プールに適用される前に有効性を確認します。 式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする ()」https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scalingを参照してください。
- auto_scale_evaluation_interval
- <xref:timedelta>
既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 新しい間隔を指定すると、既存の自動スケーリング評価スケジュールが停止され、新しい自動スケーリング評価スケジュールが開始され、開始時刻はこの要求が発行された時刻になります。
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
evaluate_auto_scale
プールの自動スケーリング式を評価した結果を取得します。
この API は、プールに数式を適用せずに単に結果を返すので、主に自動スケーリング式を検証するための API です。 数式を評価するには、プールで自動スケーリングが有効になっている必要があります。
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- auto_scale_formula
- str
数式が検証され、その結果が計算されますが、プールには適用されません。 プールに数式を適用するには、「プールの自動スケーリングを有効にする」を参照してください。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする ()」https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scalingを参照してください。
- operation_config
操作の構成がオーバーライドされます。
戻り値
autoScaleRun または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
exists
プールの基本プロパティを取得します。
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
bool または ClientRawResponse if raw=true
の戻り値の型 :
例外
get
指定したプールに関する情報を取得します。
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
cloudPool または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
list
指定したアカウント内のすべてのプールを一覧表示します。
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
CloudPool のインスタンスのような反復子
の戻り値の型 :
例外
list_usage_metrics
指定されたアカウントの個々の時間間隔にわたってプールによって集計された使用状況メトリックを一覧表示します。
poolId を含む$filter句を指定しない場合、応答には、返される集計間隔の時間範囲内の Account に存在するすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは既定で、現在使用可能な最後の集計間隔の開始時刻と終了時刻になります。つまり、最後の集計間隔のみが返されます。
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
PoolUsageMetrics のインスタンスのような反復子
の戻り値の型 :
例外
patch
指定した Pool のプロパティを更新します。
これは、要求で指定された Pool プロパティのみを置き換えます。 たとえば、プールに StartTask が関連付けられている場合、要求で StartTask 要素が指定されていない場合、プールは既存の StartTask を保持します。
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
remove_nodes
指定したプールからコンピューティング ノードを削除します。
この操作は、プールの割り当て状態が安定している場合にのみ実行できます。 この操作を実行すると、割り当ての状態が安定した状態からサイズ変更に変わります。 各要求では、最大 100 個のノードを削除できます。
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
resize
プールに割り当てられているコンピューティング ノードの数を変更します。
プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。 プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。 プールのサイズを変更すると、プールの割り当て状態が安定した状態からサイズ変更に変わります。 自動スケーリング用に構成されているプールのサイズを変更することはできません。 これを行おうとすると、Batch サービスからエラー 409 が返されます。 プールのサイズを下方向に変更すると、Batch サービスによって削除するコンピューティング ノードが選択されます。 特定のコンピューティング ノードを削除するには、代わりにプールのコンピューティング ノードの削除 API を使用します。
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
stop_resize
プールで進行中のサイズ変更操作を停止します。
これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。変更が加えられるのはそれ以上停止し、プールは現在の状態を維持します。 停止後、プールは停止操作が行われた時点のコンピューティング ノードの数で安定します。 停止操作中に、プール割り当ての状態が最初に停止状態に変わり、次に安定した状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API は、作成時にプールの初期サイズ設定を停止するためにも使用できます。
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
update_properties
指定した Pool のプロパティを更新します。
これにより、Pool のすべての更新可能なプロパティが完全に置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
属性
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python