Share via

az datashare provider-share-subscription

  • 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 provider-share-subscription command. Learn more about extensions.

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

Manage provider share subscription with datashare.

Commands

Name Description Type Status
az datashare provider-share-subscription adjust

Adjust a share subscription's expiration date in a provider share.

 Extension Experimental
az datashare provider-share-subscription list

List share subscriptions in a provider share.

 Extension Experimental
az datashare provider-share-subscription reinstate

Reinstate share subscription in a provider share.

 Extension Experimental
az datashare provider-share-subscription revoke

Revoke share subscription in a provider share.

 Extension Experimental
az datashare provider-share-subscription show

Get share subscription in a provider share.

 Extension Experimental
az datashare provider-share-subscription wait

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

 Extension Experimental

az datashare provider-share-subscription adjust

Experimental

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

Adjust a share subscription's expiration date in a provider share.

az datashare provider-share-subscription adjust [--account-name]
                                                [--expiration-date]
                                                [--ids]
                                                [--provider-share-subscription-id]
                                                [--resource-group]
                                                [--share-name]
                                                [--subscription]

Examples

ProviderShareSubscriptions_Adjust

az datashare provider-share-subscription adjust --account-name "Account1" --expiration-date "2020-12-26T22:33:24.5785265Z" --provider-share-subscription-id "4256e2cf-0f82-4865-961b-12f83333f487" --resource-group "SampleResourceGroup" --share-name "Share1"

Optional Parameters

--account-name

The name of the share account.

--expiration-date

Expiration date of the share subscription in UTC format.

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

--provider-share-subscription-id

To locate shareSubscription.

--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 provider-share-subscription list

Experimental

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

List share subscriptions in a provider share.

az datashare provider-share-subscription list --account-name
                                              --resource-group
                                              --share-name
                                              [--skip-token]

Examples

ProviderShareSubscriptions_ListByShare

az datashare provider-share-subscription 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 provider-share-subscription reinstate

Experimental

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

Reinstate share subscription in a provider share.

az datashare provider-share-subscription reinstate [--account-name]
                                                   [--expiration-date]
                                                   [--ids]
                                                   [--provider-share-subscription-id]
                                                   [--resource-group]
                                                   [--share-name]
                                                   [--subscription]

Examples

ProviderShareSubscriptions_Reinstate

az datashare provider-share-subscription reinstate --account-name "Account1" --expiration-date "2020-12-26T22:33:24.5785265Z" --provider-share-subscription-id "4256e2cf-0f82-4865-961b-12f83333f487" --resource-group "SampleResourceGroup" --share-name "Share1"

Optional Parameters

--account-name

The name of the share account.

--expiration-date

Expiration date of the share subscription in UTC format.

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

--provider-share-subscription-id

To locate shareSubscription.

--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 provider-share-subscription revoke

Experimental

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

Revoke share subscription in a provider share.

az datashare provider-share-subscription revoke [--account-name]
                                                [--ids]
                                                [--no-wait]
                                                [--provider-share-subscription-id]
                                                [--resource-group]
                                                [--share-name]
                                                [--subscription]

Examples

ProviderShareSubscriptions_Revoke

az datashare provider-share-subscription revoke --account-name "Account1" --provider-share-subscription-id "4256e2cf-0f82-4865-961b-12f83333f487" --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.

--no-wait

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

Default value: False
--provider-share-subscription-id

To locate shareSubscription.

--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 provider-share-subscription show

Experimental

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

Get share subscription in a provider share.

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

Examples

ProviderShareSubscriptions_GetByShare

az datashare provider-share-subscription show --account-name "Account1" --provider-share-subscription-id "4256e2cf-0f82-4865-961b-12f83333f487" --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.

--provider-share-subscription-id

To locate shareSubscription.

--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 provider-share-subscription 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 provider-share-subscription is met.

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

Examples

Pause executing next line of CLI script until the datashare provider-share-subscription is successfully created.

az datashare provider-share-subscription wait --account-name "Account1" --provider-share-subscription-id "4256e2cf-0f82-4865-961b-12f83333f487" --resource-group "SampleResourceGroup" --share-name "Share1" --created

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
--provider-share-subscription-id

To locate shareSubscription.

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