az purview default-account

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 default-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 default account with purview.

Commands

Name	Description	Type	Status
az purview default-account remove	Removes the default account from the scope.	Extension	Preview
az purview default-account set	Sets the default account for the scope.	Extension	Preview
az purview default-account show	Get the default account for the scope.	Extension	Preview

az purview default-account remove

Preview

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

Removes the default account from the scope.

az purview default-account remove --scope-tenant-id
                                  --scope-type {Subscription, Tenant}
                                  [--scope]

Examples

DefaultAccounts_Remove

az purview default-account remove --scope "12345678-1234-1234-12345678abc" --scope-tenant-id "12345678-1234-1234-12345678abc" --scope-type "Tenant"

Required Parameters

--scope-tenant-id

The tenant ID.

--scope-type

The scope for the default account.

accepted values: Subscription, Tenant

Optional Parameters

--scope

The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

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 default-account set

Preview

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

Sets the default account for the scope.

az purview default-account set --scope-tenant-id
                               --subscription-id
                               [--account-name]
                               [--resource-group]
                               [--scope]
                               [--scope-type {Subscription, Tenant}]

Examples

DefaultAccounts_Set

az purview default-account set --account-name "myDefaultAccount" --resource-group "rg-1" --scope "12345678-1234-1234-12345678abc" --scope-tenant-id "12345678-1234-1234-12345678abc" --scope-type "Tenant" --subscription-id "12345678-1234-1234-12345678aaa"

Required Parameters

--scope-tenant-id

The scope tenant in which the default account is set.

--subscription-id

The subscription ID of the account that is set as the default.

Optional Parameters

--account-name --name -n

The name of the account that is set as the default.

--resource-group -g

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

--scope

The scope object ID. For example, sub ID or tenant ID.

--scope-type

The scope where the default account is set.

accepted values: Subscription, 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 purview default-account show

Preview

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

Get the default account for the scope.

az purview default-account show --scope-tenant-id
                                --scope-type {Subscription, Tenant}
                                [--scope]

Examples

DefaultAccounts_Get

az purview default-account show --scope "12345678-1234-1234-12345678abc" --scope-tenant-id "12345678-1234-1234-12345678abc" --scope-type "Tenant"

Required Parameters

--scope-tenant-id

The tenant ID.

--scope-type

The scope for the default account.

accepted values: Subscription, Tenant

Optional Parameters

--scope

The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

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.