Class AzureCliCredential

Package version

Provides the user access token and expire time with Azure CLI command "az account get-access-token".

Hierarchy

AzureCliCredential

Implements

any
any

Index

Constructors

constructor

Methods

Constructors

constructor

new AzureCliCredential(options?: TokenCredentialOptions): AzureCliCredential

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/azureCliCredential.browser.ts:13
Creates an instance of the AzureCliCredential class. Creates an instance of the AzureCliCredential class.

Parameters
- Optional options: TokenCredentialOptions
Returns AzureCliCredential

Methods

Protected getAzureCliAccessToken

getAzureCliAccessToken(resource: string): Promise<unknown>

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/azureCliCredential.ts:38
Gets the access token from Azure CLI

Parameters
- resource: string
  
  The resource to use when getting the token
Returns Promise<unknown>

getToken

getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/azureCliCredential.browser.ts:19
Authenticates with Azure Active Directory and returns an access token if successful. If authentication cannot be performed at this time, this method may return null. If an error occurs during authentication, an AuthenticationError containing failure details will be thrown.

Parameters
- scopes: string | string[]
  
  The list of scopes for which the token will have access.
- Optional options: GetTokenOptions
  
  The options used to configure any requests this TokenCredential implementation might make.
Returns Promise<AccessToken | null>

Generated using TypeDoc