az datashare account

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

Manage account with datashare.

Commands

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

Create an account.

az datashare account create --account-name
                            --resource-group
                            [--location]
                            [--no-wait]
                            [--tags]

Examples

Accounts_Create

az datashare account create --location "West US 2" --tags tag1="Red" tag2="White" --name "Account1" --resource-group "SampleResourceGroup"

Required Parameters

--account-name --name -n

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az datashare account delete

DeleteAccount.

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

Examples

Accounts_Delete

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

Required Parameters

--account-name --name -n

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

--no-wait

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

--yes -y

Do not prompt for confirmation.

az datashare account list

List Accounts in ResourceGroup And List Accounts in Subscription.

az datashare account list [--resource-group]
                          [--skip-token]

Examples

Accounts_ListByResourceGroup

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

Accounts_ListBySubscription

az datashare account list

Optional Parameters

--resource-group -g

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

--skip-token

Continuation token.

az datashare account show

Get an account.

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

Examples

Accounts_Get

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

Required Parameters

--account-name --name -n

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

Patch an account.

az datashare account update --account-name
                            --resource-group
                            [--tags]

Examples

Accounts_Update

az datashare account update --name "Account1" --tags tag1="Red" tag2="White" --resource-group "SampleResourceGroup"

Required Parameters

--account-name --name -n

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az datashare account wait

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

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

Examples

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

az datashare account wait --name "Account1" --resource-group "SampleResourceGroup" --created

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

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

Required Parameters

--account-name --name -n

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

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