DownstreamApiOptionsReadOnlyHttpMethod クラス

定義

HttpMethodが構築を超えて設定できないDownstreamApiOptionsの特殊化。

public class DownstreamApiOptionsReadOnlyHttpMethod : Microsoft.Identity.Abstractions.DownstreamApiOptions
type DownstreamApiOptionsReadOnlyHttpMethod = class
    inherit DownstreamApiOptions
Public Class DownstreamApiOptionsReadOnlyHttpMethod
Inherits DownstreamApiOptions
継承
DownstreamApiOptionsReadOnlyHttpMethod

注釈

このクラスは、HTTP メソッドがメソッドの名前によって既に提供されており、オプションによってオーバーライドされないようにする、 IDownstreamApi の特殊なメソッドに関する開発者エクスペリエンスを向上させるために役立ちます。 直接使用する必要はありません。

コンストラクター

名前 説明
DownstreamApiOptionsReadOnlyHttpMethod(DownstreamApiOptions, String)

DownstreamApiOptionsと HTTP メソッドのコンストラクター。

プロパティ

名前 説明
AcceptHeader

HTTP Accept ヘッダーは、クライアントが応答で想定しているコンテンツ タイプについてサーバーに通知するために使用されます。

(継承元 DownstreamApiOptions)
AcquireTokenOptions

トークンの取得に関連するオプション。

(継承元 AuthorizationHeaderProviderOptions)
BaseUrl

呼び出されたダウンストリーム Web API のベース URL。 たとえば、 "https://graph.microsoft.com/beta/"

(継承元 AuthorizationHeaderProviderOptions)
ContentType

要求本文のコンテンツ タイプ。

(継承元 DownstreamApiOptions)
CustomizeHttpRequestMessage

呼び出し元アプリが HttpRequestMessage をカスタマイズする機会を提供します。 たとえば、ヘッダーをカスタマイズします。 これは、Authorization ヘッダーを含むメッセージが形成された後、およびメッセージが送信される直前に呼び出されます。

(継承元 AuthorizationHeaderProviderOptions)
Deserializer

オプションの逆シリアライザー。 Web API からの出力を逆シリアル化します (存在する場合)。 指定しない場合は、次のものが返されます。 JsonSerializer.Deserialize<TOutput>(content, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });

(継承元 DownstreamApiOptions)
ExtraHeaderParameters

HTTP 要求の追加ヘッダーをダウンストリーム Web API に設定します。 これは、要求のヘッダーを ID プロバイダーに設定する別のオプションと混同しないでください。 そのシナリオについては、 ExtraHeadersParameters を参照してください。

(継承元 DownstreamApiOptions)
ExtraQueryParameters

HTTP 要求のクエリ文字列のクエリ パラメーターをダウンストリーム Web API に設定します。 これは、要求のクエリ パラメーターを ID プロバイダーに設定する別のオプションと混同しないでください。 そのシナリオについては、 ExtraQueryParameters を参照してください。

(継承元 DownstreamApiOptions)
HttpMethod

Http メソッドはパブリックにのみ読み取り可能です。

ProtocolScheme

承認ヘッダーの作成に使用されるプロトコル スキームの名前。 既定では、"Bearer" です。

(継承元 AuthorizationHeaderProviderOptions)
RelativePath

BaseUrlの相対パス (例: "me")。

(継承元 AuthorizationHeaderProviderOptions)
RequestAppToken

呼び出し元サービス自体 (アプリ トークン) の代わりにダウンストリーム API が呼び出されるか、サービスによって処理されたユーザー (ユーザー トークン) に代わって呼び出されるかについて説明します。 true場合、トークンはアプリの代わりに要求されます。 それ以外の場合は、ユーザーの代わりに実行されます。

(継承元 AuthorizationHeaderProviderOptions)
Scopes

ダウンストリーム Web API を呼び出すために必要なスコープ。 たとえば、"user.read mail.read" などです。 Microsoft ID の場合、アプリケーション トークン (それ自体に代わってアプリによって要求されたトークン) の場合、スコープは 1 つだけで、末尾は "./default" にする必要があります)。

(継承元 DownstreamApiOptions)
Serializer

オプションのシリアライザー。 入力を Web API にシリアル化します (ある場合)。 既定では、指定されていない場合:

  • 入力が HttpInputから派生した場合は、そのまま使用されます。
  • 入力が文字列の場合は、メディア型 json と見なされるとおりに使用されます。
  • それ以外の場合、オブジェクトは JSON でシリアル化され、UTF8 エンコードと、application/json のメディア型が使用されます。
    new StringContent(JsonSerializer.Serialize(input), Encoding.UTF8, "application/json")
    
(継承元 DownstreamApiOptions)

メソッド

名前 説明
Clone()

オプションを複製する

CloneInternal()

(オーバーライドできるように) オプションを複製します。

GetApiUrl()

ダウンストリーム Web API URL を返します。

(継承元 AuthorizationHeaderProviderOptions)

適用対象