Share via

az synapse trigger

  • Reference

Manage Synapse's triggers.

Commands

Name Description Type Status
az synapse trigger create

Create a trigger.

 Core GA
az synapse trigger delete

Delete a trigger.

 Core GA
az synapse trigger get-event-subscription-status

Get a trigger's event subscription status.

 Core GA
az synapse trigger list

List triggers.

 Core GA
az synapse trigger set

Update an exist trigger.

 Core Deprecated
az synapse trigger show

Get a trigger.

 Core GA
az synapse trigger start

Starts a trigger.

 Core GA
az synapse trigger stop

Stops a trigger.

 Core GA
az synapse trigger subscribe-to-event

Subscribe event trigger to events.

 Core GA
az synapse trigger unsubscribe-from-event

Unsubscribe event trigger from events.

 Core GA
az synapse trigger update

Update an exist trigger.

 Core GA
az synapse trigger wait

Place the CLI in a waiting state until a condition of a trigger is met.

 Core GA

az synapse trigger create

Edit

Create a trigger.

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

Examples

Create a trigger. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

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

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger delete

Edit

Delete a trigger.

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

Examples

Delete a trigger.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger get-event-subscription-status

Edit

Get a trigger's event subscription status.

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

Examples

Get a trigger's event subscription status.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger list

Edit

List triggers.

az synapse trigger list --workspace-name

Examples

List triggers.

az synapse trigger list --workspace-name testsynapseworkspace

Required Parameters

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger set

Edit
Deprecated

This command has been deprecated and will be removed in a future release. Use 'update' instead.

Update an exist trigger.

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

Examples

Update an exist trigger. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

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

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger show

Edit

Get a trigger.

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

Examples

Get a trigger.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger start

Edit

Starts a trigger.

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

Examples

Starts a trigger.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger stop

Edit

Stops a trigger.

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

Examples

Stops a trigger.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger subscribe-to-event

Edit

Subscribe event trigger to events.

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

Examples

Subscribe event trigger to events.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger unsubscribe-from-event

Edit

Unsubscribe event trigger from events.

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

Examples

Unsubscribe event trigger from events.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger update

Edit

Update an exist trigger.

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

Examples

Update an exist trigger. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

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

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse trigger wait

Edit

Place the CLI in a waiting state until a condition of a trigger is met.

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

Required Parameters

--name -n

The trigger name.

--workspace-name

The workspace name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.