次の方法で共有


JobScheduleOperations クラス

JobScheduleOperations 操作。

このクラスを直接インスタンス化するのではなく、それを作成して属性としてアタッチするクライアント インスタンスを作成する必要があります。

継承
builtins.object
JobScheduleOperations

コンストラクター

JobScheduleOperations(client, config, serializer, deserializer)

パラメーター

client
必須

サービス要求のクライアント。

config
必須

サービス クライアントの構成。

serializer
必須

オブジェクト モデル シリアライザー。

deserializer
必須

オブジェクト モデル逆シリアライザー。

変数

api_version

要求で使用する API のバージョン。 定数値: "2023-05-01.17.0"

メソッド

add

指定したアカウントにジョブ スケジュールを追加します。

delete

指定したアカウントからジョブ スケジュールを削除します。

ジョブ スケジュールを削除すると、そのスケジュールのすべてのジョブとタスクも削除されます。 タスクが削除されると、コンピューティング ノード上の作業ディレクトリ内のすべてのファイルも削除されます (保持期間は無視されます)。 ジョブ スケジュール統計は、ジョブ スケジュールが削除されるとアクセスできなくなりますが、アカウントの有効期間統計にカウントされます。

disable

ジョブ スケジュールを無効にします。

ジョブ スケジュールが再度有効になるまで、新しいジョブは作成されません。

enable

ジョブ スケジュールを有効にします。

exists

指定したジョブ スケジュールが存在するかどうかを確認します。

get

指定したジョブ スケジュールに関する情報を取得します。

list

指定したアカウント内のすべてのジョブ スケジュールを一覧表示します。

patch

指定したジョブ スケジュールのプロパティを更新します。

これにより、要求で指定されたジョブ スケジュール プロパティのみが置き換えられます。 たとえば、この要求で schedule プロパティが指定されていない場合、Batch サービスは既存のスケジュールを保持します。 ジョブ スケジュールの変更は、更新が行われた後にスケジュールによって作成されたジョブにのみ影響します。現在実行中のジョブは影響を受けません。

terminate

ジョブ スケジュールを終了します。

update

指定したジョブ スケジュールのプロパティを更新します。

これにより、ジョブ スケジュールのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、この要求で schedule プロパティが指定されていない場合、Batch サービスは既存のスケジュールを削除します。 ジョブ スケジュールの変更は、更新が行われた後にスケジュールによって作成されたジョブにのみ影響します。現在実行中のジョブは影響を受けません。

add

指定したアカウントにジョブ スケジュールを追加します。

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

cloud_job_schedule
JobScheduleAddParameter
必須

追加するジョブ スケジュール。

job_schedule_add_options
JobScheduleAddOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

delete

指定したアカウントからジョブ スケジュールを削除します。

ジョブ スケジュールを削除すると、そのスケジュールのすべてのジョブとタスクも削除されます。 タスクが削除されると、コンピューティング ノード上の作業ディレクトリ内のすべてのファイルも削除されます (保持期間は無視されます)。 ジョブ スケジュール統計は、ジョブ スケジュールが削除されるとアクセスできなくなりますが、アカウントの有効期間統計にカウントされます。

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

削除するジョブ スケジュールの ID。

job_schedule_delete_options
JobScheduleDeleteOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

disable

ジョブ スケジュールを無効にします。

ジョブ スケジュールが再度有効になるまで、新しいジョブは作成されません。

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

無効にするジョブ スケジュールの ID。

job_schedule_disable_options
JobScheduleDisableOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

enable

ジョブ スケジュールを有効にします。

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

有効にするジョブ スケジュールの ID。

job_schedule_enable_options
JobScheduleEnableOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

exists

指定したジョブ スケジュールが存在するかどうかを確認します。

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

チェックするジョブ スケジュールの ID。

job_schedule_exists_options
JobScheduleExistsOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

bool または ClientRawResponse (raw=true の場合)

の戻り値の型 :

bool,

例外

get

指定したジョブ スケジュールに関する情報を取得します。

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

取得するジョブ スケジュールの ID。

job_schedule_get_options
JobScheduleGetOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

cloudJobSchedule または ClientRawResponse (raw=true の場合)

の戻り値の型 :

例外

list

指定したアカウント内のすべてのジョブ スケジュールを一覧表示します。

list(job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_list_options
JobScheduleListOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

CloudJobSchedule のインスタンスのような反復子

の戻り値の型 :

例外

patch

指定したジョブ スケジュールのプロパティを更新します。

これにより、要求で指定されたジョブ スケジュール プロパティのみが置き換えられます。 たとえば、この要求で schedule プロパティが指定されていない場合、Batch サービスは既存のスケジュールを保持します。 ジョブ スケジュールの変更は、更新が行われた後にスケジュールによって作成されたジョブにのみ影響します。現在実行中のジョブは影響を受けません。

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

更新するジョブ スケジュールの ID。

job_schedule_patch_parameter
JobSchedulePatchParameter
必須

要求のパラメーター。

job_schedule_patch_options
JobSchedulePatchOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

terminate

ジョブ スケジュールを終了します。

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

終了するジョブ スケジュールの ID。

job_schedule_terminate_options
JobScheduleTerminateOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

update

指定したジョブ スケジュールのプロパティを更新します。

これにより、ジョブ スケジュールのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、この要求で schedule プロパティが指定されていない場合、Batch サービスは既存のスケジュールを削除します。 ジョブ スケジュールの変更は、更新が行われた後にスケジュールによって作成されたジョブにのみ影響します。現在実行中のジョブは影響を受けません。

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

パラメーター

job_schedule_id
str
必須

更新するジョブ スケジュールの ID。

job_schedule_update_parameter
JobScheduleUpdateParameter
必須

要求のパラメーター。

job_schedule_update_options
JobScheduleUpdateOptions
既定値: None

操作の追加パラメーター

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,

例外

属性

models

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