AadHttpClient class
AadHttpClient は、Azure AD アプリケーションに対して REST 呼び出しを実行するために使用されます。
注釈
このクラスは、 @sealedとしてマークされます。 サブクラスでは拡張しないでください。
SharePoint と通信する場合は、代わりに SPHttpClient クラスを使用します。 Microsoft Graph と通信する場合は、 MSGraphClient クラスを使用します。
コンストラクター
| (constructor)(service |
|
プロパティ
| configurations | AadHttpClient クラスで使用する標準の定義済みの AadHttpClientConfiguration オブジェクト。 |
メソッド
| fetch(url, configuration, options) | REST サービス呼び出しを実行します。 |
| get(url, configuration, options) | fetch() を呼び出しますが、メソッドを "GET" に設定します。 |
| post(url, configuration, options) | fetch() を呼び出しますが、メソッドを "POST" に設定します。 |
コンストラクターの詳細
(constructor)(serviceScope, resourceEndpoint, options)
AadHttpClient クラスの新しいインスタンスを構築します
constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);パラメーター
- serviceScope
- ServiceScope
クラスの内部コンポーネントの一部を取得するには、サービス スコープが必要です。
- resourceEndpoint
-
string
トークンを取得するリソース。
- options
- IAadHttpClientOptions
アクセス トークンを取得するための要求の構成オプション。
プロパティの詳細
configurations
AadHttpClient クラスで使用する標準の定義済みの AadHttpClientConfiguration オブジェクト。
static readonly configurations: IAadHttpClientConfigurations;プロパティ値
メソッドの詳細
fetch(url, configuration, options)
REST サービス呼び出しを実行します。
fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;パラメーター
- url
-
string
フェッチするエンドポイント URL が呼び出されます。
- configuration
- AadHttpClientConfiguration
HttpClient の既定の動作を決定します。通常、これは HttpClientConfigurations の最新バージョン番号である必要があります。
- options
- IHttpClientOptions
要求に影響を与えるその他のオプション。
戻り値
Promise<HttpClientResponse>
結果を返す約束。
注釈
AadHttpClient サブクラスは追加の機能強化を追加しますが、HttpClient.fetch() のパラメーターとセマンティクスは、基本的に、ここに記載されている WHATWG API 標準と同じです。 https://fetch.spec.whatwg.org/
get(url, configuration, options)
fetch() を呼び出しますが、メソッドを "GET" に設定します。
get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;パラメーター
- url
-
string
フェッチするエンドポイント URL が呼び出されます。
- configuration
- AadHttpClientConfiguration
HttpClient の既定の動作を決定します。通常、これは HttpClientConfigurations の最新バージョン番号である必要があります。
- options
- IHttpClientOptions
要求に影響を与えるその他のオプション。
戻り値
Promise<HttpClientResponse>
結果を返す約束。
post(url, configuration, options)
fetch() を呼び出しますが、メソッドを "POST" に設定します。
post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;パラメーター
- url
-
string
フェッチするエンドポイント URL が呼び出されます。
- configuration
- AadHttpClientConfiguration
HttpClient の既定の動作を決定します。通常、これは HttpClientConfigurations の最新バージョン番号である必要があります。
- options
- IHttpClientOptions
要求に影響を与えるその他のオプション。
戻り値
Promise<HttpClientResponse>
結果を返す約束。