Share via

az datafactory trigger

Note

This reference is part of the datafactory extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az datafactory trigger command. Learn more about extensions.

Manage trigger with datafactory.

Commands

Name Description Type Status
az datafactory trigger create

Create a trigger.

 Extension GA
az datafactory trigger delete

Deletes a trigger.

 Extension GA
az datafactory trigger get-event-subscription-status

Get a trigger's event subscription status.

 Extension GA
az datafactory trigger list

Lists triggers.

 Extension GA
az datafactory trigger query-by-factory

Query triggers.

 Extension GA
az datafactory trigger show

Gets a trigger.

 Extension GA
az datafactory trigger start

Starts a trigger.

 Extension GA
az datafactory trigger stop

Stops a trigger.

 Extension GA
az datafactory trigger subscribe-to-event

Subscribe event trigger to events.

 Extension GA
az datafactory trigger unsubscribe-from-event

Unsubscribe event trigger from events.

 Extension GA
az datafactory trigger update

Update a trigger.

 Extension GA
az datafactory trigger wait

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

 Extension GA

az datafactory trigger create

Create a trigger.

az datafactory trigger create --factory-name
                              --name --trigger-name
                              --properties
                              --resource-group
                              [--if-match]

Examples

Triggers_Create

az datafactory trigger create --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --properties "{\"type\":\"ScheduleTrigger\",\"pipelines\":[{\"parameters\":{\"OutputBlobNameList\":[\"exampleoutput.csv\"]},\"pipelineReference\":{\"type\":\"PipelineReference\",\"referenceName\":\"examplePipeline\"}}],\"typeProperties\":{\"recurrence\":{\"endTime\":\"2018-06-16T00:55:13.8441801Z\",\"frequency\":\"Minute\",\"interval\":4,\"startTime\":\"2018-06-16T00:39:13.8441801Z\",\"timeZone\":\"UTC\"}}}" --name "exampleTrigger"

Required Parameters

--factory-name

The factory name.

--name --trigger-name -n

The trigger name.

--properties

Properties of the trigger. Expected value: json-string/json-file/@json-file.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az datafactory trigger delete

Deletes a trigger.

az datafactory trigger delete [--factory-name]
                              [--ids]
                              [--name --trigger-name]
                              [--resource-group]
                              [--subscription]
                              [--yes]

Examples

Triggers_Delete

az datafactory trigger delete --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger get-event-subscription-status

Get a trigger's event subscription status.

az datafactory trigger get-event-subscription-status [--factory-name]
                                                     [--ids]
                                                     [--name --trigger-name]
                                                     [--resource-group]
                                                     [--subscription]

Examples

Triggers_GetEventSubscriptionStatus

az datafactory trigger get-event-subscription-status --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger list

Lists triggers.

az datafactory trigger list --factory-name
                            --resource-group

Examples

Triggers_ListByFactory

az datafactory trigger list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az datafactory trigger query-by-factory

Query triggers.

az datafactory trigger query-by-factory [--continuation-token]
                                        [--factory-name]
                                        [--ids]
                                        [--parent-trigger-name]
                                        [--resource-group]
                                        [--subscription]

Examples

Triggers_QueryByFactory

az datafactory trigger query-by-factory --factory-name "exampleFactoryName" --parent-trigger-name "exampleTrigger" --resource-group "exampleResourceGroup"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--continuation-token

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

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--parent-trigger-name

The name of the parent TumblingWindowTrigger to get the child rerun triggers.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger show

Gets a trigger.

az datafactory trigger show [--factory-name]
                            [--ids]
                            [--if-none-match]
                            [--name --trigger-name]
                            [--resource-group]
                            [--subscription]

Examples

Triggers_Get

az datafactory trigger show --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--if-none-match

ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger start

Starts a trigger.

az datafactory trigger start [--factory-name]
                             [--ids]
                             [--name --trigger-name]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]

Examples

Triggers_Start

az datafactory trigger start --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger stop

Stops a trigger.

az datafactory trigger stop [--factory-name]
                            [--ids]
                            [--name --trigger-name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]

Examples

Triggers_Stop

az datafactory trigger stop --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger subscribe-to-event

Subscribe event trigger to events.

az datafactory trigger subscribe-to-event [--factory-name]
                                          [--ids]
                                          [--name --trigger-name]
                                          [--no-wait]
                                          [--resource-group]
                                          [--subscription]

Examples

Triggers_SubscribeToEvents

az datafactory trigger subscribe-to-event --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger unsubscribe-from-event

Unsubscribe event trigger from events.

az datafactory trigger unsubscribe-from-event [--factory-name]
                                              [--ids]
                                              [--name --trigger-name]
                                              [--no-wait]
                                              [--resource-group]
                                              [--subscription]

Examples

Triggers_UnsubscribeFromEvents

az datafactory trigger unsubscribe-from-event --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger update

Update a trigger.

az datafactory trigger update [--add]
                              [--annotations]
                              [--description]
                              [--factory-name]
                              [--force-string]
                              [--ids]
                              [--if-match]
                              [--if-none-match]
                              [--name --trigger-name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--annotations

List of tags that can be used for describing the trigger. Expected value: json-string/json-file/@json-file.

--description

Trigger description.

--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--if-match

ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

--if-none-match

ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az datafactory trigger wait

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

az datafactory trigger wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--factory-name]
                            [--ids]
                            [--if-none-match]
                            [--interval]
                            [--name --trigger-name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Examples

Pause executing next line of CLI script until the datafactory trigger is successfully created.

az datafactory trigger wait --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --name "exampleTrigger" --created

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--factory-name

The factory name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--if-none-match

ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --trigger-name -n

The trigger name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False