az datafactory trigger

Datafactory trigger.

Commands

az datafactory trigger create

Creates or updates a trigger.

az datafactory trigger delete

Deletes a trigger.

az datafactory trigger get-event-subscription-status

Get a trigger's event subscription status.

az datafactory trigger list

Lists triggers.

az datafactory trigger query-by-factory

Query triggers.

az datafactory trigger show

Gets a trigger.

az datafactory trigger start

Starts a trigger.

az datafactory trigger stop

Stops a trigger.

az datafactory trigger subscribe-to-event

Subscribe event trigger to events.

az datafactory trigger unsubscribe-from-event

Unsubscribe event trigger from events.

az datafactory trigger wait

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

az datafactory trigger create

Creates or updates a trigger.

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

Examples

Triggers_Create

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

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--properties

Properties of the trigger. Expected value: json-string/@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.

az datafactory trigger delete

Deletes a trigger.

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

Examples

Triggers_Delete

az datafactory trigger delete --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

az datafactory trigger get-event-subscription-status

Get a trigger's event subscription status.

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

Examples

Triggers_GetEventSubscriptionStatus

az datafactory trigger get-event-subscription-status --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

az datafactory trigger list

Lists triggers.

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

Examples

Triggers_ListByFactory

az datafactory trigger list --factory-name "myFactoryName" --resource-group "myResourceGroup"

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

az datafactory trigger query-by-factory

Query triggers.

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

Examples

Triggers_QueryByFactory

az datafactory trigger query-by-factory --factory-name "myFactoryName" --parent-trigger-name "myTrigger" --resource-group "myResourceGroup"

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

Optional Parameters

--continuation-token

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

--parent-trigger-name

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

az datafactory trigger show

Gets a trigger.

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

Examples

Triggers_Get

az datafactory trigger show --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

Optional Parameters

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

az datafactory trigger start

Starts a trigger.

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

Examples

Triggers_Start

az datafactory trigger start --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

Optional Parameters

--no-wait

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

az datafactory trigger stop

Stops a trigger.

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

Examples

Triggers_Stop

az datafactory trigger stop --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

Optional Parameters

--no-wait

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

az datafactory trigger subscribe-to-event

Subscribe event trigger to events.

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

Examples

Triggers_SubscribeToEvents

az datafactory trigger subscribe-to-event --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

Optional Parameters

--no-wait

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

az datafactory trigger unsubscribe-from-event

Unsubscribe event trigger from events.

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

Examples

Triggers_UnsubscribeFromEvents

az datafactory trigger unsubscribe-from-event --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger"

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

Optional Parameters

--no-wait

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

az datafactory trigger wait

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

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

Examples

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

az datafactory trigger wait --factory-name "myFactoryName" --resource-group "myResourceGroup" --name "myTrigger" --created

Required Parameters

--factory-name

The factory name.

--name -n

The trigger name.

--resource-group -g

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.