次の方法で共有

CLI (v2) インポート スケジュール YAML スキーマ

  • [アーティクル]

適用対象: Azure CLI ml 拡張機能 v2 (現行)

ソース JSON スキーマは https://azuremlschemas.azureedge.net/latest/schedule.schema.json にあります。

Note

このドキュメントで詳しく説明されている YAML 構文は、最新バージョンの ML CLI v2 拡張機能の JSON スキーマに基づいています。 この構文は、ML CLI v2 拡張機能の最新バージョンでのみ動作することが保証されています。 以前のバージョンの拡張機能のスキーマについては、https://azuremlschemasprod.azureedge.net/ でご確認いただけます。

YAML 構文

キー Type 説明 使用できる値
$schema string YAML スキーマ。
name string 必須。 スケジュールの名前。
description string スケジュールの説明。
tags object スケジュールのタグの辞書。
trigger object ジョブをトリガーするタイミングのルールを定義するトリガー構成。 RecurrenceTrigger または CronTrigger のいずれかが必須です。
import_data オブジェクトまたは文字列 必須。 スケジュールによってトリガーされたインポート データ アクションの定義。 string または ImportDataDefinition のいずれかが必須です。

トリガーの構成

Recurrence トリガー

キー Type 説明 使用できる値
type string 必須。 スケジュールの種類を指定します。 recurrence
frequency string 必須。 スケジュールの起動間隔を表す時間の単位を指定します。 minute、 hour、 day、 week、 month
interval 整数 (integer) 必須。 スケジュールの起動間隔を指定します。
start_time string タイムゾーンと共に開始日時を記述します。 start_time を省略した場合、最初のジョブは即座に実行され、将来のジョブはスケジュールに基づいてトリガーされます。つまり、start_time はジョブの作成時刻に一致します。 開始時刻が過去の場合、最初のジョブは、計算された次の実行時に実行されます。
end_time string タイムゾーンと共に終了日時を記述します。 end_time を省略した場合、明示的に無効にされるまでスケジュールは実行されます。
timezone string 繰り返しのタイム ゾーンを指定します。 省略した場合、既定値は UTC になります。 タイムゾーン値の付録を参照
pattern object 繰り返しのパターンを指定します。 パターンを省略すると、start_time、frequency、interval のロジックに従ってジョブがトリガーされます。

繰り返しスケジュール

繰り返しスケジュールは、hours、minutes、weekdays などの繰り返しパターンを定義します。

  • 頻度が day の場合、パターンで hours と minutes を指定できます。
  • 頻度が week と month の場合、パターンで hours、minutes、weekdays を指定できます。
キー Type 使用できる値
hours 整数または整数の配列 0-23
minutes 整数または整数の配列 0-59
week_days 文字列または文字列の配列 monday、 tuesday、 wednesday、 thursday、 friday、 saturday、 sunday

CronTrigger

キー Type 説明 使用できる値
type string 必須。 スケジュールの種類を指定します。 cron
expression string 必須。 ジョブをトリガーする方法を定義する cron 式を指定します。 式では、標準の crontab 式を使用して繰り返しスケジュールを表します。 1 つの式は、スペースで区切られた 5 つのフィールドで構成されます: MINUTES HOURS DAYS MONTHS DAYS-OF-WEEK
start_time string タイムゾーンと共に開始日時を記述します。 start_time を省略した場合、最初のジョブは即座に実行され、将来のジョブはスケジュールに基づいてトリガーされます。つまり、start_time はジョブの作成時刻に一致します。 開始時刻が過去の場合、最初のジョブは、計算された次の実行時に実行されます。
end_time string タイムゾーンと共に終了日時を記述します。 end_time を省略した場合、明示的に無効にされるまでスケジュールは引き続き実行されます。
timezone string 繰り返しのタイム ゾーンを指定します。 省略した場合、既定値は UTC になります。 タイムゾーン値の付録を参照

インポート データの定義 (プレビュー)。

重要

現在、この機能はパブリック プレビュー段階にあります。 このプレビュー バージョンはサービス レベル アグリーメントなしで提供されており、運用環境のワークロードに使用することは推奨されません。 特定の機能はサポート対象ではなく、機能が制限されることがあります。

詳しくは、Microsoft Azure プレビューの追加使用条件に関するページをご覧ください。

お客様は、import_data: ./<data_import>.yaml を直接使用することも、次のプロパティを使用してデータのインポート定義を定義することもできます。

