az datashare consumer share-subscription synchronization

Commands for consumers to manage datashare share subscription synchronizations.

Commands

az datashare consumer share-subscription synchronization cancel

Request to cancel a synchronization.

az datashare consumer share-subscription synchronization list

List synchronizations of a share subscription.

az datashare consumer share-subscription synchronization list-detail

List synchronization details.

az datashare consumer share-subscription synchronization start

Initiate a dataset synchronization.

az datashare consumer share-subscription synchronization wait

Place the CLI in a waiting state until a condition of the datashare share subscription synchronization is met.

az datashare consumer share-subscription synchronization cancel

Request to cancel a synchronization.

az datashare consumer share-subscription synchronization cancel --account-name
                                                                --resource-group
                                                                --share-subscription-name
                                                                --synchronization-id
                                                                [--no-wait]

Examples

Request to cancel a synchronization

az datashare consumer share-subscription synchronization cancel --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --synchronization-id 00000000-0000-0000-0000-000000000000

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.

--synchronization-id

The synchronization GUID.

Optional Parameters

--no-wait

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

az datashare consumer share-subscription synchronization list

List synchronizations of a share subscription.

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

Examples

List synchronizations

az datashare consumer share-subscription synchronization list --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSub

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 share-subscription synchronization list-detail

List synchronization details.

az datashare consumer share-subscription synchronization list-detail --account-name
                                                                     --resource-group
                                                                     --share-subscription-name
                                                                     --synchronization-id

Examples

List synchronization details

az datashare consumer share-subscription synchronization list-detail --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSub --synchronization-id 00000000-0000-0000-0000-000000000000

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.

--synchronization-id

Synchronization id.

az datashare consumer share-subscription synchronization start

Initiate a dataset synchronization.

az datashare consumer share-subscription synchronization start --account-name
                                                               --resource-group
                                                               --share-subscription-name
                                                               [--no-wait]
                                                               [--synchronization-mode {FullSync, Incremental}]

Examples

Initiate a dataset synchronization

az datashare consumer share-subscription synchronization start --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --synchronization-mode "Incremental"

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

--no-wait

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

--synchronization-mode

Synchronization mode.

accepted values: FullSync, Incremental

az datashare consumer share-subscription synchronization wait

Place the CLI in a waiting state until a condition of the datashare share subscription synchronization is met.

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

Examples

Pause executing next line of CLI script until the datashare share subscription synchronization finishes successfully.

az datashare consumer share-subscription synchronization wait --custom "status=='Succeeded'" --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --synchronization-id 00000000-0000-0000-0000-000000000000

Pause executing next line of CLI script until the datashare share subscription synchronization is cancelled.

az datashare consumer share-subscription synchronization wait --custom "status=='Cancelled'" --account-name MyAccount --resource-group MyResourceGroup --share-subscription-name MyShareSubscription --synchronization-id 00000000-0000-0000-0000-000000000000

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.

--synchronization-id

The synchronization GUID.

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