az datashare consumer share-subscription

Commands for consumers to manage datashare share subscriptions.

Commands

az datashare consumer share-subscription create

Create a share subscription in an account.

az datashare consumer share-subscription delete

Delete a share subscription in an account.

az datashare consumer share-subscription list

List share subscriptions in an account.

az datashare consumer share-subscription list-source-dataset

List source datasets of a share subscription.

az datashare consumer share-subscription list-source-share-synchronization-setting

List synchronization settings set on a share.

az datashare consumer share-subscription show

Show a share subscription in an account.

az datashare consumer share-subscription synchronization

Commands for consumers to manage datashare share subscription synchronizations.

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 wait

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

az datashare consumer share-subscription create

Create a share subscription in an account.

az datashare consumer share-subscription create --account-name
                                                --invitation-id
                                                --name
                                                --resource-group
                                                --source-share-location

Examples

Create a share subscription

az datashare consumer share-subscription create --account-name MyAccount --resource-group MyResourceGroup --invitation-id 00000000-0000-0000-0000-000000000000 --source-share-location "eastus2" --name MyShareSubscription

Required Parameters

--account-name

The name of the share account.

--invitation-id

The invitation id.

--name -n

The name of the share subscription.

--resource-group -g

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

--source-share-location

Source share location.

az datashare consumer share-subscription delete

Delete a share subscription in an account.

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

Examples

Delete a share subscription

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

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the share subscription.

--resource-group -g

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

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

az datashare consumer share-subscription list

List share subscriptions in an account.

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

Examples

List share subscriptions

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

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

az datashare consumer share-subscription list-source-dataset

List source datasets of a share subscription.

az datashare consumer share-subscription list-source-dataset --account-name
                                                             --resource-group
                                                             --share-subscription-name

Examples

List source datasets

az datashare consumer share-subscription list-source-dataset --account-name MyAccount --resource-group MyResourceGroup --share-subscription-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-subscription-name

The name of the share subscription.

az datashare consumer share-subscription list-source-share-synchronization-setting

List synchronization settings set on a share.

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

Examples

List synchronization settings

az datashare consumer share-subscription list-source-share-synchronization-setting --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 show

Show a share subscription in an account.

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

Examples

Show a share subscription

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

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the share subscription.

--resource-group -g

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

az datashare consumer share-subscription wait

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

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

Examples

Pause executing next line of CLI script until the datashare share subscription is successfully provisioned.

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

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the share subscription.

--resource-group -g

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

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