< Back
Get-AzureRmContext
Post
NAME Get-AzureRmContext
SYNOPSIS
Gets the metadata used to authenticate Azure Resource Manager requests.
SYNTAX
Get-AzureRmContext [-DefaultProfile <IAzureContextContainer>] -ListAvailable [<CommonParameters>]
Get-AzureRmContext [[-Name] {Default}] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmContext cmdlet gets the current metadata used to authenticate Azure Resource Manager requests.
This cmdlet gets the Active Directory account, Active Directory tenant, Azure subscription, and the targeted Azure environment. Azure Resource
Manager cmdlets use these settings by default when making Azure Resource Manager requests.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ListAvailable [<SwitchParameter>]
List all available contexts in the current session.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The name of the context
Required? false
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
PSAzureContext
This cmdlet returns the account, tenant, and subscription used by Azure Resource Manager cmdlets.
NOTES
Example 1: Getting the current context
PS C:\\> Connect-AzureRmAccount
PS C:\\> Get-AzureRmContext
Environment : AzureCloud
Account : test@outlook.com
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SubscriptionName : Test Subscription
CurrentStorageAccount :
In this example we are logging into our account with an Azure subscription using Connect-AzureRmAccount, and then we are getting the context of
the current session by calling Get-AzureRmContext.
Example 2: Listing all available contexts
PS C:\\> Get-AzureRmContext -ListAvailable
Name : Test
Environment : AzureCloud
Account : test@outlook.com
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SubscriptionName : Test Subscription
CurrentStorageAccount :
Name : Production
Environment : AzureCloud
Account : prod@outlook.com
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SubscriptionName : Production Subscription
CurrentStorageAccount :
In this example, all currently available contexts are displayed. The user may select one of these contexts using Select-AzureRmContext.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ermcontext
Set-AzureRmContext
SYNOPSIS
Gets the metadata used to authenticate Azure Resource Manager requests.
SYNTAX
Get-AzureRmContext [-DefaultProfile <IAzureContextContainer>] -ListAvailable [<CommonParameters>]
Get-AzureRmContext [[-Name] {Default}] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmContext cmdlet gets the current metadata used to authenticate Azure Resource Manager requests.
This cmdlet gets the Active Directory account, Active Directory tenant, Azure subscription, and the targeted Azure environment. Azure Resource
Manager cmdlets use these settings by default when making Azure Resource Manager requests.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ListAvailable [<SwitchParameter>]
List all available contexts in the current session.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The name of the context
Required? false
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
PSAzureContext
This cmdlet returns the account, tenant, and subscription used by Azure Resource Manager cmdlets.
NOTES
Example 1: Getting the current context
PS C:\\> Connect-AzureRmAccount
PS C:\\> Get-AzureRmContext
Environment : AzureCloud
Account : test@outlook.com
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SubscriptionName : Test Subscription
CurrentStorageAccount :
In this example we are logging into our account with an Azure subscription using Connect-AzureRmAccount, and then we are getting the context of
the current session by calling Get-AzureRmContext.
Example 2: Listing all available contexts
PS C:\\> Get-AzureRmContext -ListAvailable
Name : Test
Environment : AzureCloud
Account : test@outlook.com
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SubscriptionName : Test Subscription
CurrentStorageAccount :
Name : Production
Environment : AzureCloud
Account : prod@outlook.com
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SubscriptionName : Production Subscription
CurrentStorageAccount :
In this example, all currently available contexts are displayed. The user may select one of these contexts using Select-AzureRmContext.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ermcontext
Set-AzureRmContext