Language

DownstreamApiOptionsReadOnlyHttpMethod クラス

定義

名前空間:
Microsoft.Identity.Abstractions
アセンブリ:
Microsoft.Identity.Abstractions.dll
パッケージ:
Microsoft.Identity.Abstractions v12.7.0

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

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

注釈

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

コンストラクター

Name 説明
DownstreamApiOptionsReadOnlyHttpMethod(DownstreamApiOptions, String)

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

プロパティ

Name 説明
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 メソッドはパブリックにのみ読み取り可能です。
OnAfterAuthHeaderCreation

呼び出し元アプリがHttpRequestMessage承認ヘッダー (Authorization ヘッダーを含む) が設定された後、メッセージが送信される直前 (最終要求の読み取りまたは調整が可能な時点) をカスタマイズする機会を提供します。 OnBeforeAuthHeaderCreationを使用して対称に名前を付けるために提供されます。このタイミングは、下位互換性のために引き続き呼び出される既存のCustomizeHttpRequestMessageと共有されます。 両方が設定されている場合、それらは同じポイントで実行されるため、呼び出し元は相対順序に依存しないでください。 ここでは、要求バインド プロトコル (SHR q/h/b) によってバインドされたマテリアルは、署名後に実行されるため変更しないでください。その場合は OnBeforeAuthHeaderCreation 使用してください。

(継承元 AuthorizationHeaderProviderOptions)
OnBeforeAuthHeaderCreation

呼び出し元アプリが承認ヘッダーが作成される前にHttpRequestMessageをカスタマイズする機会を提供します。 この時点で、 Authorization ヘッダーはまだ存在しません。 これを使用して、要求バインディング プロトコルが署名する要求 (クエリ、ヘッダー、または本文 ( q/h/b 要求) をトークンにバインドする SignedHttpRequest (SHR) など) を整形し、署名が最終的な要求をカバーするようにします。 ヘッダーの作成 後 に要求を監視または調整するには、 OnAfterAuthHeaderCreation (または CustomizeHttpRequestMessage) を使用します。

(継承元 AuthorizationHeaderProviderOptions)
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)

メソッド

Name 説明
Clone()

オプションを複製する
CloneInternal()

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

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

(継承元 AuthorizationHeaderProviderOptions)

適用対象