WsFederationConfigurationRetriever.GetAsync Method

Definition

Namespace:

Microsoft.IdentityModel.Protocols.WsFederation

Assembly:

Microsoft.IdentityModel.Protocols.WsFederation.dll

Package:

Microsoft.IdentityModel.Protocols.WsFederation v8.2.1

Overloads

GetAsync(String, CancellationToken)	Retrieves a populated WsFederationConfiguration given an address.
GetAsync(String, IDocumentRetriever, CancellationToken)	Retrieves a populated WsFederationConfiguration given an address and an IDocumentRetriever.
GetAsync(String, HttpClient, CancellationToken)	Retrieves a populated WsFederationConfiguration given an address and an HttpClient.

GetAsync(String, CancellationToken)

Retrieves a populated WsFederationConfiguration given an address.

public static System.Threading.Tasks.Task<Microsoft.IdentityModel.Protocols.WsFederation.WsFederationConfiguration> GetAsync (string address, System.Threading.CancellationToken cancel);

static member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Protocols.WsFederation.WsFederationConfiguration>

Public Shared Function GetAsync (address As String, cancel As CancellationToken) As Task(Of WsFederationConfiguration)

Parameters

address

String

address of the metadata document.

cancel

CancellationToken

CancellationToken.

Returns

Task<WsFederationConfiguration>

A populated WsFederationConfiguration instance.

Exceptions

ArgumentNullException

if address is null or empty.

GetAsync(String, IDocumentRetriever, CancellationToken)

Retrieves a populated WsFederationConfiguration given an address and an IDocumentRetriever.

public static System.Threading.Tasks.Task<Microsoft.IdentityModel.Protocols.WsFederation.WsFederationConfiguration> GetAsync (string address, Microsoft.IdentityModel.Protocols.IDocumentRetriever retriever, System.Threading.CancellationToken cancel);

static member GetAsync : string * Microsoft.IdentityModel.Protocols.IDocumentRetriever * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Protocols.WsFederation.WsFederationConfiguration>

Public Shared Function GetAsync (address As String, retriever As IDocumentRetriever, cancel As CancellationToken) As Task(Of WsFederationConfiguration)

Parameters

address

String

address of the metadata document.

retriever

IDocumentRetriever

the IDocumentRetriever to use to read the metadata document

cancel

CancellationToken

CancellationToken.

Returns

Task<WsFederationConfiguration>

A populated WsFederationConfiguration instance.

Exceptions

ArgumentNullException

if retriever is null.

GetAsync(String, HttpClient, CancellationToken)

Retrieves a populated WsFederationConfiguration given an address and an HttpClient.

public static System.Threading.Tasks.Task<Microsoft.IdentityModel.Protocols.WsFederation.WsFederationConfiguration> GetAsync (string address, System.Net.Http.HttpClient httpClient, System.Threading.CancellationToken cancel);

static member GetAsync : string * System.Net.Http.HttpClient * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Protocols.WsFederation.WsFederationConfiguration>

Public Shared Function GetAsync (address As String, httpClient As HttpClient, cancel As CancellationToken) As Task(Of WsFederationConfiguration)

Parameters

address

String

address of the metadata document.

httpClient

HttpClient

the HttpClient to use to read the metadata document.

cancel

CancellationToken

a CancellationToken.

Returns

Task<WsFederationConfiguration>

A populated WsFederationConfiguration instance.

Exceptions

ArgumentNullException

if httpClient is null.