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
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
The tenant ID.
The scope for the default account.
| Property | Value |
|---|---|
| Accepted values: | Subscription, Tenant |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az purview default-account set
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 --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
The scope tenant in which the default account is set.
The subscription ID of the account that is set as the default.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the account that is set as the default.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The scope object ID. For example, sub ID or tenant ID.
The scope where the default account is set.
| Property | Value |
|---|---|
| Accepted values: | Subscription, Tenant |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az purview default-account show
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
The tenant ID.
The scope for the default account.
| Property | Value |
|---|---|
| Accepted values: | Subscription, Tenant |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
