Share via

az datashare synchronization-setting

  • 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 synchronization-setting command. Learn more about extensions.

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

Manage synchronization setting with datashare.

Commands

Name Description Type Status
az datashare synchronization-setting create

Create a synchronizationSetting.

 Extension Experimental
az datashare synchronization-setting delete

Delete a synchronizationSetting in a share.

 Extension Experimental
az datashare synchronization-setting list

List synchronizationSettings in a share.

 Extension Experimental
az datashare synchronization-setting show

Get a synchronizationSetting in a share.

 Extension Experimental
az datashare synchronization-setting wait

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

 Extension Experimental

az datashare synchronization-setting create

Experimental

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

Create a synchronizationSetting.

az datashare synchronization-setting create --account-name
                                            --name
                                            --resource-group
                                            --share-name
                                            [--scheduled-synchronization-setting]

Examples

SynchronizationSettings_Create

az datashare synchronization-setting create --account-name "Account1" --resource-group "SampleResourceGroup" --share-name "Share1" --scheduled-synchronization-setting recurrence-interval="Day" synchronization-time="2018-11-14T04:47:52.9614956Z" --name "Dataset1"

Required Parameters

--account-name

The name of the share account.

--name --synchronization-setting-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 to add the synchronization setting to.

Optional Parameters

--scheduled-synchronization-setting

A type of synchronization setting based on schedule.

Usage: --scheduled-synchronization-setting recurrence-interval=XX synchronization-time=XX kind=XX

recurrence-interval: Required. Recurrence Interval synchronization-time: Required. Synchronization time kind: Required. Kind of synchronization setting.

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 synchronization-setting delete

Experimental

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

Delete a synchronizationSetting in a share.

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

Examples

SynchronizationSettings_Delete

az datashare synchronization-setting delete --account-name "Account1" --resource-group "SampleResourceGroup" --share-name "Share1" --name "SynchronizationSetting1"

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 --synchronization-setting-name -n

The name of the synchronizationSetting .

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

The name of the share.

--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 synchronization-setting list

Experimental

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

List synchronizationSettings in a share.

az datashare synchronization-setting list --account-name
                                          --resource-group
                                          --share-name
                                          [--skip-token]

Examples

SynchronizationSettings_ListByShare

az datashare synchronization-setting list --account-name "Account1" --resource-group "SampleResourceGroup" --share-name "Share1"

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.

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 synchronization-setting show

Experimental

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

Get a synchronizationSetting in a share.

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

Examples

SynchronizationSettings_Get

az datashare synchronization-setting show --account-name "Account1" --resource-group "SampleResourceGroup" --share-name "Share1" --name "SynchronizationSetting1"

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

--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 synchronization-setting 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 synchronization-setting is met.

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

Examples

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

az datashare synchronization-setting wait --account-name "Account1" --resource-group "SampleResourceGroup" --share-name "Share1" --name "SynchronizationSetting1" --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 --synchronization-setting-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.

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