az synapse trigger

Synapse のトリガーを管理します。

コマンド

名前	説明	型	Status
az synapse trigger create	トリガーを作成します。	コア	GA
az synapse trigger delete	トリガーを削除します。	コア	GA
az synapse trigger get-event-subscription-status	トリガーのイベント サブスクリプションの状態を取得します。	コア	GA
az synapse trigger list	トリガーを一覧表示します。	コア	GA
az synapse trigger set	存在するトリガーを更新します。	コア	非推奨
az synapse trigger show	トリガーを取得します。	コア	GA
az synapse trigger start	トリガーを開始します。	コア	GA
az synapse trigger stop	トリガーを停止します。	コア	GA
az synapse trigger subscribe-to-event	イベント トリガーをイベントにサブスクライブします。	コア	GA
az synapse trigger unsubscribe-from-event	イベントトリガーをイベントからサブスクライブ解除します。	コア	GA
az synapse trigger update	存在するトリガーを更新します。	コア	GA
az synapse trigger wait	トリガーの条件が満たされるまで、CLI を待機状態にします。	コア	GA

az synapse trigger create

トリガーを作成します。

az synapse trigger create --file
                          --name
                          --workspace-name
                          [--no-wait]

例

トリガーを作成します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

az synapse trigger create --workspace-name testsynapseworkspace \
  --name testtrigger --file @"path/trigger.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger delete

トリガーを削除します。

az synapse trigger delete --name
                          --workspace-name
                          [--no-wait]
                          [--yes]

例

トリガーを削除します。

az synapse trigger delete --workspace-name testsynapseworkspace \
  --name testtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger get-event-subscription-status

トリガーのイベント サブスクリプションの状態を取得します。

az synapse trigger get-event-subscription-status --name
                                                 --workspace-name

例

トリガーのイベント サブスクリプションの状態を取得します。

az synapse trigger get-event-subscription-status --workspace-name testsynapseworkspace \
  --name eventtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger list

トリガーを一覧表示します。

az synapse trigger list --workspace-name

例

トリガーを一覧表示します。

az synapse trigger list --workspace-name testsynapseworkspace

必須のパラメーター

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger set

非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'update' を使用してください。

存在するトリガーを更新します。

az synapse trigger set --file
                       --name
                       --workspace-name
                       [--no-wait]

例

存在するトリガーを更新します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

az synapse trigger set --workspace-name testsynapseworkspace \
  --name testtrigger --file @"path/trigger.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger show

トリガーを取得します。

az synapse trigger show --name
                        --workspace-name

例

トリガーを取得します。

az synapse trigger show --workspace-name testsynapseworkspace \
  --name testtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger start

トリガーを開始します。

az synapse trigger start --name
                         --workspace-name
                         [--no-wait]

例

トリガーを開始します。

az synapse trigger start --workspace-name testsynapseworkspace \
  --name testtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger stop

トリガーを停止します。

az synapse trigger stop --name
                        --workspace-name
                        [--no-wait]

例

トリガーを停止します。

az synapse trigger stop --workspace-name testsynapseworkspace \
  --name testtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger subscribe-to-event

イベント トリガーをイベントにサブスクライブします。

az synapse trigger subscribe-to-event --name
                                      --workspace-name
                                      [--no-wait]

例

イベント トリガーをイベントにサブスクライブします。

az synapse trigger subscribe-to-event --workspace-name testsynapseworkspace \
  --name eventtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger unsubscribe-from-event

イベントトリガーをイベントからサブスクライブ解除します。

az synapse trigger unsubscribe-from-event --name
                                          --workspace-name
                                          [--no-wait]

例

イベントトリガーをイベントからサブスクライブ解除します。

az synapse trigger unsubscribe-from-event --workspace-name testsynapseworkspace \
  --name eventtrigger

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger update

存在するトリガーを更新します。

az synapse trigger update --file
                          --name
                          --workspace-name
                          [--no-wait]

例

存在するトリガーを更新します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

az synapse trigger update --workspace-name testsynapseworkspace \
  --name testtrigger --file @"path/trigger.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse trigger wait

トリガーの条件が満たされるまで、CLI を待機状態にします。

az synapse trigger wait --name
                        --workspace-name
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

必須のパラメーター

--name -n

トリガー名

--workspace-name

ワークスペース名。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。