JobOperations クラス
JobOperations 操作。
このクラスを直接インスタンス化するのではなく、クライアント インスタンスを作成して属性としてアタッチします。
- 継承
-
builtins.objectJobOperations
コンストラクター
JobOperations(client, config, serializer, deserializer)パラメーター
- client
サービス要求のクライアント。
- config
サービス クライアントの構成。
- serializer
オブジェクト モデル シリアライザー。
- deserializer
オブジェクト モデル逆シリアライザー。
変数
- api_version
要求で使用する API のバージョン。 定数値: "2023-05-01.17.0"
メソッド
| add |
指定したアカウントにジョブを追加します。 Batch サービスでは、ジョブの一部として実行される作業を制御する 2 つの方法がサポートされています。 最初の方法では、ユーザーはジョブ マネージャー タスクを指定します。 Batch サービスは、ジョブを開始する準備ができたら、このタスクを起動します。 ジョブ マネージャー タスクは、タスク API を使用して、このジョブで実行される他のすべてのタスクを制御します。 2 番目の方法では、ユーザーは、タスク API を使用して、アクティブなジョブの下でタスクの実行を直接制御します。 また、ジョブに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示されることがあります。 |
| delete |
ジョブを削除します。 ジョブを削除すると、そのジョブの一部であるすべてのタスクと、すべてのジョブ統計も削除されます。 これにより、タスク データの保持期間もオーバーライドされます。つまり、ジョブにコンピューティング ノードに保持されているタスクがジョブに含まれている場合、Batch サービスはそれらのタスクの作業ディレクトリとそのすべての内容を削除します。 ジョブの削除要求を受信すると、Batch サービスはジョブを削除状態に設定します。 状態を削除中のジョブに対するすべての更新操作は、状態コード 409 (競合) で失敗し、ジョブが削除されていることを示す追加情報が表示されます。 |
| disable |
指定したジョブを無効にし、新しいタスクが実行されないようにします。 Batch サービスは、ジョブをすぐに無効化状態に移動します。 その後、Batch は disableTasks パラメーターを使用して、ジョブの現在実行中のタスクの処理を決定します。 無効化操作が完了し、disableTasks オプションに従ってすべてのタスクが処理されるまで、ジョブは無効化状態のままになります。その後、ジョブは無効な状態に移動します。 アクティブな状態に戻るまで、ジョブの下で新しいタスクは開始されません。 アクティブ、無効化、または無効以外の状態のジョブを無効にしようとすると、要求は状態コード 409 で失敗します。 |
| enable |
指定したジョブを有効にして、新しいタスクを実行できるようにします。 この API を呼び出すと、Batch サービスは無効なジョブを有効化状態に設定します。 この操作が完了すると、ジョブはアクティブな状態に移動し、ジョブの下の新しいタスクのスケジュールが再開されます。 Batch サービスでは、タスクを 180 日を超えてアクティブな状態を維持することはできません。 したがって、180 日以上前に追加されたアクティブなタスクを含むジョブを有効にすると、それらのタスクは実行されません。 |
| get |
指定したジョブに関する情報を取得します。 |
| get_task_counts |
指定したジョブのタスク数を取得します。 タスク数は、アクティブ、実行中、または完了したタスクの状態によるタスクの数と、成功または失敗したタスクの数を提供します。 準備状態のタスクは、実行中としてカウントされます。 返される数値が常に最新であるとは限りません。 正確なタスク数が必要な場合は、リスト クエリを使用します。 |
| list |
指定したアカウント内のすべてのジョブを一覧表示します。 |
| list_from_job_schedule |
指定したジョブ スケジュールの下に作成されたジョブを一覧表示します。 |
| list_preparation_and_release_task_status |
ジョブが実行されているコンピューティング ノード全体で、指定したジョブのジョブ準備タスクとジョブ 解放タスクの実行状態を一覧表示します。 この API は、ジョブ準備タスクまたはジョブ解放タスクを実行したすべてのコンピューティング ノードのジョブ準備タスクとジョブ解放タスクの状態を返します。 これには、プールから削除されたコンピューティング ノードが含まれます。 ジョブ準備タスクまたはジョブ 解放タスクがないジョブでこの API が呼び出された場合、Batch サービスは HTTP 状態コード 409 (競合) を JobPreparationTaskNotSpecified のエラー コードと共に返します。 |
| patch |
指定した Job のプロパティを更新します。 これにより、要求で指定された Job プロパティのみが置き換えられます。 たとえば、Job に制約があり、要求で制約要素が指定されていない場合、ジョブは既存の制約を保持します。 |
| terminate |
指定したジョブを終了し、完了としてマークします。 ジョブの終了要求を受信すると、Batch サービスはジョブを終了状態に設定します。 その後、Batch サービスは、ジョブに関連付けられている実行中のタスクをすべて終了し、必要なジョブ リリース タスクを実行します。 その後、ジョブは完了した状態に移行します。 アクティブな状態のジョブにタスクがある場合、それらはアクティブな状態のままです。 ジョブが終了すると、新しいタスクを追加できず、残りのアクティブなタスクはスケジュールされません。 |
| update |
指定した Job のプロパティを更新します。 これにより、ジョブの更新可能なすべてのプロパティが完全に置き換えられます。 たとえば、ジョブに制約が関連付けられている場合、この要求で制約が指定されていない場合、Batch サービスは既存の制約を削除します。 |
add
指定したアカウントにジョブを追加します。
Batch サービスでは、ジョブの一部として実行される作業を制御する 2 つの方法がサポートされています。 最初の方法では、ユーザーはジョブ マネージャー タスクを指定します。 Batch サービスは、ジョブを開始する準備ができたら、このタスクを起動します。 ジョブ マネージャー タスクは、タスク API を使用して、このジョブで実行される他のすべてのタスクを制御します。 2 番目の方法では、ユーザーは、タスク API を使用して、アクティブなジョブの下でタスクの実行を直接制御します。 また、ジョブに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示されることがあります。
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
delete
ジョブを削除します。
ジョブを削除すると、そのジョブの一部であるすべてのタスクと、すべてのジョブ統計も削除されます。 これにより、タスク データの保持期間もオーバーライドされます。つまり、ジョブにコンピューティング ノードに保持されているタスクがジョブに含まれている場合、Batch サービスはそれらのタスクの作業ディレクトリとそのすべての内容を削除します。 ジョブの削除要求を受信すると、Batch サービスはジョブを削除状態に設定します。 状態を削除中のジョブに対するすべての更新操作は、状態コード 409 (競合) で失敗し、ジョブが削除されていることを示す追加情報が表示されます。
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
disable
指定したジョブを無効にし、新しいタスクが実行されないようにします。
Batch サービスは、ジョブをすぐに無効化状態に移動します。 その後、Batch は disableTasks パラメーターを使用して、ジョブの現在実行中のタスクの処理を決定します。 無効化操作が完了し、disableTasks オプションに従ってすべてのタスクが処理されるまで、ジョブは無効化状態のままになります。その後、ジョブは無効な状態に移動します。 アクティブな状態に戻るまで、ジョブの下で新しいタスクは開始されません。 アクティブ、無効化、または無効以外の状態のジョブを無効にしようとすると、要求は状態コード 409 で失敗します。
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
enable
指定したジョブを有効にして、新しいタスクを実行できるようにします。
この API を呼び出すと、Batch サービスは無効なジョブを有効化状態に設定します。 この操作が完了すると、ジョブはアクティブな状態に移動し、ジョブの下の新しいタスクのスケジュールが再開されます。 Batch サービスでは、タスクを 180 日を超えてアクティブな状態を維持することはできません。 したがって、180 日以上前に追加されたアクティブなタスクを含むジョブを有効にすると、それらのタスクは実行されません。
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
get
指定したジョブに関する情報を取得します。
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は CloudJob または ClientRawResponse
の戻り値の型 :
例外
get_task_counts
指定したジョブのタスク数を取得します。
タスク数は、アクティブ、実行中、または完了したタスクの状態によるタスクの数と、成功または失敗したタスクの数を提供します。 準備状態のタスクは、実行中としてカウントされます。 返される数値が常に最新であるとは限りません。 正確なタスク数が必要な場合は、リスト クエリを使用します。
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
taskCountsResult または ClientRawResponse (raw=true の場合)
の戻り値の型 :
例外
list
指定したアカウント内のすべてのジョブを一覧表示します。
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
CloudJob のインスタンスのような反復子
の戻り値の型 :
例外
list_from_job_schedule
指定したジョブ スケジュールの下に作成されたジョブを一覧表示します。
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
CloudJob のインスタンスのような反復子
の戻り値の型 :
例外
list_preparation_and_release_task_status
ジョブが実行されているコンピューティング ノード全体で、指定したジョブのジョブ準備タスクとジョブ 解放タスクの実行状態を一覧表示します。
この API は、ジョブ準備タスクまたはジョブ解放タスクを実行したすべてのコンピューティング ノードのジョブ準備タスクとジョブ解放タスクの状態を返します。 これには、プールから削除されたコンピューティング ノードが含まれます。 ジョブ準備タスクまたはジョブ 解放タスクがないジョブでこの API が呼び出された場合、Batch サービスは HTTP 状態コード 409 (競合) を JobPreparationTaskNotSpecified のエラー コードと共に返します。
list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- job_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
操作の追加パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
JobPreparationAndReleaseTaskExecutionInformation のインスタンスのような反復子
の戻り値の型 :
例外
patch
指定した Job のプロパティを更新します。
これにより、要求で指定された Job プロパティのみが置き換えられます。 たとえば、Job に制約があり、要求で制約要素が指定されていない場合、ジョブは既存の制約を保持します。
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
terminate
指定したジョブを終了し、完了としてマークします。
ジョブの終了要求を受信すると、Batch サービスはジョブを終了状態に設定します。 その後、Batch サービスは、ジョブに関連付けられている実行中のタスクをすべて終了し、必要なジョブ リリース タスクを実行します。 その後、ジョブは完了した状態に移行します。 アクティブな状態のジョブにタスクがある場合、それらはアクティブな状態のままです。 ジョブが終了すると、新しいタスクを追加できず、残りのアクティブなタスクはスケジュールされません。
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)パラメーター
- terminate_reason
- str
- operation_config
操作の構成がオーバーライドされます。
戻り値
raw=true の場合は None または ClientRawResponse
の戻り値の型 :
例外
update
指定した Job のプロパティを更新します。
これにより、ジョブの更新可能なすべてのプロパティが完全に置き換えられます。 たとえば、ジョブに制約が関連付けられている場合、この要求で制約が指定されていない場合、Batch サービスは既存の制約を削除します。
update(job_id, job_update_parameter, job_update_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