Κοινή χρήση μέσω

az datafactory trigger

  • Reference

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

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

--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 datafactory trigger delete

Deletes a trigger.

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

Examples

Triggers_Delete

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

Optional Parameters

--factory-name

The factory name.

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

--name --trigger-name -n

The trigger name.

--resource-group -g

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

--subscription

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

--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 datafactory trigger get-event-subscription-status

Get a trigger's event subscription status.

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

Examples

Triggers_GetEventSubscriptionStatus

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

Optional Parameters

--factory-name

The factory name.

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

--name --trigger-name -n

The trigger name.

--resource-group -g

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

--subscription

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

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

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

--continuation-token

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

--factory-name

The factory name.

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

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

--subscription

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

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 datafactory trigger show

Gets a trigger.

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

Examples

Triggers_Get

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

Optional Parameters

--factory-name

The factory name.

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

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

--resource-group -g

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

--subscription

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

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 datafactory trigger start

Starts a trigger.

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

Examples

Triggers_Start

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

Optional Parameters

--factory-name

The factory name.

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

--name --trigger-name -n

The trigger name.

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

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 datafactory trigger stop

Stops a trigger.

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

Examples

Triggers_Stop

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

Optional Parameters

--factory-name

The factory name.

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

--name --trigger-name -n

The trigger name.

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

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 datafactory trigger subscribe-to-event

Subscribe event trigger to events.

az datafactory trigger subscribe-to-event [--factory-name]
                                          [--ids]
                                          [--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

--factory-name

The factory name.

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

--name --trigger-name -n

The trigger name.

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

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 datafactory trigger unsubscribe-from-event

Unsubscribe event trigger from events.

az datafactory trigger unsubscribe-from-event [--factory-name]
                                              [--ids]
                                              [--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

--factory-name

The factory name.

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

--name --trigger-name -n

The trigger name.

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

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 datafactory trigger update

Update a trigger.

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

Optional Parameters

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

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.

--force-string

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

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.

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

--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
--subscription

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

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 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]
                            [--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

--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
--factory-name

The factory name.

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

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

Default value: 30
--name --trigger-name -n

The trigger name.

--resource-group -g

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

--subscription

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

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