Język

IDownstreamApi.PatchForUserAsync Metoda

Definicja

Przeciążenia

Nazwisko Opis
PatchForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi i zwracaniem danych. Domyślnie dane wejściowe są serializowane w formacie JSON, a zwracane dane są deserializowane z formatu JSON, ale można podać własny serializator i własny deserializacji w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

PatchForUserAsync<TInput,TOutput>(String, TInput, JsonTypeInfo<TInput>, JsonTypeInfo<TOutput>, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi i zwracaniem danych. Domyślnie dane wejściowe są serializowane w formacie JSON, a zwracane dane są deserializowane z formatu JSON, ale można podać własny serializator i własny deserializacji w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

PatchForUserAsync<TInput>(String, TInput, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi . Domyślnie dane wejściowe są serializowane w formacie JSON, ale możesz podać własny serializator w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

PatchForUserAsync<TInput>(String, TInput, JsonTypeInfo<TInput>, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi . Domyślnie dane wejściowe są serializowane w formacie JSON, ale możesz podać własny serializator w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

PatchForUserAsync<TInput,TOutput>(String, TInput, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi i zwracaniem danych. Domyślnie dane wejściowe są serializowane w formacie JSON, a zwracane dane są deserializowane z formatu JSON, ale można podać własny serializator i własny deserializacji w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

public System.Threading.Tasks.Task<TOutput?> PatchForUserAsync<TInput,TOutput>(string? serviceName, TInput input, Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;
abstract member PatchForUserAsync : string * 'Input * Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)
Public Function PatchForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptionsReadOnlyHttpMethod) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)

Parametry typu

TInput

Ogólny typ danych wejściowych.

TOutput

Ogólny typ danych wyjściowych.

Parametry

serviceName
String

Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.

input
TInput

Dane wysyłane do podrzędnego internetowego interfejsu API za pośrednictwem treści lub żądania HTTP.

downstreamApiOptionsOverride
Action<DownstreamApiOptionsReadOnlyHttpMethod>

[Opcjonalnie] 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.

cancellationToken
CancellationToken

Zwraca

Task<TOutput>

Wartość zwrócona przez podrzędny internetowy interfejs API.

Przykłady

var result = await _downstreamApi.PatchForUserAsync<MyItem, IEnumerable<MyItem>>(
       "MyService",
       myItem,
       options =>
       {
         options.RelativePath = $"api/todolist/{myItem.Id}";
       });

Dotyczy

PatchForUserAsync<TInput,TOutput>(String, TInput, JsonTypeInfo<TInput>, JsonTypeInfo<TOutput>, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi i zwracaniem danych. Domyślnie dane wejściowe są serializowane w formacie JSON, a zwracane dane są deserializowane z formatu JSON, ale można podać własny serializator i własny deserializacji w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

public System.Threading.Tasks.Task<TOutput?> PatchForUserAsync<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.DownstreamApiOptionsReadOnlyHttpMethod>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default) where TOutput : class;
abstract member PatchForUserAsync : string * 'Input * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Input> * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Output (requires 'Output : null)> * Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)
Public Function PatchForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, inputJsonTypeInfo As JsonTypeInfo(Of TInput), outputJsonTypeInfo As JsonTypeInfo(Of TOutput), Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptionsReadOnlyHttpMethod) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TOutput)

Parametry typu

TInput

Ogólny typ danych wejściowych.

TOutput

Ogólny typ danych wyjściowych.

Parametry

serviceName
String

Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.

input
TInput

Dane wysyłane do podrzędnego internetowego interfejsu API za pośrednictwem treści lub żądania HTTP.

inputJsonTypeInfo
JsonTypeInfo<TInput>

Metadane serializacji JSON dla funkcji TInput

outputJsonTypeInfo
JsonTypeInfo<TOutput>

Metadane serializacji JSON dla funkcji TOutput

downstreamApiOptionsOverride
Action<DownstreamApiOptionsReadOnlyHttpMethod>

