Edit

Share via

Get-AzAccessToken

  • Reference
Module:
Az.Accounts

Get secure access token. When using -ResourceUrl, please make sure the value does match current Azure environment. You may refer to the value of (Get-AzContext).Environment.

Note

For security purposes, the default output type has been changed from a plain text String to SecureString. For more information, see Protect secrets in Azure PowerShell.

Syntax

Get-AzAccessToken
   [-ResourceTypeName <String>]
   [-TenantId <String>]
   [-AsSecureString]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAccessToken
   -ResourceUrl <String>
   [-TenantId <String>]
   [-AsSecureString]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get secure access token

Examples

Example 1 Get the access token for ARM endpoint

Get-AzAccessToken -AsSecureString

Get access token of current account for ResourceManager endpoint

Example 2 Get the access token for Microsoft Graph endpoint

Get-AzAccessToken -AsSecureString -ResourceTypeName MSGraph

Get access token of Microsoft Graph endpoint for current account

Example 3 Get the access token for Microsoft Graph endpoint

Get-AzAccessToken -AsSecureString -ResourceUrl "https://graph.microsoft.com/"

Get access token of Microsoft Graph endpoint for current account

Parameters

-AsSecureString

The parameter is no longer used but kept for backward compatibility. No matter AsSecureString is specified, the output token is a SecureString.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceTypeName

Optional resource type name, supported values: AadGraph, AnalysisServices, AppConfiguration, Arm, Attestation, Batch, CommunicationEmail, DataLake, KeyVault, MSGraph, OperationalInsights, ResourceManager, Storage, Synapse. Default value is Arm if not specified.

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

-ResourceUrl

Resource url for that you're requesting token, e.g. 'https://graph.microsoft.com/'.

Type:String
Aliases:Resource, ResourceUri
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TenantId

Optional Tenant Id. Use tenant id of default context if not specified.

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

Inputs

None

Outputs

PSSecureAccessToken