WsFederationConfigurationRetriever.GetAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
Returns
A populated WsFederationConfiguration instance.
Exceptions
if address is null or empty.
Applies to
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
Returns
A populated WsFederationConfiguration instance.
Exceptions
if retriever is null.
Applies to
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
Returns
A populated WsFederationConfiguration instance.
Exceptions
if httpClient is null.