Class ChainedTokenCredential
Provides a TokenCredential implementation which chains multiple TokenCredential implementations to be tried in order until one of the getToken methods returns a non-default AccessToken.
Namespace: Azure.Identity
Assembly: Azure.Identity.dll
Syntax
public class ChainedTokenCredential : Azure.Core.TokenCredential
Constructors
ChainedTokenCredential(TokenCredential[])
Creates an instance with the specified TokenCredential sources.
Declaration
public ChainedTokenCredential (params Azure.Core.TokenCredential[] sources);
Parameters
TokenCredential[]
sources
The ordered chain of TokenCredential implementations to tried when calling GetToken(TokenRequestContext, CancellationToken) or GetTokenAsync(TokenRequestContext, CancellationToken) |
Methods
GetToken(TokenRequestContext, CancellationToken)
Sequentially calls Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken) on all the specified sources, returning the first successfully obtained AccessToken. This method is called by Azure SDK clients. It isn't intended for use in application code.
Declaration
public override Azure.Core.AccessToken GetToken (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.Core.TokenRequestContext
requestContext
The details of the authentication request. |
CancellationToken
cancellationToken
A CancellationToken controlling the request lifetime. |
Returns
AccessToken
The first AccessToken returned by the specified sources. Any credential which raises a CredentialUnavailableException will be skipped. |
GetTokenAsync(TokenRequestContext, CancellationToken)
Sequentially calls Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken) on all the specified sources, returning the first successfully obtained AccessToken. This method is called by Azure SDK clients. It isn't intended for use in application code.
Declaration
[System.Diagnostics.DebuggerStepThrough]
public override System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.Core.TokenRequestContext
requestContext
The details of the authentication request. |
CancellationToken
cancellationToken
A CancellationToken controlling the request lifetime. |
Returns
ValueTask<AccessToken>
The first AccessToken returned by the specified sources. Any credential which raises a CredentialUnavailableException will be skipped. |