キー Type 説明 使用できる値
type string 必須。 データをインポートするデータ資産の種類を指定します。 データベース ソースからインポートする場合は mltable、FileSource からインポートする場合は uri_folder とすることができます。 mltable, uri_folder
name string 必須。 インポートされたデータを登録するデータ資産名。
path string 必須。 インポートされたデータを受け取るデータストアへのパス。次の 2 つの方法のいずれかで指定されます。

- 必須。 データストア パスの URI。 サポートされている URI の種類は azureml のみです。 azureml:// URI 形式の使用方法の詳細については、コア yaml 構文に関する記事を参照してください。 上書きを回避するため、インポートごとに一意のパスを使用することをお勧めします。 これを行うには、次の例に示すようにパスをパラメーター化します。- azureml://datastores/<datastore_name>/paths/<source_name>/${{name}} この例の "datastore_name" には、作成したデータストアを指定することも、workspaceblobstore にすることもできます。 または、azureml://datastores/workspacemanagedstore に示すように参照することで、"マネージド データストア" を選択できます。この場合、システムによって一意のパスが自動的に割り当てられます。		 Azure Machine Learning://<>
source object インポートされたデータ ソースの外部ソースの詳細。 ソース プロパティのセットについては、「source の属性」を参照してください。

source の属性 (プレビュー)

キー Type 説明 使用できる値 既定値
type string データのインポート元となる外部ソースの種類。 現時点では、次の種類のみが許可されています。Database、FileSystem Database, FileSystem
query string この値を定義するのは、上記で定義した type が database である場合のみです。インポートする必要があるデータを定義またはフィルター処理する型 Database の外部ソースのクエリ。
path string この値を定義するのは、上記で定義した type が FileSystem である場合のみです。インポートする必要があるファイルまたはデータが存在する型 FileSystem の外部ソース内のフォルダーのパス。
connection string 必須。 azureml:<connection_name> の形式で参照される外部ソースの接続プロパティ

重要

現在、この機能はパブリック プレビュー段階にあります。 このプレビュー バージョンはサービス レベル アグリーメントなしで提供されており、運用環境のワークロードに使用することは推奨されません。 特定の機能はサポート対象ではなく、機能が制限されることがあります。

詳しくは、Microsoft Azure プレビューの追加使用条件に関するページをご覧ください。

解説

az ml schedule コマンドは、Azure Machine Learning モデルを管理するために使用できます。

例

例は、GitHub リポジトリの例にあります。 次にいくつかを示します。

YAML: 繰り返しパターンがあるデータ インポートのスケジュール

適用対象: Azure CLI ml 拡張機能 v2 (現行)

YAML: 繰り返しパターンがあるデータ インポートのスケジュール (プレビュー)

$schema: https://azuremlschemas.azureedge.net/latest/schedule.schema.json
name: simple_recurrence_import_schedule
display_name: Simple recurrence import schedule
description: a simple hourly recurrence import schedule

trigger:
  type: recurrence
  frequency: day #can be minute, hour, day, week, month
  interval: 1 #every day
  schedule:
    hours: [4,5,10,11,12]
    minutes: [0,30]
  start_time: "2022-07-10T10:00:00" # optional - default will be schedule creation time
  time_zone: "Pacific Standard Time" # optional - default will be UTC

import_data: ./my-snowflake-import-data.yaml

YAML: マネージド データストアについての繰り返しパターンのあるデータ インポート定義インラインのスケジュール (プレビュー)

$schema: https://azuremlschemas.azureedge.net/latest/schedule.schema.json
name: inline_recurrence_import_schedule
display_name: Inline recurrence import schedule
description: an inline hourly recurrence import schedule

trigger:
  type: recurrence
  frequency: day #can be minute, hour, day, week, month
  interval: 1 #every day
  schedule:
    hours: [4,5,10,11,12]
    minutes: [0,30]
  start_time: "2022-07-10T10:00:00" # optional - default will be schedule creation time
  time_zone: "Pacific Standard Time" # optional - default will be UTC

import_data:
  type: mltable
  name: my_snowflake_ds
  path: azureml://datastores/workspacemanagedstore
  source:
    type: database
    query: select * from TPCH_SF1.REGION
    connection: azureml:my_snowflake_connection

YAML: cron 式を使用するデータインポートのスケジュール

適用対象: Azure CLI ml 拡張機能 v2 (現行)

YAML: cron 式を使用するデータインポートのスケジュール (プレビュー)

$schema: https://azuremlschemas.azureedge.net/latest/schedule.schema.json
name: simple_cron_import_schedule
display_name: Simple cron import schedule
description: a simple hourly cron import schedule

