Save-​Azure​Rm​Context

Saves the current authentication information for use in other PowerShell sessions.

Syntax

Save-AzureRmContext
    [[-Profile] <AzureRMProfile>]
    [-Path] <String>
    [-Force]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Description

The Save-AzureRmContext cmdlet saves the current authentication information for use in other PowerShell sessions.

Examples

Example 1: Saving the current session's context

PS C:\> Add-AzureRmAccount
PS C:\> Save-AzureRmContext -Path C:\test.json

This example saves the current session's Azure context to the JSON file provided.

Example 2: Saving a given context

PS C:\> Save-AzureRmContext -Profile (Add-AzureRmAccount) -Path C:\test.json

This example saves the Azure context that is passed through to the cmdlet to the JSON file provided.

Required Parameters

-Path

Specifies the path of the file to which to save authentication information.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Overwrite the given file if it exists

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Profile

Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context.

Type:AzureRMProfile
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.Commands.Common.Authentication.Models.AzureRMProfile

Outputs

Microsoft.Azure.Commands.Profile.Models.PSAzureProfile