DownstreamWebApi.CallWebApiForUserAsync Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Przeciążenia
| Nazwa | Opis |
|---|---|
| CallWebApiForUserAsync(String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent) |
Wywołuje podrzędny internetowy interfejs API dla użytkownika na podstawie opisu podrzędnego internetowego interfejsu API w konfiguracji. |
| CallWebApiForUserAsync<TInput,TOutput>(String, TInput, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal) |
Wywołuje podrzędny internetowy interfejs API korzystający z kodu JSON z niektórymi danymi i zwraca dane. |
CallWebApiForUserAsync(String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent)
Wywołuje podrzędny internetowy interfejs API dla użytkownika na podstawie opisu podrzędnego internetowego interfejsu API w konfiguracji.
public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> CallWebApiForUserAsync(string serviceName, string? authenticationScheme, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? calledDownstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Net.Http.StringContent? content = default);abstract member CallWebApiForUserAsync : string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>
override this.CallWebApiForUserAsync : string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>Public Function CallWebApiForUserAsync (serviceName As String, authenticationScheme As String, Optional calledDownstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional content As StringContent = Nothing) As Task(Of HttpResponseMessage)Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny internetowy interfejs API. Dla jednego podrzędnego DownstreamWebApiOptionsinternetowego interfejsu API sieci Web może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku calledDownstreamWebApiOptionsOverride należy je ustawić.
- authenticationScheme
- String
Schemat uwierzytelniania. Jeśli wartość null, użyje metody OpenIdConnectDefault.AuthenticationScheme, jeśli zostanie wywołana z aplikacji internetowej, i JwtBearerDefault.AuthenticationScheme, jeśli zostanie wywołana z internetowego interfejsu API.
- calledDownstreamWebApiOptionsOverride
- Action<DownstreamWebApiOptions>
Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
[Opcjonalnie] Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z obiektu HttpContext.
- content
- StringContent
Kontekst HTTP w przypadku, gdy HttpMethod to Patch, , PutPost.
Zwraca
Element HttpResponseMessage , który aplikacja będzie przetwarzać.
Implementuje
Dotyczy
CallWebApiForUserAsync<TInput,TOutput>(String, TInput, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal)
Wywołuje podrzędny internetowy interfejs API korzystający z kodu JSON z niektórymi danymi i zwraca dane.
public System.Threading.Tasks.Task<TOutput?> CallWebApiForUserAsync<TInput,TOutput>(string serviceName, TInput input, string? authenticationScheme, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default) where TOutput : class;abstract member CallWebApiForUserAsync : string * 'Input * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)
override this.CallWebApiForUserAsync : string * 'Input * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallWebApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, authenticationScheme As String, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing) As Task(Of TOutput)Parametry typu
- TInput
Typ danych wejściowych.
- TOutput
Typ wyjścia.
Parametry
- serviceName
- String
Nazwa usługi opisującej podrzędny internetowy interfejs API. Dla jednego podrzędnego DownstreamWebApiOptionsinternetowego interfejsu API sieci Web może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamWebApiOptionsOverride należy je ustawić.
- input
- TInput
Parametr wejściowy do podrzędnego internetowego interfejsu API.
- authenticationScheme
- String
Schemat uwierzytelniania. Jeśli wartość null, użyje metody OpenIdConnectDefault.AuthenticationScheme, jeśli zostanie wywołana z aplikacji internetowej, i JwtBearerDefault.AuthenticationScheme, jeśli zostanie wywołana z internetowego interfejsu API.
- downstreamWebApiOptionsOverride
- Action<DownstreamWebApiOptions>
Zastępuje opcje proponowane w konfiguracji opisanej przez serviceName.
- user
- ClaimsPrincipal
[Opcjonalnie] Oświadczenia reprezentujące użytkownika. Jest to przydatne na platformach, takich jak Blazor lub Azure Signal R, gdzie httpContext jest niedostępny. Na innych platformach biblioteka będzie znajdować użytkownika z obiektu HttpContext.
Zwraca
Wartość zwrócona przez podrzędny internetowy interfejs API.