Język

MicrosoftIdentityHttpClientBuilderExtensions Klasa

Definicja

Przestrzeń nazw:
Microsoft.Identity.Web
Zestaw:
Microsoft.Identity.Web.TokenAcquisition.dll
Pakiet:
Microsoft.Identity.Web.TokenAcquisition v4.16.1

Metody rozszerzenia służące IHttpClientBuilder do dodawania MicrosoftIdentityMessageHandler do potoku klienta HTTP z różnymi opcjami konfiguracji.

public static class MicrosoftIdentityHttpClientBuilderExtensions
type MicrosoftIdentityHttpClientBuilderExtensions = class
Public Module MicrosoftIdentityHttpClientBuilderExtensions
Dziedziczenie
Object
MicrosoftIdentityHttpClientBuilderExtensions

Przykłady

Podstawowe użycie przy użyciu konfiguracji wbudowanej: 

services.AddHttpClient("MyApiClient", client =>
{
    client.BaseAddress = new Uri("https://api.example.com");
})
.AddMicrosoftIdentityMessageHandler(options =>
{
    options.Scopes.Add("https://api.example.com/.default");
});

Konfiguracja z appsettings.json: 

// In appsettings.json:
// {
//   "DownstreamApi": {
//     "Scopes": ["https://graph.microsoft.com/.default"]
//   }
// }

services.AddHttpClient("GraphClient")
    .AddMicrosoftIdentityMessageHandler(
        configuration.GetSection("DownstreamApi"),
        "DownstreamApi");

Bez parametrów dla konfiguracji poszczególnych żądań: 

services.AddHttpClient("FlexibleClient")
    .AddMicrosoftIdentityMessageHandler();

// Later, in a service:
var request = new HttpRequestMessage(HttpMethod.Get, "/api/data")
    .WithAuthenticationOptions(options =>
    {
        options.Scopes.Add("custom.scope");
    });
var response = await httpClient.SendAsync(request);

Uwagi

Te metody rozszerzenia zapewniają wygodny sposób konfigurowania wystąpień httpClient z automatycznym uwierzytelnianiem Microsoft Identity przy użyciu polecenia MicrosoftIdentityMessageHandler. Procedura obsługi automatycznie doda nagłówki autoryzacji do wychodzących żądań HTTP na podstawie skonfigurowanych opcji.

Dostępne są cztery przeciążenia do obsługi różnych scenariuszy konfiguracji:

  • Bez parametrów: w scenariuszach, w których opcje są ustawiane na żądanie
  • Wystąpienie opcji: w przypadku konfiguracji programowej z wstępnie utworzonym obiektem opcji
  • Delegat akcji: w przypadku konfiguracji wbudowanej przy użyciu delegata konfiguracji
  • IConfiguration: w przypadku konfiguracji z appsettings.json lub innych źródeł konfiguracji

Metody

Nazwisko Opis
AddMicrosoftIdentityMessageHandler(IHttpClientBuilder, Action<MicrosoftIdentityMessageHandlerOptions>)

Dodaje element MicrosoftIdentityMessageHandler do potoku klienta HTTP z opcjami skonfigurowanymi za pośrednictwem delegata.
AddMicrosoftIdentityMessageHandler(IHttpClientBuilder, IConfiguration, String)

Dodaje element MicrosoftIdentityMessageHandler do potoku klienta HTTP z opcjami powiązanymi z konfiguracją IConfiguration.
AddMicrosoftIdentityMessageHandler(IHttpClientBuilder, MicrosoftIdentityMessageHandlerOptions)

Dodaje element MicrosoftIdentityMessageHandler do potoku klienta HTTP z określonymi opcjami.
AddMicrosoftIdentityMessageHandler(IHttpClientBuilder)

Dodaje element MicrosoftIdentityMessageHandler do potoku klienta HTTP bez opcji domyślnych. Opcje muszą być skonfigurowane na żądanie przy użyciu polecenia WithAuthenticationOptions(HttpRequestMessage, MicrosoftIdentityMessageHandlerOptions).

Dotyczy

Zobacz też