Edit

Manage sign-in profiles in Azure PowerShell (preview)

A profile is a named sign-in context that the Azure PowerShell preview saves when you authenticate. Each profile stores the tenant, subscription, cloud, and sign-in information needed to connect to Azure. Profiles let you switch between accounts, tenants, and subscriptions without signing in each time.

Profiles are useful when you regularly work across multiple contexts, such as personal and corporate subscriptions or separate development and production environments.

When to use profiles

Profiles are useful when you:

  • Work across multiple Azure tenants or subscriptions.
  • Keep development and production environments separate.
  • Use both personal and work accounts.
  • Occasionally run commands against a different subscription without changing your default context.

What a profile stores

When you sign in and save a profile, Azure PowerShell records the connection context for that profile, including:

  • The profile name
  • The Azure tenant (directory)
  • The Azure subscription
  • The cloud environment
  • The sign-in identity (the signed-in user)
  • The authentication method used to sign in

Profiles are stored locally on your machine. Switching profiles changes which of these saved contexts Azure PowerShell uses for subsequent commands.

Sign in and save a profile

Use Connect-AzAccount with the -OutProfile parameter to sign in and save the result as a named profile. Specify the tenant and subscription you want the profile to use:

Connect-AzAccount -TenantId <tenant-id> -SubscriptionId <subscription-id> -OutProfile personal

To create a second profile for a different account, tenant, or subscription, sign in again with a different profile name:

Connect-AzAccount -TenantId <tenant-id> -SubscriptionId <subscription-id> -OutProfile corp

The profile that you sign in to most recently becomes the active profile.

If a browser isn't available (for example, over SSH or in a container), add -UseDeviceCode to complete sign-in with the device code flow:

Connect-AzAccount -TenantId <tenant-id> -SubscriptionId <subscription-id> -OutProfile corp -UseDeviceCode

Note

If you run Connect-AzAccount without -OutProfile, Azure PowerShell signs you in using the reserved default profile (instead of creating a reusable named profile). This preserves compatibility with existing Connect-AzAccount behavior. To keep a reusable, named context, always pass -OutProfile.

Profile naming rules

A profile name must:

  • Be 1–100 characters long.
  • Contain only letters, digits, hyphens (-), underscores (_), or periods (.).

The name default is reserved for sign-in without a named profile and can't be used as a profile name.

List profiles

To see all saved profiles, use Get-AzProfile:

Get-AzProfile

View a profile

To view the details of a specific profile, use Get-AzProfile with the -Name parameter:

Get-AzProfile -Name personal

To view the currently active profile, use the -Active parameter:

Get-AzProfile -Active

Switch the active profile

Use Set-AzProfile to change which profile is active. After you switch, commands that rely on the active context use the newly activated profile:

Set-AzProfile -Name personal
Get-AzResourceGroup

Re-authenticate an existing profile

If a profile's sign-in has expired, sign in again and pass the existing profile name to -Profile to refresh it in place:

Connect-AzAccount -Profile personal

The -Profile and -OutProfile parameters are mutually exclusive: use -OutProfile to create or overwrite a profile, and -Profile to re-authenticate an existing one.

Remove a profile

To delete a profile you no longer need, use Remove-AzProfile:

Remove-AzProfile -Name corp

If you remove the active profile, no profile is active until you set one with Set-AzProfile.

Sign out

To sign out of the active profile and clear its account from the token cache, use Disconnect-AzAccount:

Disconnect-AzAccount

Display the active profile in your prompt

Configure your shell prompt to display the active profile name. Azure PowerShell writes the active profile name to an active-profile file in its local application data directory ({LocalApplicationData}/.azclips/active-profile).

PowerShell

Open your PowerShell profile script (for example, run code $PROFILE) and incorporate the following snippet into your existing prompt function (or replace it if you don't already have one):

function prompt {
    $activeProfileFile = Join-Path (Join-Path ([Environment]::GetFolderPath('LocalApplicationData')) '.azclips') 'active-profile'
    $activeProfile = if (Test-Path $activeProfileFile) { (Get-Content $activeProfileFile -Raw).Trim() } else { '' }
    $suffix = if ($activeProfile) { " @$activeProfile" } else { '' }
    "PS $($ExecutionContext.SessionState.Path.CurrentLocation)$suffix$('>' * ($NestedPromptLevel + 1)) "
}

Zsh with Starship

On macOS, add this to your ~/.config/starship.toml:

[custom.profile]
command = 'test -f "$HOME/Library/Application Support/.azclips/active-profile" && cat "$HOME/Library/Application Support/.azclips/active-profile"'
symbol = '@'
when = 'test -f "$HOME/Library/Application Support/.azclips/active-profile"'
description = 'Name of the active profile in Azure PowerShell'

Note

The location of the active-profile file depends on your operating system's local application data directory. To discover the path on your machine, run [Environment]::GetFolderPath('LocalApplicationData') in PowerShell and append /.azclips/active-profile. Use Get-AzProfile -Active to confirm which profile is active.