az datashare consumer trigger

Commands for consumers to manage datashare consumer triggers.

Commands

az datashare consumer trigger create

Create a trigger.

az datashare consumer trigger delete

Delete a trigger in a share subscription.

az datashare consumer trigger list

List triggers in a share subscription.

az datashare consumer trigger show

Show a trigger in a share subscription.

az datashare consumer trigger wait

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

az datashare consumer trigger create

Create a trigger.

az datashare consumer trigger create --account-name
                                     --name
                                     --recurrence-interval {Day, Hour}
                                     --resource-group
                                     --share-subscription-name
                                     --synchronization-time
                                     [--kind {ScheduleBased}]
                                     [--no-wait]

Examples

Create a trigger

az datashare consumer trigger create --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --name MyTrigger --recurrence-interval Day --synchronization-time "2020-04-05 10:50:00 +00:00" --kind ScheduleBased

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the trigger.

--recurrence-interval

Synchronization Recurrence Interval.

accepted values: Day, Hour
--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.

--synchronization-time

Synchronization time. Format: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) timezone (+/-hh:mm).

Optional Parameters

--kind

Kind of synchronization.

accepted values: ScheduleBased
default value: ScheduleBased
--no-wait

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

az datashare consumer trigger delete

Delete a trigger in a share subscription.

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

Examples

Delete a trigger

az datashare consumer trigger delete --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --name MyTrigger

Required Parameters

--account-name

The name of the share account.

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

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

az datashare consumer trigger list

List triggers in a share subscription.

az datashare consumer trigger list --account-name
                                   --resource-group
                                   --share-subscription-name

Examples

List triggers

az datashare consumer trigger list --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription

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.

az datashare consumer trigger show

Show a trigger in a share subscription.

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

Examples

Show a trigger

az datashare consumer trigger show --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --name MyTrigger

Required Parameters

--account-name

The name of the share account.

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

az datashare consumer trigger wait

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

az datashare consumer 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 provisioned.

az datashare consumer trigger wait --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --name MyTrigger --created

Required Parameters

--account-name

The name of the share account.

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