az datashare trigger

Note

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

Manage trigger with datashare.

Commands

az datashare trigger create	Create a Trigger.
az datashare trigger delete	Delete a Trigger in a shareSubscription.
az datashare trigger list	List Triggers in a share subscription.
az datashare trigger show	Get a Trigger in a shareSubscription.
az datashare trigger wait	Place the CLI in a waiting state until a condition of the datashare trigger is met.

az datashare trigger create

Create a Trigger.

az datashare trigger create --account-name
                            --name
                            --resource-group
                            --share-subscription-name
                            [--no-wait]
                            [--scheduled-trigger]

Examples

Triggers_Create

az datashare trigger create --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1" --scheduled-trigger recurrence-interval="Day" synchronization-mode="Incremental" synchronization-time="2018-11-14T04:47:52.9614956Z" --name "Trigger1"

Required Parameters

--account-name

The name of the share account.

--name --trigger-name -n

The name of the trigger.

--resource-group -g

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

--share-subscription-name

The name of the share subscription which will hold the data set sink.

Optional Parameters

--no-wait

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

--scheduled-trigger

A type of trigger based on schedule.

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.

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

Delete a Trigger in a shareSubscription.

az datashare trigger delete --account-name
                            --name
                            --resource-group
                            --share-subscription-name
                            [--no-wait]
                            [--yes]

Examples

Triggers_Delete

az datashare trigger delete --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1" --name "Trigger1"

Required Parameters

--account-name

The name of the share account.

--name --trigger-name -n

The name of the trigger.

--resource-group -g

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

--share-subscription-name

The name of the shareSubscription.

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

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.

--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 datashare trigger list

List Triggers in a share subscription.

az datashare trigger list --account-name
                          --resource-group
                          --share-subscription-name
                          [--skip-token]

Examples

Triggers_ListByShareSubscription

az datashare trigger list --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1"

Required Parameters

--account-name

The name of the share account.

--resource-group -g

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

--share-subscription-name

The name of the share subscription.

Optional Parameters

--skip-token

Continuation token.

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.

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

Get a Trigger in a shareSubscription.

az datashare trigger show --account-name
                          --name
                          --resource-group
                          --share-subscription-name

Examples

Triggers_Get

az datashare trigger show --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1" --name "Trigger1"

Required Parameters

--account-name

The name of the share account.

--name --trigger-name -n

The name of the trigger.

--resource-group -g

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

--share-subscription-name

The name of the shareSubscription.

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.

--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 datashare trigger wait

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

az datashare trigger wait --account-name
                          --name
                          --resource-group
                          --share-subscription-name
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--timeout]
                          [--updated]

Examples

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

az datashare trigger wait --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1" --name "Trigger1" --created

Pause executing next line of CLI script until the datashare trigger is successfully deleted.

az datashare trigger wait --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1" --name "Trigger1" --deleted

Required Parameters

--account-name

The name of the share account.

--name --trigger-name -n

The name of the trigger.

--resource-group -g

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

--share-subscription-name

The name of the shareSubscription.

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.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

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