trigger:
  type: cron
  expression: "0 * * * *"
  start_time: "2022-07-10T10:00:00" # optional - default will be schedule creation time
  time_zone: "Pacific Standard Time" # optional - default will be UTC

import_data: ./my-snowflake-import-data.yaml

YAML: cron 式を使用するデータ インポート定義インラインスケジュール (プレビュー)

$schema: https://azuremlschemas.azureedge.net/latest/schedule.schema.json
name: inline_cron_import_schedule
display_name: Inline cron import schedule
description: an inline hourly cron import schedule

trigger:
  type: cron
  expression: "0 * * * *"
  start_time: "2022-07-10T10:00:00" # optional - default will be schedule creation time
  time_zone: "Pacific Standard Time" # optional - default will be UTC

import_data:
  type: mltable
  name: my_snowflake_ds
  path: azureml://datastores/workspaceblobstore/paths/snowflake/${{name}}
  source:
    type: database
    query: select * from TPCH_SF1.REGION
    connection: azureml:my_snowflake_connection

付録

タイム ゾーン

現在のスケジュールでは、次の表のタイムゾーンがサポートされています。 キーは Python SDK で直接使用できますが、値はデータ インポート YAML で使用できます。 テーブルは UTC (協定世界時) で並べ替えられています。

UTC キー 値
UTC -12:00 DATELINE_STANDARD_TIME "日付変更線 (標準時)"
UTC -11:00 UTC_11 "UTC-11"
UTC - 10:00 ALEUTIAN_STANDARD_TIME アリューシャン標準時
UTC - 10:00 HAWAIIAN_STANDARD_TIME "ハワイ標準時"
UTC -09:30 MARQUESAS_STANDARD_TIME "マルキーズ標準時"
UTC -09:00 ALASKAN_STANDARD_TIME "アラスカ標準時"
UTC -09:00 UTC_09 "UTC-09"
UTC -08:00 PACIFIC_STANDARD_TIME_MEXICO "太平洋標準時 (メキシコ)"
UTC -08:00 UTC_08 "UTC-08"
UTC -08:00 PACIFIC_STANDARD_TIME "太平洋標準時"
UTC -07:00 US_MOUNTAIN_STANDARD_TIME "米国山地標準時"
UTC -07:00 MOUNTAIN_STANDARD_TIME_MEXICO "山地標準時 (メキシコ)"
UTC -07:00 MOUNTAIN_STANDARD_TIME "山地標準時"
UTC -06:00 CENTRAL_AMERICA_STANDARD_TIME "中央アメリカ標準時"
UTC -06:00 CENTRAL_STANDARD_TIME "中部標準時"
UTC -06:00 EASTER_ISLAND_STANDARD_TIME "イースター島標準時"
UTC -06:00 CENTRAL_STANDARD_TIME_MEXICO "中部標準時 (メキシコ)"
UTC -06:00 CANADA_CENTRAL_STANDARD_TIME "カナダ中部標準時"
UTC -05:00 SA_PACIFIC_STANDARD_TIME "南アメリカ太平洋標準時"
UTC -05:00 EASTERN_STANDARD_TIME_MEXICO "東部標準時 (メキシコ)"
UTC -05:00 EASTERN_STANDARD_TIME "東部標準時"
UTC -05:00 HAITI_STANDARD_TIME "ハイチ標準時"
UTC -05:00 CUBA_STANDARD_TIME "キューバ標準時"
UTC -05:00 US_EASTERN_STANDARD_TIME "米国東部標準時"
UTC -05:00 TURKS_AND_CAICOS_STANDARD_TIME "タークス・カイコス諸島標準時"
UTC -04:00 PARAGUAY_STANDARD_TIME "パラグアイ標準時"
UTC -04:00 ATLANTIC_STANDARD_TIME "大西洋標準時"
UTC -04:00 VENEZUELA_STANDARD_TIME "ベネズエラ標準時"
UTC -04:00 CENTRAL_BRAZILIAN_STANDARD_TIME "中央ブラジル標準時"
UTC -04:00 SA_WESTERN_STANDARD_TIME "南アメリカ西部標準時"
UTC -04:00 PACIFIC_SA_STANDARD_TIME "太平洋南アメリカ標準時"
UTC -03:30 NEWFOUNDLAND_STANDARD_TIME "ニューファンドランド標準時"
UTC -03:00 TOCANTINS_STANDARD_TIME "トカンチンス標準時"
UTC -03:00 E_SOUTH_AMERICAN_STANDARD_TIME "E. "南アメリカ標準時"
UTC -03:00 SA_EASTERN_STANDARD_TIME "南アメリカ東部標準時"
UTC -03:00 ARGENTINA_STANDARD_TIME "アルゼンチン標準時"
UTC -03:00 GREENLAND_STANDARD_TIME "グリーンランド標準時"
UTC -03:00 MONTEVIDEO_STANDARD_TIME "モンテビデオ標準時"
UTC -03:00 SAINT_PIERRE_STANDARD_TIME "サンピエール標準時"
UTC -03:00 BAHIA_STANDARD_TIM "バイア標準時"
UTC -02:00 UTC_02 "UTC-02"
UTC -02:00 MID_ATLANTIC_STANDARD_TIME "中央大西洋標準時"
UTC -01:00 AZORES_STANDARD_TIME "アゾレス諸島標準時"
UTC -01:00 CAPE_VERDE_STANDARD_TIME "カーボベルデ標準時"
UTC UTC UTC
UTC +00:00 GMT_STANDARD_TIME "GMT 標準時"
UTC +00:00 GREENWICH_STANDARD_TIME "グリニッジ標準時"
UTC +01:00 MOROCCO_STANDARD_TIME "モロッコ標準時"
UTC +01:00 W_EUROPE_STANDARD_TIME "西 ヨーロッパ標準時"
UTC +01:00 CENTRAL_EUROPE_STANDARD_TIME "中央ヨーロッパ標準時"
UTC +01:00 ROMANCE_STANDARD_TIME "ロマンス標準時"
UTC +01:00 CENTRAL_EUROPEAN_STANDARD_TIME "中央ヨーロッパ標準時"
UTC +01:00 W_CENTRAL_AFRICA_STANDARD_TIME "西 中央アフリカ標準時"
UTC +02:00 NAMIBIA_STANDARD_TIME "ナミビア標準時"
UTC +02:00 JORDAN_STANDARD_TIME "ヨルダン標準時"
UTC +02:00 GTB_STANDARD_TIME "GTB 標準時"
UTC +02:00 MIDDLE_EAST_STANDARD_TIME "中東標準時"
UTC +02:00 EGYPT_STANDARD_TIME "エジプト標準時"
UTC +02:00 E_EUROPE_STANDARD_TIME "E. ヨーロッパ標準時"
UTC +02:00 SYRIA_STANDARD_TIME "シリア標準時"
UTC +02:00 WEST_BANK_STANDARD_TIME "西岸標準時"
UTC +02:00 SOUTH_AFRICA_STANDARD_TIME "南アフリカ標準時"
UTC +02:00 FLE_STANDARD_TIME "FLE 標準時"
UTC +02:00 ISRAEL_STANDARD_TIME "イスラエル標準時"
UTC +02:00 KALININGRAD_STANDARD_TIME "カリーニングラード標準時"
UTC +02:00 LIBYA_STANDARD_TIME "リビア標準時"
UTC +03:00 TÜRKIYE_STANDARD_TIME "トルコ標準時"
UTC +03:00 ARABIC_STANDARD_TIME "アラビック標準時"
UTC +03:00 ARAB_STANDARD_TIME "アラブ標準時"
UTC +03:00 BELARUS_STANDARD_TIME "ベラルーシ標準時"
UTC +03:00 RUSSIAN_STANDARD_TIME "ロシア標準時"
UTC +03:00 E_AFRICA_STANDARD_TIME "E. アフリカ標準時"
UTC +03:30 IRAN_STANDARD_TIME "イラン標準時"
UTC +04:00 ARABIAN_STANDARD_TIME "アラビア標準時"
UTC +04:00 ASTRAKHAN_STANDARD_TIME "アストラハン標準時"
UTC +04:00 AZERBAIJAN_STANDARD_TIME "アゼルバイジャン標準時"
UTC +04:00 RUSSIA_TIME_ZONE_3 "ロシア タイム ゾーン 3"
UTC +04:00 MAURITIUS_STANDARD_TIME "モーリシャス標準時"
UTC +04:00 GEORGIAN_STANDARD_TIME "ジョージア標準時"
UTC +04:00 CAUCASUS_STANDARD_TIME "コーカサス標準時"
UTC +04:30 AFGHANISTAN_STANDARD_TIME "アフガニスタン標準時"
UTC +05:00 WEST_ASIA_STANDARD_TIME "西アジア標準時"
UTC +05:00 EKATERINBURG_STANDARD_TIME "エカテリンブルク標準時"
UTC +05:00 PAKISTAN_STANDARD_TIME "パキスタン標準時"
UTC +05:30 INDIA_STANDARD_TIME "インド標準時"
UTC +05:30 SRI_LANKA_STANDARD_TIME "スリランカ標準時"
UTC +05:45 NEPAL_STANDARD_TIME "ネパール標準時"
UTC +06:00 CENTRAL_ASIA_STANDARD_TIME "中央アジア標準時"
UTC +06:00 BANGLADESH_STANDARD_TIME "バングラデシュ標準時"
UTC +06:30 MYANMAR_STANDARD_TIME "ミャンマー標準時"
UTC +07:00 N_CENTRAL_ASIA_STANDARD_TIME "北 中央アジア標準時"
UTC +07:00 SE_ASIA_STANDARD_TIME "東南アジア標準時"
UTC +07:00 ALTAI_STANDARD_TIME "アルタイ標準時"
UTC +07:00 W_MONGOLIA_STANDARD_TIME "西 モンゴル標準時"
UTC +07:00 NORTH_ASIA_STANDARD_TIME "北アジア標準時"
UTC +07:00 TOMSK_STANDARD_TIME "トムスク標準時"
UTC +08:00 CHINA_STANDARD_TIME "中国標準時"
UTC +08:00 NORTH_ASIA_EAST_STANDARD_TIME "北アジア東標準時"
UTC +08:00 SINGAPORE_STANDARD_TIME "シンガポール標準時"
UTC +08:00 W_AUSTRALIA_STANDARD_TIME "西 オーストラリア標準時"
UTC +08:00 TAIPEI_STANDARD_TIME "台北標準時"
UTC +08:00 ULAANBAATAR_STANDARD_TIME "ウランバートル標準時"
UTC +08:45 AUS_CENTRAL_W_STANDARD_TIME "オーストラリア中西部標準時"
UTC +09:00 NORTH_KOREA_STANDARD_TIME "北朝鮮標準時"
UTC +09:00 TRANSBAIKAL_STANDARD_TIME "ザバイカル標準時"
UTC +09:00 TOKYO_STANDARD_TIME "東京標準時"
UTC +09:00 KOREA_STANDARD_TIME "韓国標準時"
UTC +09:00 YAKUTSK_STANDARD_TIME "ヤクーツク標準時"
UTC +09:30 CEN_AUSTRALIA_STANDARD_TIME "中央 オーストラリア標準時"
UTC +09:30 AUS_CENTRAL_STANDARD_TIME "オーストラリア中央部標準時"
UTC +10:00 E_AUSTRALIAN_STANDARD_TIME "E. オーストラリア標準時"
UTC +10:00 AUS_EASTERN_STANDARD_TIME "オーストラリア東部標準時"
UTC +10:00 WEST_PACIFIC_STANDARD_TIME "西太平洋標準時"
UTC +10:00 TASMANIA_STANDARD_TIME "タスマニア標準時"
UTC +10:00 VLADIVOSTOK_STANDARD_TIME "ウラジオストク標準時"
UTC +10:30 LORD_HOWE_STANDARD_TIME "ロードハウ標準時"
UTC +11:00 BOUGAINVILLE_STANDARD_TIME "ブーゲンビル標準時"
UTC +11:00 RUSSIA_TIME_ZONE_10 "ロシア タイム ゾーン 10"
UTC +11:00 MAGADAN_STANDARD_TIME "マガダン標準時"
UTC +11:00 NORFOLK_STANDARD_TIME "ノーフォーク標準時"
UTC +11:00 SAKHALIN_STANDARD_TIME "サハリン標準時"
UTC +11:00 CENTRAL_PACIFIC_STANDARD_TIME "中央太平洋標準時"
UTC +12:00 RUSSIA_TIME_ZONE_11 "ロシア タイム ゾーン 11"
UTC +12:00 NEW_ZEALAND_STANDARD_TIME "ニュージーランド標準時"
UTC +12:00 UTC_12 "UTC+12"
UTC +12:00 FIJI_STANDARD_TIME "フィジー標準時"
UTC +12:00 KAMCHATKA_STANDARD_TIME "カムチャツカ標準時"
UTC +12:45 CHATHAM_ISLANDS_STANDARD_TIME "チャタム諸島標準時"
UTC +13:00 TONGA__STANDARD_TIME "トンガ標準時"
UTC +13:00 SAMOA_STANDARD_TIME "サモア標準時"
UTC +14:00 LINE_ISLANDS_STANDARD_TIME "ライン諸島標準時"