Share via

az datashare trigger

  • Experimental
  • Reference

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.

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage trigger with datashare.

Commands

Name Description Type Status
az datashare trigger create

Create a Trigger.

 Extension Experimental
az datashare trigger delete

Delete a Trigger in a shareSubscription.

 Extension Experimental
az datashare trigger list

List Triggers in a share subscription.

 Extension Experimental
az datashare trigger show

Get a Trigger in a shareSubscription.

 Extension Experimental
az datashare trigger wait

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

 Extension Experimental

az datashare trigger create

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

Default value: False
--scheduled-trigger

A type of trigger based on schedule.

Usage: --scheduled-trigger recurrence-interval=XX synchronization-mode=XX synchronization-time=XX kind=XX

recurrence-interval: Required. Recurrence Interval synchronization-mode: Synchronization mode synchronization-time: Required. Synchronization time kind: Required. Kind of synchronization on trigger.

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

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Trigger in a shareSubscription.

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

Examples

Triggers_Delete

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

Optional Parameters

--account-name

The name of the share account.

--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 name of the trigger.

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

--share-subscription-name

The name of the shareSubscription.

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

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

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

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Trigger in a shareSubscription.

az datashare trigger show [--account-name]
                          [--ids]
                          [--name]
                          [--resource-group]
                          [--share-subscription-name]
                          [--subscription]

Examples

Triggers_Get

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

Optional Parameters

--account-name

The name of the share account.

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

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

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az datashare trigger wait [--account-name]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--name]
                          [--resource-group]
                          [--share-subscription-name]
                          [--subscription]
                          [--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

Optional Parameters

--account-name

The name of the share account.

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

--interval

Polling interval in seconds.

Default value: 30
--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.

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