HttpRequestMessageAuthenticationExtensions.WithAuthenticationOptions Methode

Definition

Überlädt

Name Beschreibung
WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions)

Legt Authentifizierungsoptionen für die HTTP-Anforderung fest.

WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>)

Konfiguriert Authentifizierungsoptionen für die HTTP-Anforderung mithilfe eines Delegaten.

WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions)

Legt Authentifizierungsoptionen für die HTTP-Anforderung fest.

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

Parameter

request
HttpRequestMessage

Die zu konfigurierende HTTP-Anforderungsnachricht.

options
MicrosoftIdentityMessageHandlerOptions

Die Authentifizierungsoptionen, die für diese Anforderung gelten sollen.

Gibt zurück

Dieselbe Anforderungsnachricht für die Methodenkette.

Ausnahmen

Wird ausgelöst, wenn request oder options ist null.

Beispiele

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

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

Hinweise

Diese Methode setzt alle vorhandenen Authentifizierungsoptionen außer Kraft, die für die Anforderung festgelegt sind. Das Optionsobjekt kann mit Erweiterungsmethoden aus anderen Microsoft Identitätswebpaketen weiter konfiguriert werden.

Gilt für:

WithAuthenticationOptions(HttpRequestMessage, Action<MicrosoftIdentityMessageHandlerOptions>)

Konfiguriert Authentifizierungsoptionen für die HTTP-Anforderung mithilfe eines Delegaten.

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

Parameter

request
HttpRequestMessage

Die zu konfigurierende HTTP-Anforderungsnachricht.

configure
Action<MicrosoftIdentityMessageHandlerOptions>

Eine Stellvertretung, die die Authentifizierungsoptionen konfiguriert.

Gibt zurück

Dieselbe Anforderungsnachricht für die Methodenkette.

Ausnahmen

Wird ausgelöst, wenn request oder configure ist null.

Beispiele

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;
    });

Hinweise

Wenn die Anforderung bereits Authentifizierungsoptionen konfiguriert hat, erhält der Delegat das vorhandene Optionsobjekt, das geändert werden soll. Andernfalls wird eine neue MicrosoftIdentityMessageHandlerOptions Instanz erstellt und an die Stellvertretung übergeben.

Diese Methode ist besonders nützlich, wenn Sie Erweiterungsmethoden aus anderen Microsoft Identity Web-Paketen anwenden müssen, z. B. Agent-Identitätsmethoden.

Gilt für: