Class AzureActiveDirectoryTokenProvider

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll

Represents the Azure Active Directory token provider for the Service Bus and Event Hubs.

public class AzureActiveDirectoryTokenProvider : TokenProvider

Inheritance

object

TokenProvider

AzureActiveDirectoryTokenProvider

Inherited Members

TokenProvider.Clear()

TokenProvider.CreateSamlTokenProvider(string)

TokenProvider.CreateSamlTokenProvider(string, Uri)

TokenProvider.CreateSamlTokenProvider(string, Uri, int)

TokenProvider.CreateSamlTokenProvider(string, TokenScope)

TokenProvider.CreateSamlTokenProvider(string, Uri, TokenScope)

TokenProvider.CreateSamlTokenProvider(string, Uri, int, TokenScope)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string, TimeSpan)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string, TokenScope)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string, TimeSpan, TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, string)

TokenProvider.CreateSharedSecretTokenProvider(string, string, Uri)

TokenProvider.CreateSharedSecretTokenProvider(string, byte[])

TokenProvider.CreateSharedSecretTokenProvider(string, byte[], Uri)

TokenProvider.CreateSharedSecretTokenProvider(string, string, TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, string, Uri, TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, byte[], TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, byte[], Uri, TokenScope)

TokenProvider.CreateSimpleWebTokenProvider(string)

TokenProvider.CreateSimpleWebTokenProvider(string, Uri)

TokenProvider.CreateSimpleWebTokenProvider(string, TokenScope)

TokenProvider.CreateSimpleWebTokenProvider(string, Uri, TokenScope)

TokenProvider.CreateWindowsTokenProvider(IEnumerable<Uri>)

TokenProvider.CreateWindowsTokenProvider(IEnumerable<Uri>, NetworkCredential)

TokenProvider.CreateOAuthTokenProvider(IEnumerable<Uri>, NetworkCredential)

TokenProvider.CreateAzureActiveDirectoryTokenProvider(AzureActiveDirectoryTokenProvider.AuthenticationCallback, Uri, string, object)

TokenProvider.CreateManagedIdentityTokenProvider(Uri)

TokenProvider.BeginGetToken(string, string, bool, TimeSpan, AsyncCallback, object)

TokenProvider.BeginGetWebToken(string, string, bool, TimeSpan, AsyncCallback, object)

TokenProvider.EndGetToken(IAsyncResult)

TokenProvider.GetTokenAsync(string, string, bool, TimeSpan)

TokenProvider.GetWebTokenAsync(string, string, bool, TimeSpan)

TokenProvider.EndGetWebToken(IAsyncResult)

TokenProvider.NormalizeAppliesTo(string)

TokenProvider.TokenScope

TokenProvider.CacheTokens

TokenProvider.CacheSize

TokenProvider.IsWebTokenSupported

TokenProvider.StripQueryParameters

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

BuildKey(string, string)

Generates a key for the token provider.

protected override TokenProvider.Key BuildKey(string appliesTo, string action)

Parameters

appliesTo string

The URI which the access token applies to.

action string

The request action.

Returns

TokenProvider.Key

A generated key for the token provider.

OnBeginGetToken(string, string, TimeSpan, AsyncCallback, object)

Executes upon calling the BeginGetToken method.

protected override IAsyncResult OnBeginGetToken(string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

appliesTo string

The URI which the access token applies to.

action string

The request action.

timeout TimeSpan

The time span that specifies the timeout value for the message that gets the security token.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult object that references the asynchronous operation to get a token.

OnBeginGetWebToken(string, string, TimeSpan, AsyncCallback, object)

Executes upon calling the BeginGetWebToken method.

protected override IAsyncResult OnBeginGetWebToken(string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

appliesTo string

The URI which the access token applies to.

action string

The request action.

timeout TimeSpan

The time span that specifies the timeout value for the message that gets the security token.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

An IAsyncResult object that references the asynchronous operation to get a web token.

OnEndGetToken(IAsyncResult, out DateTime)

Executes upon calling the EndGetToken method.

protected override SecurityToken OnEndGetToken(IAsyncResult result, out DateTime cacheUntil)

Parameters

result IAsyncResult

An IAsyncResult object that references the asynchronous operation to get a token.

cacheUntil DateTime

When this method returns, contains the expiration date and time of the token information in the cache.

Returns

SecurityToken

The System.IdentityModel.Tokens.SecurityToken object.

OnEndGetWebToken(IAsyncResult, out DateTime)

Executes upon calling the EndGetWebToken method.

protected override string OnEndGetWebToken(IAsyncResult result, out DateTime cacheUntil)

Parameters

result IAsyncResult

An IAsyncResult object that references the asynchronous operation to get a web token.

cacheUntil DateTime

When this method returns, contains the expiration date and time of the token information in the cache.

Returns

string

The string that represents the web token.