[Opcjonalnie] 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.

cancellationToken
CancellationToken

Zwraca

Task<TOutput>

Wartość zwrócona przez podrzędny internetowy interfejs API.

Przykłady

var result = await _downstreamApi.PatchForUserAsync<MyItem, IEnumerable<MyItem>>(
       "MyService",
       myItem,
       options =>
       {
         options.RelativePath = $"api/todolist/{myItem.Id}";
       });

Dotyczy

PatchForUserAsync<TInput>(String, TInput, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi . Domyślnie dane wejściowe są serializowane w formacie JSON, ale możesz podać własny serializator w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

public System.Threading.Tasks.Task PatchForUserAsync<TInput>(string? serviceName, TInput input, Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PatchForUserAsync : string * 'Input * Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PatchForUserAsync(Of TInput) (serviceName As String, input As TInput, Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptionsReadOnlyHttpMethod) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parametry typu

TInput

Ogólny typ danych wejściowych.

Parametry

serviceName
String

Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.

input
TInput

Dane wysyłane do podrzędnego internetowego interfejsu API za pośrednictwem treści lub żądania HTTP.

downstreamApiOptionsOverride
Action<DownstreamApiOptionsReadOnlyHttpMethod>

[Opcjonalnie] 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.

cancellationToken
CancellationToken

Zwraca

Wartość zwrócona przez podrzędny internetowy interfejs API.

Przykłady

await _downstreamApi.PatchForUserAsync<MyItem>(
      "MyService",
      myItem,
      options =>
      {
        options.RelativePath = $"api/todolist/{myItem.Id}";
      });

Dotyczy

PatchForUserAsync<TInput>(String, TInput, JsonTypeInfo<TInput>, Action<DownstreamApiOptionsReadOnlyHttpMethod>, ClaimsPrincipal, CancellationToken)

Wywołania przy użyciu Patchinterfejsu API podrzędnego z niektórymi danymi wejściowymi . Domyślnie dane wejściowe są serializowane w formacie JSON, ale możesz podać własny serializator w akcji przekazywanej downstreamApiOptionsOverride przez parametr .

public System.Threading.Tasks.Task PatchForUserAsync<TInput>(string? serviceName, TInput input, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TInput> inputJsonTypeInfo, Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod>? downstreamApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PatchForUserAsync : string * 'Input * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Input> * Action<Microsoft.Identity.Abstractions.DownstreamApiOptionsReadOnlyHttpMethod> * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PatchForUserAsync(Of TInput) (serviceName As String, input As TInput, inputJsonTypeInfo As JsonTypeInfo(Of TInput), Optional downstreamApiOptionsOverride As Action(Of DownstreamApiOptionsReadOnlyHttpMethod) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parametry typu

TInput

Ogólny typ danych wejściowych.

Parametry

serviceName
String

Nazwa usługi opisującej podrzędny interfejs API. Dla jednego podrzędnego DownstreamApiOptionsinterfejsu API może istnieć kilka konfiguracji o nazwach mapowanych na poszczególne sekcje. Możesz przekazać wartość null, ale w takim przypadku downstreamApiOptionsOverride należy je ustawić.

input
TInput

Dane wysyłane do podrzędnego internetowego interfejsu API za pośrednictwem treści lub żądania HTTP.

inputJsonTypeInfo
JsonTypeInfo<TInput>

Metadane serializacji JSON dla funkcji TInput

downstreamApiOptionsOverride
Action<DownstreamApiOptionsReadOnlyHttpMethod>

[Opcjonalnie] 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.

cancellationToken
CancellationToken

Zwraca

Wartość zwrócona przez podrzędny internetowy interfejs API.

Przykłady

await _downstreamApi.PatchForUserAsync<MyItem>(
      "MyService",
      myItem,
      options =>
      {
        options.RelativePath = $"api/todolist/{myItem.Id}";
      });

Dotyczy