IDownstreamApi.CallApiForUserAsync Methode
Definition
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 |
|---|---|
| CallApiForUserAsync(String, Action<DownstreamApiOptions>, ClaimsPrincipal, HttpContent, CancellationToken) |
Ruft die downstream-API im Namen des Benutzers auf, basierend auf einer Beschreibung der downstream-API in der Konfiguration (Dienstname), programmgesteuert überridatable. Dies ist eine API auf niedrigerer Ebene. Es gibt weitere APIs für bestimmte Http-Methoden. |
| CallApiForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Ruft eine nachgelagerte API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt. |
| CallApiForUserAsync<TInput,TOutput>(String, TInput, JsonTypeInfo<TInput>, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Ruft eine nachgelagerte API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt. |
| CallApiForUserAsync<TOutput>(String, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Rufen Sie einen Web-API-Endpunkt mit einem HttpGet auf, und geben Sie stark typierte Daten zurück. |
| CallApiForUserAsync<TOutput>(String, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken) |
Rufen Sie einen Web-API-Endpunkt mit einem HttpGet auf, und geben Sie stark typierte Daten zurück. |
CallApiForUserAsync(String, Action<DownstreamApiOptions>, ClaimsPrincipal, HttpContent, CancellationToken)
Ruft die downstream-API im Namen des Benutzers auf, basierend auf einer Beschreibung der downstream-API in der Konfiguration (Dienstname), programmgesteuert überridatable. Dies ist eine API auf niedrigerer Ebene. Es gibt weitere APIs für bestimmte Http-Methoden.
public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> CallApiForUserAsync(string? serviceName, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Net.Http.HttpContent? content = default, System.Threading.CancellationToken cancellationToken = default);abstract member CallApiForUserAsync : string * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.HttpContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>Public Function CallApiForUserAsync (serviceName As String, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional content As HttpContent = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpResponseMessage)Parameter
- serviceName
- String
Name des Diensts, der die downstream-Web-API beschreibt. Es kann mehrere benannte Konfigurationsabschnitte DownstreamApiOptionsvorhanden sein, die jeweils für eine nachgeschaltete API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamApiOptionsOverride festgelegt werden.
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
(Optional) Ü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 HTTP-Anforderungskontext.
- content
- HttpContent
Inhalt, der an die API gesendet werden soll, falls dies der Fall HttpMethod ist HttpMethod.Patch, Post. Put
- cancellationToken
- CancellationToken
Abbruchtoken.
Gibt zurück
Eine HttpResponseMessage , die die Anwendung verarbeitet.
Gilt für:
CallApiForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Ruft eine nachgelagerte API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TInput,TOutput>(string? serviceName, TInput input, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * 'Input * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Typparameter
- TInput
Eingabetyp.
- TOutput
Art der Ausgabe.
Parameter
- serviceName
- String
Name des Diensts, der die downstream-API beschreibt. Es kann mehrere benannte Konfigurationsabschnitte DownstreamApiOptionsvorhanden sein, die jeweils für eine nachgeschaltete API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamApiOptionsOverride festgelegt werden.
- input
- TInput
Eingabeparameter für die nachgeschaltete Web-API.
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Ü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.
- cancellationToken
- CancellationToken
Abbruchtoken.
Gibt zurück
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:
CallApiForUserAsync<TInput,TOutput>(String, TInput, JsonTypeInfo<TInput>, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Ruft eine nachgelagerte API auf, die JSON mit einigen Daten verwendet und Daten zurückgibt.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TInput,TOutput>(string? serviceName, TInput input, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TInput> inputJsonTypeInfo, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TOutput> outputJsonTypeInfo, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * 'Input * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Input> * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Output (requires 'Output : null)> * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, inputJsonTypeInfo As JsonTypeInfo(Of TInput), outputJsonTypeInfo As JsonTypeInfo(Of TOutput), Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Typparameter
- TInput
Eingabetyp.
- TOutput
Art der Ausgabe.
Parameter
- serviceName
- String
Name des Diensts, der die downstream-API beschreibt. Es kann mehrere benannte Konfigurationsabschnitte DownstreamApiOptionsvorhanden sein, die jeweils für eine nachgeschaltete API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamApiOptionsOverride festgelegt werden.
- input
- TInput
Eingabeparameter für die nachgeschaltete Web-API.
- inputJsonTypeInfo
- JsonTypeInfo<TInput>
JSON-Serialisierungsmetadaten für TInput
- outputJsonTypeInfo
- JsonTypeInfo<TOutput>
JSON-Serialisierungsmetadaten für TOutput
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Ü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.
- cancellationToken
- CancellationToken
Abbruchtoken.
Gibt zurück
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:
CallApiForUserAsync<TOutput>(String, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Rufen Sie einen Web-API-Endpunkt mit einem HttpGet auf, und geben Sie stark typierte Daten zurück.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TOutput>(string serviceName, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TOutput As Class) (serviceName As String, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Typparameter
- TOutput
Art der Ausgabe.
Parameter
- serviceName
- String
Name des Diensts, der die downstream-API beschreibt. Es kann mehrere benannte Konfigurationsabschnitte DownstreamApiOptionsvorhanden sein, die jeweils für eine nachgeschaltete API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamApiOptionsOverride festgelegt werden.
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Ü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.
- cancellationToken
- CancellationToken
Abbruchtoken.
Gibt zurück
Der von der downstream-Web-API zurückgegebene Wert.
Gilt für:
CallApiForUserAsync<TOutput>(String, JsonTypeInfo<TOutput>, Action<DownstreamApiOptions>, ClaimsPrincipal, CancellationToken)
Rufen Sie einen Web-API-Endpunkt mit einem HttpGet auf, und geben Sie stark typierte Daten zurück.
public System.Threading.Tasks.Task<TOutput?> CallApiForUserAsync<TOutput>(string serviceName, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TOutput> outputJsonTypeInfo, Action<Microsoft.Identity.Abstractions.DownstreamApiOptions>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;abstract member CallApiForUserAsync : string * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Output (requires 'Output : null)> * Action<Microsoft.Identity.Abstractions.DownstreamApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)Public Function CallApiForUserAsync(Of TOutput As Class) (serviceName As String, outputJsonTypeInfo As JsonTypeInfo(Of TOutput), Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)Typparameter
- TOutput
Art der Ausgabe.
Parameter
- serviceName
- String
Name des Diensts, der die downstream-API beschreibt. Es kann mehrere benannte Konfigurationsabschnitte DownstreamApiOptionsvorhanden sein, die jeweils für eine nachgeschaltete API zugeordnet sind. Sie können NULL übergeben, müssen jedoch in diesem Fall downstreamApiOptionsOverride festgelegt werden.
- outputJsonTypeInfo
- JsonTypeInfo<TOutput>
JSON-Serialisierungsmetadaten für TOutput
- downstreamApiOptionsOverride
- Action<DownstreamApiOptions>
Ü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.
- cancellationToken
- CancellationToken
Abbruchtoken.
Gibt zurück
Der von der downstream-Web-API zurückgegebene Wert.