Share via

az datashare invitation

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

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

Manage invitation with datashare.

Commands

Name Description Type Status
az datashare invitation create

Create an invitation.

 Extension Experimental
az datashare invitation delete

Delete an invitation in a share.

 Extension Experimental
az datashare invitation list

List invitations in a share.

 Extension Experimental
az datashare invitation show

Get an invitation in a share.

 Extension Experimental

az datashare invitation create

Experimental

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

Create an invitation.

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

Examples

Invitations_Create

az datashare invitation create --account-name "Account1" --expiration-date "2020-08-26T22:33:24.5785265Z" --target-email "receiver@microsoft.com" --name "Invitation1" --resource-group "SampleResourceGroup" --share-name "Share1"

Required Parameters

--account-name

The name of the share account.

--invitation-name --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 to send the invitation for.

Optional Parameters

--expiration-date

The expiration date for the invitation and share subscription.

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

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

Experimental

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

Delete an invitation in a share.

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

Examples

Invitations_Delete

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

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.

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

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

Experimental

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

List invitations in a share.

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

Examples

Invitations_ListByShare

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

--filter

Filters the results using OData syntax.

--orderby

Sorts the results using OData syntax.

--skip-token

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

Experimental

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

Get an invitation in a share.

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

Examples

Invitations_Get

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

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.

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

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