az datashare invitation

  • Reference

Commands for providers to manage datashare invitations.

Commands

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

Show an invitation in a share.

az datashare invitation create

Create an invitation.

az datashare invitation create --account-name
                               --name
                               --resource-group
                               --share-name
                               [--target-active-directory-id]
                               [--target-email]
                               [--target-object-id]

Examples

Create an invitation

az datashare invitation create --account-name MyAccount --target-email "receiver@microsoft.com" --name MyInvitation --resource-group MyResourceGroup --share-name MyShare

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the invitation.

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

--target-active-directory-id

The target Azure AD Id. Can't be combined with email.

--target-email

The email the invitation is directed to.

--target-object-id

The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.

az datashare invitation delete

Delete an invitation in a share.

az datashare invitation delete --account-name
                               --name
                               --resource-group
                               --share-name
                               [--yes]

Examples

Delete an invitation

az datashare invitation delete --account-name MyAccount --name MyInvitation --resource-group MyResourceGroup --share-name MyShare

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the invitation.

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

--yes -y

Do not prompt for confirmation.

az datashare invitation list

List invitations in a share.

az datashare invitation list --account-name
                             --resource-group
                             --share-name

Examples

List invitations

az datashare invitation 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 invitation show

Show an invitation in a share.

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

Examples

Show an invitation

az datashare invitation show --account-name MyAccount --name MyInvitation --resource-group MyResourceGroup --share-name MyShare

Required Parameters

--account-name

The name of the share account.

--name -n

The name of the invitation.

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