AbstractApplicationBuilder<T>.WithExtraQueryParameters 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
| Name | Description |
|---|---|
| WithExtraQueryParameters(IDictionary<String,String>) |
Obsolete.
Sets Extra Query Parameters for the query string in the HTTP authentication request |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Sets Extra Query Parameters for the query string in the HTTP authentication request with control over which parameters are included in the cache key |
| WithExtraQueryParameters(String) |
Obsolete.
Sets Extra Query Parameters for the query string in the HTTP authentication request |
WithExtraQueryParameters(IDictionary<String,String>)
Caution
This method is deprecated. Please use the WithExtraQueryParameters(IDictionary<string, (string value, bool includeInCacheKey)>) method instead, which provides control over which parameters are included in the cache key.
Sets Extra Query Parameters for the query string in the HTTP authentication request
[System.Obsolete("This method is deprecated. Please use the WithExtraQueryParameters(IDictionary<string, (string value, bool includeInCacheKey)>) method instead, which provides control over which parameters are included in the cache key.", false)]
public T WithExtraQueryParameters(System.Collections.Generic.IDictionary<string,string> extraQueryParameters);
[<System.Obsolete("This method is deprecated. Please use the WithExtraQueryParameters(IDictionary<string, (string value, bool includeInCacheKey)>) method instead, which provides control over which parameters are included in the cache key.", false)>]
member this.WithExtraQueryParameters : System.Collections.Generic.IDictionary<string, string> -> 'T
Public Function WithExtraQueryParameters (extraQueryParameters As IDictionary(Of String, String)) As T
Parameters
- extraQueryParameters
- IDictionary<String,String>
This parameter will be appended as is to the query string in the HTTP authentication request to the authority
as a string of segments of the form key=value separated by an ampersand character.
The parameter can be null.
Returns
The builder to chain the .With methods
- Attributes
Applies to
WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>)
Sets Extra Query Parameters for the query string in the HTTP authentication request with control over which parameters are included in the cache key
public T WithExtraQueryParameters(System.Collections.Generic.IDictionary<string,(string Value, bool IncludeInCacheKey)> extraQueryParameters);
member this.WithExtraQueryParameters : System.Collections.Generic.IDictionary<string, ValueTuple<string, bool>> -> 'T
Public Function WithExtraQueryParameters (extraQueryParameters As IDictionary(Of String, ValueTuple(Of String, Boolean))) As T
Parameters
- extraQueryParameters
- IDictionary<String,ValueTuple<String,Boolean>>
This parameter will be appended as is to the query string in the HTTP authentication request to the authority, and merged with those added to the request-level WithExtraQueryParameters API. Each dictionary entry maps a parameter name to a tuple containing: - Value: The parameter value that will be appended to the query string - IncludeInCacheKey: Whether this parameter should be included when computing the token's cache key. To help ensure the correct token is returned from the cache, IncludeInCacheKey should be true if the parameter affects token content or validity (e.g., resource-specific claims or parameters). The parameter can be null.
Returns
The builder to chain .With methods.
Applies to
WithExtraQueryParameters(String)
Caution
This method is deprecated. Please use the WithExtraQueryParameters(IDictionary<string, (string value, bool includeInCacheKey)>) method instead, which provides control over which parameters are included in the cache key.
Sets Extra Query Parameters for the query string in the HTTP authentication request
[System.Obsolete("This method is deprecated. Please use the WithExtraQueryParameters(IDictionary<string, (string value, bool includeInCacheKey)>) method instead, which provides control over which parameters are included in the cache key.", false)]
public T WithExtraQueryParameters(string extraQueryParameters);
[<System.Obsolete("This method is deprecated. Please use the WithExtraQueryParameters(IDictionary<string, (string value, bool includeInCacheKey)>) method instead, which provides control over which parameters are included in the cache key.", false)>]
member this.WithExtraQueryParameters : string -> 'T
Public Function WithExtraQueryParameters (extraQueryParameters As String) As T
Parameters
- extraQueryParameters
- String
This parameter will be appended as is to the query string in the HTTP authentication request to the authority.
The string needs to be properly URL-encoded and ready to send as a string of segments of the form key=value separated by an ampersand character.
Returns
- Attributes