HttpRequestMessageAuthenticationExtensions.WithAuthenticationOptions Metodo

Definizione

Spazio dei nomi:
Microsoft.Identity.Web
Assembly:
Microsoft.Identity.Web.TokenAcquisition.dll
Pacchetto:
Microsoft.Identity.Web.TokenAcquisition v4.10.0

Overload

Nome Descrizione
WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions)

Imposta le opzioni di autenticazione per la richiesta HTTP.
WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>)

Configura le opzioni di autenticazione per la richiesta HTTP usando un delegato.

WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions)

Imposta le opzioni di autenticazione per la richiesta HTTP.

public static System.Net.Http.HttpRequestMessage WithAuthenticationOptions(this System.Net.Http.HttpRequestMessage request, Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions options);
static member WithAuthenticationOptions : System.Net.Http.HttpRequestMessage * Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions -> System.Net.Http.HttpRequestMessage
<Extension()>
Public Function WithAuthenticationOptions (request As HttpRequestMessage, options As MicrosoftIdentityMessageHandlerOptions) As HttpRequestMessage

Parametri

request
HttpRequestMessage

Messaggio di richiesta HTTP da configurare.

options
MicrosoftIdentityMessageHandlerOptions

Opzioni di autenticazione da applicare a questa richiesta.

Valori restituiti

HttpRequestMessage

Lo stesso messaggio di richiesta per il concatenamento dei metodi.

Eccezioni

ArgumentNullException

Generata quando request o options è null.

Esempio

var options = new MicrosoftIdentityMessageHandlerOptions
{
    Scopes = { "https://graph.microsoft.com/.default" }
};
options.WithAgentIdentity("my-agent-guid");

var request = new HttpRequestMessage(HttpMethod.Get, "/me")
    .WithAuthenticationOptions(options);

Commenti

Questo metodo eseguirà l'override di tutte le opzioni di autenticazione esistenti impostate nella richiesta. L'oggetto opzioni può essere ulteriormente configurato con i metodi di estensione di altri pacchetti Web identity di Microsoft.

Si applica a

WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>)

Configura le opzioni di autenticazione per la richiesta HTTP usando un delegato.

public static System.Net.Http.HttpRequestMessage WithAuthenticationOptions(this System.Net.Http.HttpRequestMessage request, Action<Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions> configure);
static member WithAuthenticationOptions : System.Net.Http.HttpRequestMessage * Action<Microsoft.Identity.Web.MicrosoftIdentityMessageHandlerOptions> -> System.Net.Http.HttpRequestMessage
<Extension()>
Public Function WithAuthenticationOptions (request As HttpRequestMessage, configure As Action(Of MicrosoftIdentityMessageHandlerOptions)) As HttpRequestMessage

Parametri

request
HttpRequestMessage

Messaggio di richiesta HTTP da configurare.

configure
Action<MicrosoftIdentityMessageHandlerOptions>

Delegato che configura le opzioni di autenticazione.

Valori restituiti

HttpRequestMessage

Lo stesso messaggio di richiesta per il concatenamento dei metodi.

Eccezioni

ArgumentNullException

Generata quando request o configure è null.

Esempio

var request = new HttpRequestMessage(HttpMethod.Get, "/api/users")
    .WithAuthenticationOptions(options =>
    {
        options.Scopes.Add("https://myapi.domain.com/user.read");
        options.WithAgentIdentity("agent-application-id");
        options.RequestAppToken = true;
    });

Commenti

Se la richiesta dispone già di opzioni di autenticazione configurate, il delegato riceverà l'oggetto opzioni esistente da modificare. In caso contrario, verrà creata e passata una nuova MicrosoftIdentityMessageHandlerOptions istanza al delegato.

Questo metodo è particolarmente utile quando è necessario applicare metodi di estensione di altri pacchetti Web identity Microsoft, ad esempio metodi di identità dell'agente.

Si applica a