az profile

Manage saved Azure authentication profiles.

Commands

Name Description Type Status
az profile list

List all saved profiles, indicating which one is active.

Core Preview
az profile remove

Remove a saved profile.

Core Preview
az profile set

Set the active profile persistently.

Core Preview
az profile show

Show the full details of a single profile, or the active profile.

Core Preview

az profile list

Preview

List all saved profiles, indicating which one is active.

List every saved authentication profile, marking the currently active one. Each entry shows the profile name, tenant, subscription, cloud, and authentication method.

az profile list

Examples

List all saved profiles

az profile list
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h -help -? --?

Show help for the command or group and exit.

--no-cache

Bypass the extension discovery cache and reload extensions from disk.

--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, table, tsv, yaml, yamlc
--query

JMESPath query string to filter/project the command result before rendering.

az profile remove

Preview

Remove a saved profile.

Delete a saved profile by name. If the removed profile was active, the active pointer is cleared with no fallback.

az profile remove --name

Examples

Remove a profile

az profile remove --name staging

Required Parameters

--name

The name of the profile to remove.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h -help -? --?

Show help for the command or group and exit.

--no-cache

Bypass the extension discovery cache and reload extensions from disk.

--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, table, tsv, yaml, yamlc
--query

JMESPath query string to filter/project the command result before rendering.

az profile set

Preview

Set the active profile persistently.

Set the active profile persistently. The named profile must already exist. Setting the active profile performs no re-authentication; it only changes which profile subsequent commands use.

az profile set --name

Examples

Set the active profile

az profile set --name dev

Required Parameters

--name

The name of the profile to activate.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h -help -? --?

Show help for the command or group and exit.

--no-cache

Bypass the extension discovery cache and reload extensions from disk.

--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, table, tsv, yaml, yamlc
--query

JMESPath query string to filter/project the command result before rendering.

az profile show

Preview

Show the full details of a single profile, or the active profile.

Show the full details of a saved profile by name, or show the currently active profile when no profile name is provided. Specify either a profile name or --active, not both.

az profile show [--active]
                [--name]

Examples

Show a profile by name

az profile show production

Show the active profile

az profile show

Show the active profile explicitly

az profile show --active

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--active

Show the active profile. Cannot be used together with the profile name.

--name

The name of the profile to show.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h -help -? --?

Show help for the command or group and exit.

--no-cache

Bypass the extension discovery cache and reload extensions from disk.

--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, table, tsv, yaml, yamlc
--query

JMESPath query string to filter/project the command result before rendering.