Share via

az purview account

  • Preview
  • Reference

Note

This reference is part of the purview extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az purview account command. Learn more about extensions.

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage account with purview.

Commands

Name Description Type Status
az purview account add-root-collection-admin

Add the administrator for root collection associated with this account.

 Extension Preview
az purview account create

Create an account.

 Extension Preview
az purview account delete

Deletes an account resource.

 Extension Preview
az purview account list

List accounts in ResourceGroup And List accounts in Subscription.

 Extension Preview
az purview account list-key

List the authorization keys associated with this account.

 Extension Preview
az purview account show

Get an account.

 Extension Preview
az purview account update

Updates an account.

 Extension Preview
az purview account wait

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

 Extension Preview

az purview account add-root-collection-admin

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add the administrator for root collection associated with this account.

az purview account add-root-collection-admin [--account-name]
                                             [--ids]
                                             [--object-id]
                                             [--resource-group]
                                             [--subscription]

Examples

Accounts_AddRootCollectionAdmin

az purview account add-root-collection-admin --name "account1" --object-id "7e8de0e7-2bfc-4e1f-9659-2a5785e4356f" --resource-group "SampleResourceGroup"

Optional Parameters

--account-name --name -n

The name of the 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.

--object-id

Gets or sets the object identifier of the admin.

--resource-group -g

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

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

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an account.

az purview account create --account-name
                          --resource-group
                          [--location]
                          [--managed-group-name]
                          [--no-wait]
                          [--public-network-access {Disabled, Enabled, NotSpecified}]
                          [--tags]

Examples

Accounts_CreateOrUpdate

az purview account create --location "WestUS2" --managed-group-name "custom-rgname"                --name "account1" --resource-group "SampleResourceGroup"

Required Parameters

--account-name --name -n

The name of the 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>.

--managed-group-name

Gets or sets the managed resource group name.

--no-wait

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

Default value: False
--public-network-access

Gets or sets the public network access.

Accepted values: Disabled, Enabled, NotSpecified
--tags

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

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

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes an account resource.

az purview account delete [--account-name]
                          [--ids]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

Accounts_Delete

az purview account delete --name "account1" --resource-group "SampleResourceGroup"

Optional Parameters

--account-name --name -n

The name of the 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
--resource-group -g

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

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

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List accounts in ResourceGroup And List accounts in Subscription.

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

Examples

Accounts_ListByResourceGroup

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

Accounts_ListBySubscription

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

The skip 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 purview account list-key

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the authorization keys associated with this account.

az purview account list-key --account-name
                            --resource-group

Examples

Accounts_ListKeys

az purview account list-key --name "account1" --resource-group "SampleResourceGroup"

Required Parameters

--account-name --name -n

The name of the account.

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

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

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an account.

az purview account show [--account-name]
                        [--ids]
                        [--resource-group]
                        [--subscription]

Examples

Accounts_Get

az purview account show --name "account1" --resource-group "SampleResourceGroup"

Optional Parameters

--account-name --name -n

The name of the 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.

--resource-group -g

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

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

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Updates an account.

az purview account update [--account-name]
                          [--ids]
                          [--managed-group-name]
                          [--no-wait]
                          [--public-network-access {Disabled, Enabled, NotSpecified}]
                          [--resource-group]
                          [--subscription]
                          [--tags]

Examples

Accounts_Update

az purview account update --name "account1" --tags newTag="New tag value." --resource-group "SampleResourceGroup"

Optional Parameters

--account-name --name -n

The name of the 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.

--managed-group-name

Gets or sets the managed resource group name.

--no-wait

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

Default value: False
--public-network-access

Gets or sets the public network access.

Accepted values: Disabled, Enabled, NotSpecified
--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

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

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

Preview

Command group 'purview' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Examples

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

az purview account wait --name "account1" --resource-group "SampleResourceGroup" --created

Pause executing next line of CLI script until the purview account is successfully updated.

az purview account wait --name "account1" --resource-group "SampleResourceGroup" --updated

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

az purview account wait --name "account1" --resource-group "SampleResourceGroup" --deleted

Optional Parameters

--account-name --name -n

The name of the 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
--resource-group -g

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

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