Schedule クラス

スケジュールの作成と管理に使用される Schedule オブジェクト。

このクラスを直接インスタンス化しないでください。 代わりに、サブクラスを使用してください。

継承

azure.ai.ml.entities._mixins.YamlTranslatableMixin

Schedule

azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin

Schedule

azure.ai.ml.entities._resource.Resource

Schedule

コンストラクター

Schedule(*, name: str, trigger: CronTrigger | RecurrenceTrigger, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs)

パラメーター

name

str

スケジュールの名前です。

trigger

Union[CronTrigger, RecurrenceTrigger]

スケジュール トリガーの構成。

display_name

Optional[str]

スケジュールの表示名。

description

Optional[str]

スケジュールの説明。

tags

Optional[dict]]

タグ辞書。 タグは追加、削除、更新できます。

properties

Optional[dict[str, str]]

スケジュールに関連付けるプロパティのディクショナリ。

kwargs

dict

Resource コンストラクターに渡される追加のキーワード (keyword)引数。

メソッド

dump	スケジュール コンテンツを YAML 形式のファイルにダンプします。

dump

スケジュール コンテンツを YAML 形式のファイルにダンプします。

dump(dest: str | PathLike | IO, **kwargs) -> None

パラメーター

dest

Union[<xref:PathLike>, str, IO[AnyStr]]

必須

YAML コンテンツを書き込むローカル パスまたはファイル ストリーム。 dest がファイル パスの場合は、新しいファイルが作成されます。 dest が開いているファイルの場合、ファイルは に直接書き込まれます。

kwargs

dict

YAML シリアライザーに渡す追加の引数。

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス。

の戻り値の型 :

str

create_job

creation_context

リソースの作成コンテキスト。

戻り値

リソースの作成メタデータ。

の戻り値の型 :

Optional[SystemData]

id

リソース ID。

戻り値

リソースのグローバル ID、Azure Resource Manager (ARM) ID。

の戻り値の型 :

Optional[str]

is_enabled

スケジュールを有効にするかどうかを指定します。

戻り値

スケジュールが有効な場合は True、それ以外の場合は False。

の戻り値の型 :

bool

provisioning_state

スケジュールのプロビジョニング状態を返します。 使用できる値には、"Creating"、"Updating"、"Removeing"、"Succeeded"、"Failed"、"Canceled" などがあります。

戻り値

スケジュールのプロビジョニング状態。

の戻り値の型 :

str

type

スケジュールの種類。 受け入れられる値は、'job' と 'monitor' です。

戻り値

スケジュールの種類。

の戻り値の型 :

str