Share via

az synapse trigger-run

  • Reference

Synapse trigger-run.

Commands

Name Description Type Status
az synapse trigger-run cancel

Cancel a single trigger instance by runId.

 Core GA
az synapse trigger-run query-by-workspace

Query trigger runs in the workspace based on input filter conditions.

 Core GA
az synapse trigger-run rerun

Rerun single trigger instance by runId.

 Core GA

az synapse trigger-run cancel

Edit

Cancel a single trigger instance by runId.

az synapse trigger-run cancel --name
                              --run-id
                              --workspace-name

Examples

Cancel a single trigger instance by runId.

az synapse trigger-run cancel --workspace-name testsynapseworkspace \
  --name testtrigger --run-id 08586024068106001417583731803CU31

Required Parameters

--name -n

The trigger name.

--run-id

The trigger run identifier.

--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-run query-by-workspace

Edit

Query trigger runs in the workspace based on input filter conditions.

az synapse trigger-run query-by-workspace --last-updated-after
                                          --last-updated-before
                                          --workspace-name
                                          [--continuation-token]
                                          [--filters]
                                          [--order-by]

Examples

Query trigger runs in the workspace based on input filter conditions.

az synapse trigger-run query-by-workspace --workspace-name testsynapseworkspace --filters \
  operand="TriggerName" operator="Equals" values="testtrigger" --last-updated-after "2020-09-03T00:36:44.3345758Z" \
  --last-updated-before "2020-09-03T00:49:48.3686473Z"

Required Parameters

--last-updated-after

The time at or after which the run event was updated in 'ISO 8601' format.

--last-updated-before

The time at or before which the run event was updated in 'ISO 8601' format.

--workspace-name

The workspace name.

Optional Parameters

--continuation-token

The continuation token for getting the next page of results. Null for first page.

--filters

List of filters.

--order-by

List of OrderBy option.

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-run rerun

Edit

Rerun single trigger instance by runId.

az synapse trigger-run rerun --name
                             --run-id
                             --workspace-name

Examples

Rerun single trigger instance by runId.

az synapse trigger-run rerun --workspace-name testsynapseworkspace \
  --name testtrigger --run-id 08586024068106001417583731803CU31

Required Parameters

--name -n

The trigger name.

--run-id

The trigger run identifier.

--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.