az datashare

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

Manage Data Share.

Commands

az datashare account	Manage account with datashare.
az datashare account create	Create an account.
az datashare account delete	DeleteAccount.
az datashare account list	List Accounts in ResourceGroup And List Accounts in Subscription.
az datashare account show	Get an account.
az datashare account update	Patch an account.
az datashare account wait	Place the CLI in a waiting state until a condition of the datashare account is met.
az datashare consumer-invitation	Manage consumer invitation with datashare.
az datashare consumer-invitation list-invitation	Lists invitations.
az datashare consumer-invitation reject-invitation	Reject an invitation.
az datashare consumer-invitation show	Get an invitation.
az datashare consumer-source-data-set	Manage consumer source data set with datashare.
az datashare consumer-source-data-set list	Get source dataSets of a shareSubscription.
az datashare create	Create a share.
az datashare data-set	Manage data set with datashare.
az datashare data-set create	Create a DataSet.
az datashare data-set delete	Delete a DataSet in a share.
az datashare data-set list	List DataSets in a share.
az datashare data-set show	Get a DataSet in a share.
az datashare data-set wait	Place the CLI in a waiting state until a condition of the datashare data-set is met.
az datashare data-set-mapping	Manage data set mapping with datashare.
az datashare data-set-mapping create	Create a DataSetMapping.
az datashare data-set-mapping delete	Delete a DataSetMapping in a shareSubscription.
az datashare data-set-mapping list	List DataSetMappings in a share subscription.
az datashare data-set-mapping show	Get a DataSetMapping in a shareSubscription.
az datashare delete	Delete a share.
az datashare email-registration	Manage email registration with datashare.
az datashare email-registration activate-email	Activate the email registration for the current tenant.
az datashare email-registration register-email	Register an email for the current tenant.
az datashare invitation	Manage invitation with datashare.
az datashare invitation create	Create an invitation.
az datashare invitation delete	Delete an invitation in a share.
az datashare invitation list	List invitations in a share.
az datashare invitation show	Get an invitation in a share.
az datashare list	List shares in an account.
az datashare list-synchronization	List synchronizations of a share.
az datashare list-synchronization-detail	List synchronization details.
az datashare provider-share-subscription	Manage provider share subscription with datashare.
az datashare provider-share-subscription adjust	Adjust a share subscription's expiration date in a provider share.
az datashare provider-share-subscription list	List share subscriptions in a provider share.
az datashare provider-share-subscription reinstate	Reinstate share subscription in a provider share.
az datashare provider-share-subscription revoke	Revoke share subscription in a provider share.
az datashare provider-share-subscription show	Get share subscription in a provider share.
az datashare provider-share-subscription wait	Place the CLI in a waiting state until a condition of the datashare provider-share-subscription is met.
az datashare share-subscription	Manage share subscription with datashare.
az datashare share-subscription cancel-synchronization	Request to cancel a synchronization.
az datashare share-subscription create	Create a shareSubscription in an account.
az datashare share-subscription delete	Delete a shareSubscription in an account.
az datashare share-subscription list	List share subscriptions in an account.
az datashare share-subscription list-source-share-synchronization-setting	Get synchronization settings set on a share.
az datashare share-subscription list-synchronization	List synchronizations of a share subscription.
az datashare share-subscription list-synchronization-detail	List synchronization details.
az datashare share-subscription show	Get a shareSubscription in an account.
az datashare share-subscription synchronize	Initiate a copy.
az datashare share-subscription wait	Place the CLI in a waiting state until a condition of the datashare share-subscription is met.
az datashare show	Get a share.
az datashare synchronization-setting	Manage synchronization setting with datashare.
az datashare synchronization-setting create	Create a synchronizationSetting.
az datashare synchronization-setting delete	Delete a synchronizationSetting in a share.
az datashare synchronization-setting list	List synchronizationSettings in a share.
az datashare synchronization-setting show	Get a synchronizationSetting 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 trigger	Manage trigger with datashare.
az datashare trigger create	Create a Trigger.
az datashare trigger delete	Delete a Trigger in a shareSubscription.
az datashare trigger list	List Triggers in a share subscription.
az datashare trigger show	Get a Trigger in a shareSubscription.
az datashare trigger wait	Place the CLI in a waiting state until a condition of the datashare trigger is met.
az datashare wait	Place the CLI in a waiting state until a condition of the datashare is met.

