IDownstreamWebApi.CallWebApiForUserAsync Methode

Definition

Namespace:: Microsoft.Identity.Web

Assembly:: Microsoft.Identity.Web.dll

Paket:: Microsoft.Identity.Web v4.16.1

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Überlädt

Name	Beschreibung
CallWebApiForUserAsync(String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent)	Ruft die downstream-Web-API für den Benutzer basierend auf einer Beschreibung der downstream-Web-API in der Konfiguration auf.
CallWebApiForUserAsync(String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent)	Ruft die downstream-Web-API für den Benutzer basierend auf einer Beschreibung der downstream-Web-API in der Konfiguration auf.
CallWebApiForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal)	Ruft eine nachgelagerte Web-API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt.
CallWebApiForUserAsync<TInput,TOutput>(String, TInput, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal)	Ruft eine nachgelagerte Web-API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt.

CallWebApiForUserAsync(String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent)

Ruft die downstream-Web-API für den Benutzer basierend auf einer Beschreibung der downstream-Web-API in der Konfiguration auf.

public virtual System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> CallWebApiForUserAsync(string serviceName, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? calledDownstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Net.Http.StringContent? content = default);

abstract member CallWebApiForUserAsync : 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 * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

Public Overridable Function CallWebApiForUserAsync (serviceName As String, Optional calledDownstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional content As StringContent = Nothing) As Task(Of HttpResponseMessage)

Parameter

serviceName: String

Name des Diensts, der die downstream-Web-API beschreibt. Es können mehrere Konfigurationsnamenabschnitte DownstreamWebApiOptionszugeordnet werden, die jeweils für eine nachgeschaltete Web-API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall calledDownstreamWebApiOptionsOverride festgelegt werden.

calledDownstreamWebApiOptionsOverride: Action<DownstreamWebApiOptions>

Überschreibt die optionen, die in der konfiguration vorgeschlagen werden, die von serviceName.

user: ClaimsPrincipal

[Optional] Ansprüche, die einen Benutzer darstellen. Dies ist auf Plattformen wie Blazor oder Azure Signal R nützlich, wo der HttpContext nicht verfügbar ist. Auf anderen Plattformen findet die Bibliothek den Benutzer aus dem HttpContext.

content: StringContent

HTTP-Kontext in dem Fall, in dem HttpMethod , Patch Post. Put

Gibt zurück

Task<HttpResponseMessage>

Eine HttpResponseMessage , die die Anwendung verarbeitet.

Gilt für:

CallWebApiForUserAsync(String, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal, StringContent)

Ruft die downstream-Web-API für den Benutzer basierend auf einer Beschreibung der downstream-Web-API in der Konfiguration auf.

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>

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)

Parameter

serviceName: String

authenticationScheme: String

Authentifizierungsschema. Wenn null, wird OpenIdConnectDefault.AuthenticationScheme verwendet, wenn von einer Web-App aufgerufen wird, und JwtBearerDefault.AuthenticationScheme, wenn von einer Web-API aufgerufen wird.

calledDownstreamWebApiOptionsOverride: Action<DownstreamWebApiOptions>

Überschreibt die optionen, die in der konfiguration vorgeschlagen werden, die von serviceName.

user: ClaimsPrincipal

content: StringContent

HTTP-Kontext in dem Fall, in dem HttpMethod , Patch Post. Put

Gibt zurück

Task<HttpResponseMessage>

Eine HttpResponseMessage , die die Anwendung verarbeitet.

Gilt für:

CallWebApiForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamWebApiOptions>, ClaimsPrincipal)

Ruft eine nachgelagerte Web-API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt.

public virtual System.Threading.Tasks.Task<TOutput?> CallWebApiForUserAsync<TInput,TOutput>(string serviceName, TInput input, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default) where TOutput : class;

abstract member CallWebApiForUserAsync : string * 'Input * 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 * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)

Public Overridable Function CallWebApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing) As Task(Of TOutput)

Typparameter

TInput

Eingabetyp.

TOutput

Art der Ausgabe.

Parameter

serviceName: String

Name des Diensts, der die downstream-Web-API beschreibt. Es können mehrere Konfigurationsnamenabschnitte DownstreamWebApiOptionszugeordnet werden, die jeweils für eine nachgeschaltete Web-API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamWebApiOptionsOverride festgelegt werden.

input: TInput

Eingabeparameter für die nachgeschaltete Web-API.

downstreamWebApiOptionsOverride: Action<DownstreamWebApiOptions>

Überschreibt die optionen, die in der konfiguration vorgeschlagen werden, die von serviceName.

user: ClaimsPrincipal

[Optional] Ansprüche, die einen Benutzer darstellen. Dies ist nützlich für Plattformen wie Blazor oder Azure Signal R, wo der HttpContext nicht verfügbar ist. Auf anderen Plattformen findet die Bibliothek den Benutzer aus dem HttpContext.

Gibt zurück

Task<TOutput>

Der von der downstream-Web-API zurückgegebene Wert.

Beispiele

Eine Listenmethode, die ein IEnumerable<MyItem>> zurückgibt.

public Task<IEnumerable<MyItem>> GetAsync()
{
 return _downstreamWebApi.CallWebApiForUserAsync<object, IEnumerable<MyItem>>(
        ServiceName,
        null,
        options =>
        {
          options.RelativePath = $"api/todolist";
        });
}

Beispiel für die Bearbeitung.

public Task<MyItem> EditAsync(MyItem myItem)
{
  return _downstreamWebApi.CallWebApiForUserAsync<MyItem, MyItem>(
        ServiceName,
        nyItem,
        options =>
        {
           options.HttpMethod = HttpMethod.Patch;
           options.RelativePath = $"api/todolist/{myItem.Id}";
        });
}

Gilt für:

CallWebApiForUserAsync<TInput,TOutput>(String, TInput, String, Action<DownstreamWebApiOptions>, ClaimsPrincipal)

Ruft eine nachgelagerte Web-API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt.

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)

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)

Typparameter

TInput

Eingabetyp.

TOutput

Art der Ausgabe.

Parameter

serviceName: String

Name des Diensts, der die downstream-Web-API beschreibt. Es können mehrere Konfigurationsnamenabschnitte DownstreamWebApiOptionszugeordnet werden, die jeweils für eine nachgeschaltete Web-API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamWebApiOptionsOverride festgelegt werden.

input: TInput

Eingabeparameter für die nachgeschaltete Web-API.

authenticationScheme: String

downstreamWebApiOptionsOverride: Action<DownstreamWebApiOptions>

Überschreibt die optionen, die in der konfiguration vorgeschlagen werden, die von serviceName.

user: ClaimsPrincipal

Gibt zurück

Task<TOutput>

Der von der downstream-Web-API zurückgegebene Wert.

Beispiele

Eine Listenmethode, die ein IEnumerable<MyItem>> zurückgibt.

public Task<IEnumerable<MyItem>> GetAsync()
{
 return _downstreamWebApi.CallWebApiForUserAsync<object, IEnumerable<MyItem>>(
        ServiceName,
        null,
        options =>
        {
          options.RelativePath = $"api/todolist";
        });
}

Beispiel für die Bearbeitung.

public Task<MyItem> EditAsync(MyItem myItem)
{
  return _downstreamWebApi.CallWebApiForUserAsync<MyItem, MyItem>(
        ServiceName,
        nyItem,
        options =>
        {
           options.HttpMethod = HttpMethod.Patch;
           options.RelativePath = $"api/todolist/{myItem.Id}";
        });
}

Gilt für:

Feedback

War diese Seite hilfreich?