az datashare synchronization-setting

Commands for providers to manage datashare synchronization settings.

Commands

az datashare synchronization-setting create

Create a synchronization setting.

az datashare synchronization-setting delete

Delete a synchronization setting in a share.

az datashare synchronization-setting list

List synchronization settings in a share.

az datashare synchronization-setting show

Show a synchronization setting in a share.

az datashare synchronization-setting wait

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

az datashare synchronization-setting create

Create a synchronization setting.

az datashare synchronization-setting create --account-name
                                            --name
                                            --recurrence-interval {Day, Hour}
                                            --resource-group
                                            --share-name
                                            --synchronization-time
                                            [--kind {ScheduleBased}]

Examples

Create a synchronization setting

az datashare synchronization-setting create --account-name MyAccount --resource-group MyResourceGroup --share-name MyShare --name MyDataset --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 synchronizationSetting.

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

The name of the share.

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

az datashare synchronization-setting delete

Delete a synchronization setting in a share.

az datashare synchronization-setting delete --account-name
                                            --name
                                            --resource-group
                                            --share-name
                                            [--no-wait]
                                            [--yes]

Examples

Delete a synchronization setting

az datashare synchronization-setting delete --account-name MyAccount --resource-group MyResourceGroup --share-name MyShare --name MySyncrhonizationSetting

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the synchronizationSetting.

--resource-group -g

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

--share-name

The name of the share.

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

az datashare synchronization-setting list

List synchronization settings in a share.

az datashare synchronization-setting list --account-name
                                          --resource-group
                                          --share-name

Examples

List synchronization settings

az datashare synchronization-setting list --account-name MyAccount --resource-group MyResourceGroup --share-name MyShare

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

The name of the share.

az datashare synchronization-setting show

Show a synchronization setting in a share.

az datashare synchronization-setting show --account-name
                                          --name
                                          --resource-group
                                          --share-name

Examples

Show a synchronization setting

az datashare synchronization-setting show --account-name MyAccount --resource-group MyResourceGroup --share-name MyShare --name MySyncrhonizationSetting

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the synchronizationSetting.

--resource-group -g

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

--share-name

The name of the share.

az datashare synchronization-setting wait

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

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

Examples

Pause executing next line of CLI script until the datashare synchronization setting is successfully provisioned.

az datashare synchronization-setting wait --account-name MyAccount --resource-group MyResourceGroup --share-name MyShare --name MySyncrhonizationSetting --created

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the synchronizationSetting.

--resource-group -g

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

--share-name

The name of the share.

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