az datashare create

Create a share.

az datashare create --account-name
                    --name
                    --resource-group
                    [--description]
                    [--share-kind {CopyBased, InPlace}]
                    [--terms]

Examples

Shares_Create

az datashare create --account-name "Account1" --resource-group "SampleResourceGroup" --description "share description" --share-kind "CopyBased" --terms "Confidential" --name "Share1"

Required Parameters

--account-name

The name of the share account.

--name --share-name -n

The name of the share.

--resource-group -g

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

Optional Parameters

--description

Share description.

--share-kind

Share kind.

accepted values: CopyBased, InPlace

--terms

Share terms.

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.

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

Delete a share.

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

Examples

Shares_Delete

az datashare delete --account-name "Account1" --resource-group "SampleResourceGroup" --name "Share1"

Required Parameters

--account-name

The name of the share account.

--name --share-name -n

The name of the share.

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

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.

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

List shares in an account.

az datashare list --account-name
                  --resource-group
                  [--filter]
                  [--orderby]
                  [--skip-token]

Examples

Shares_ListByAccount

az datashare list --account-name "Account1" --resource-group "SampleResourceGroup"

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

Optional Parameters

--filter

Filters the results using OData syntax.

--orderby

Sorts the results using OData syntax.

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

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

List synchronizations of a share.

az datashare list-synchronization --account-name
                                  --name
                                  --resource-group
                                  [--filter]
                                  [--orderby]
                                  [--skip-token]

Examples

Shares_ListSynchronizations

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

Required Parameters

--account-name

The name of the share account.

--name --share-name -n

The name of the share.

--resource-group -g

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

Optional Parameters

--filter

Filters the results using OData syntax.

--orderby

Sorts the results using OData syntax.

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

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

List synchronization details.

az datashare list-synchronization-detail --account-name
                                         --name
                                         --resource-group
                                         [--consumer-email]
                                         [--consumer-name]
                                         [--consumer-tenant-name]
                                         [--duration-ms]
                                         [--end-time]
                                         [--filter]
                                         [--message]
                                         [--orderby]
                                         [--skip-token]
                                         [--start-time]
                                         [--status]
                                         [--synchronization-id]

Examples

Shares_ListSynchronizationDetails

az datashare list-synchronization-detail --account-name "Account1" --resource-group "SampleResourceGroup" --name "Share1" --synchronization-id "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"

Required Parameters

--account-name

The name of the share account.

--name --share-name -n

The name of the share.

--resource-group -g

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

Optional Parameters

--consumer-email

Email of the user who created the synchronization.

--consumer-name

Name of the user who created the synchronization.

--consumer-tenant-name

Tenant name of the consumer who created the synchronization.

--duration-ms

Synchronization duration.

--end-time

End time of synchronization.

--filter

Filters the results using OData syntax.

--message

Message of synchronization.

--orderby

Sorts the results using OData syntax.

--skip-token

Continuation token.

--start-time

Start time of synchronization.

--status

Raw Status.

--synchronization-id

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

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

Get a share.

az datashare show --account-name
                  --name
                  --resource-group

Examples

Shares_Get

az datashare show --account-name "Account1" --resource-group "SampleResourceGroup" --name "Share1"

Required Parameters

--account-name

The name of the share account.

--name --share-name -n

The name of the share to retrieve.

--resource-group -g

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

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.

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

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

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

Examples

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

az datashare wait --account-name "Account1" --resource-group "SampleResourceGroup" --name "Share1" --deleted

Required Parameters

--account-name

The name of the share account.

--name --share-name -n

The name of the share to retrieve.

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

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.

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

Is this page helpful?

Commands

az datashare create

Examples

Required Parameters

Optional Parameters

az datashare delete

Examples

Required Parameters

Optional Parameters

az datashare list

Examples

Required Parameters

Optional Parameters

az datashare list-synchronization

Examples

Required Parameters

Optional Parameters

az datashare list-synchronization-detail

Examples

Required Parameters

Optional Parameters

az datashare show

Examples

Required Parameters

az datashare wait

Examples

Required Parameters

Optional Parameters

الملاحظات