@azure/core-rest-pipeline package
クラス
RestError |
失敗したパイプライン要求のカスタム エラーの種類。 |
インターフェイス
AddPipelineOptions |
パイプラインにポリシーを追加するときのオプション。 他のポリシーへの依存関係を表すために使用されます。 |
Agent |
NodeJS |
AuthorizeRequestOnChallengeOptions |
authorizeRequestOnChallenge コールバックに送信されるオプション |
AuthorizeRequestOptions |
authorizeRequest コールバックに送信されるオプション |
AuxiliaryAuthenticationHeaderPolicyOptions |
auxiliaryAuthenticationHeaderPolicy を構成するためのオプション |
BearerTokenAuthenticationPolicyOptions |
bearerTokenAuthenticationPolicy を構成するためのオプション |
ChallengeCallbacks |
継続的アクセス評価チャレンジの処理をオーバーライドするオプション。 |
DefaultRetryPolicyOptions |
失敗した要求を再試行する方法を制御するオプション。 |
ExponentialRetryPolicyOptions |
失敗した要求を再試行する方法を制御するオプション。 |
HttpClient |
パイプラインに代わって HTTP 要求を行うクライアントに必要なインターフェイス。 |
HttpHeaders |
要求/応答の HTTP ヘッダーのセットを表します。 ヘッダー名は大文字と小文字を区別しないものとして扱われます。 |
InternalPipelineOptions |
SDK クライアントの HTTP パイプラインの内部オプションを構成するために使用されるオプションを定義します。 |
KeyObject |
NodeJS |
LogPolicyOptions |
logPolicy を構成するためのオプション。 |
Pipeline |
URL への HTTP 要求を行うパイプラインを表します。 パイプラインには、サーバーに対して行われる前と後の各要求の操作を管理するための複数のポリシーを含めることができます。 |
PipelineOptions |
SDK クライアントの HTTP パイプラインを構成するために使用されるオプションを定義します。 |
PipelinePolicy |
パイプライン ポリシーは、パイプラインを通過する際に要求を操作します。 これは概念的には、要求が行われる前に変更できるミドルウェアであり、受信時の応答です。 |
PipelineRequest |
パイプラインによって行われる要求に関するメタデータ。 |
PipelineRequestOptions |
要求を初期化するための設定。 Partial とほぼ同じですが、URL は必須です。 |
PipelineResponse |
パイプラインによって受信された応答に関するメタデータ。 |
PipelineRetryOptions |
失敗した要求を再試行する方法を制御するオプション。 |
ProxySettings |
送信要求のプロキシを構成するためのオプション (Node.js のみ)。 |
PxfObject |
NodeJS |
RedirectPolicyOptions |
リダイレクト応答の処理方法のオプション。 |
RestErrorOptions |
RestError でサポートされるオプション。 |
RetryInformation |
再試行ポリシーの現在の進行状況に関する再試行戦略に提供される情報。 |
RetryModifiers |
再試行ポリシーの動作を変更できるプロパティ。 |
RetryPolicyOptions |
retryPolicy のオプション |
RetryStrategy |
再試行戦略は、再試行するかどうかを定義し、再試行する方法を定義することを目的としています。 |
SystemErrorRetryPolicyOptions |
失敗した要求を再試行する方法を制御するオプション。 |
TelemetryOptions |
一般的なテレメトリとトレース情報を構成するために使用するオプションを定義します |
ThrottlingRetryPolicyOptions |
失敗した要求を再試行する方法を制御するオプション。 |
TlsSettings |
TLS 認証の証明書を表します。 |
TracingPolicyOptions |
トレース ポリシーを構成するためのオプション。 |
UserAgentPolicyOptions |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
型エイリアス
FormDataMap |
ブラウザー フォームの場合と同様に、フォーム データを提供する単純なオブジェクト。 |
FormDataValue |
各フォーム データエントリには、文字列または (ブラウザーで) BLOB を指定できます。 |
HttpMethods |
要求を行うときに使用する HTTP メソッドがサポートされています。 |
PipelinePhase |
ポリシーは段階的に実行されます。 実行順序は次のとおりです。
|
RawHttpHeaders |
単純な JSON オブジェクトとして表される HttpHeaders コレクション。 |
RawHttpHeadersInput |
単純な JSON オブジェクトとして表される、入力用の HttpHeaders コレクション。 |
RequestBodyType |
要求でサポートされる本文の種類。 NodeJS.ReadableStream および () => NodeJS.ReadableStream は Node のみです。 BLOB、ReadableStream、および () => ReadableStream はブラウザーのみです。 |
SendRequest |
パイプライン要求を作成し、応答を受信するためのシンプルなインターフェイス。 |
TransferProgressEvent |
アップロードまたはダウンロードの進行状況に応じて発生します。 |
機能
auxiliary |
ヘッダーへの外部トークンの |
bearer |
TokenCredential 実装からトークンを要求し、それをベアラー トークンとして要求の Authorization ヘッダーに適用できるポリシー。 |
create |
現在の環境に適した HttpClient を作成します。 |
create |
完全に空のパイプラインを作成します。 カスタムをテストまたは作成する場合に便利です。 |
create |
インターフェイスを満たす オブジェクトを |
create |
カスタマイズ可能なポリシーの既定のセットを使用して、新しいパイプラインを作成します。 |
create |
指定したオプションを使用して新しいパイプライン要求を作成します。 この方法では、既定値を簡単に設定でき、必須ではありません。 |
decompress |
ヘッダーに従って応答の圧縮解除を有効にするポリシー Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
default |
次の 3 つの方法に従って再試行するポリシー。
|
exponential |
指数関数的に増加する遅延を導入しながら要求を再試行しようとするポリシー。 |
form |
要求の FormData を本文にエンコードするポリシー。 |
get |
このメソッドは、ProxyPolicy で使用するためにプロキシ URL を に |
is |
RestError の Typeguard |
log |
すべての要求と応答をログに記録するポリシー。 |
nd |
ndJsonPolicy は、すべての要求のキープ アライブ設定を制御するために使用されるポリシーです。 |
proxy |
すべての要求にプロキシ設定を適用できるようにするポリシー。 静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。 |
redirect |
サーバー側のリダイレクトをサポートするために、サーバーからの場所ヘッダーに従うポリシー。 ブラウザーでは、このポリシーは使用されません。 |
retry |
retryPolicy は、特定の条件が満たされたときに再試行要求を有効にする汎用ポリシーです |
set |
各 PipelineRequest は、作成時に一意の ID を取得します。 このポリシーでは、HTTP ヘッダーを介してその一意の ID を渡して、テレメトリとトレースを向上させます。 |
system |
サーバー自体からの再試行可能なエラー コードではなく、基になるトランスポート層のエラー (DNS 参照エラーなど) を処理することを特に求める再試行ポリシー。 |
throttling |
サーバーが Retry-After ヘッダーを含む 429 応答を送信するときに再試行するポリシー。 詳細については、 をhttps://docs.microsoft.com/en-us/azure/azure-subscription-service-limits参照してくださいhttps://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits。https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
tls |
認証のために HttpClient エージェントにクライアント証明書を追加するパイプライン ポリシーを取得します。 |
tracing |
親を持つ SpanOptions を持つパイプラインによって行われた要求ごとに OpenTelemetry Spans を作成するための単純なポリシー。 親 Span なしで行われた要求は記録されません。 |
user |
ライブラリのバージョンを反映するように User-Agent ヘッダー (または同等) を設定するポリシー。 |
関数の詳細
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
ヘッダーへの外部トークンの x-ms-authorization-auxiliary
ポリシー。
このヘッダーは、テナント間アプリケーションを作成するときに使用されます。異なるテナント内のリソースに対する認証要求を処理する必要がある場合があります。
この機能のしくみの概要については、 ARM ドキュメント を参照してください。
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
パラメーター
戻り値
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
TokenCredential 実装からトークンを要求し、それをベアラー トークンとして要求の Authorization ヘッダーに適用できるポリシー。
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
パラメーター
戻り値
createDefaultHttpClient()
createEmptyPipeline()
createHttpHeaders(RawHttpHeadersInput)
インターフェイスを満たす オブジェクトを HttpHeaders
作成します。
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders
パラメーター
- rawHeaders
- RawHttpHeadersInput
初期ヘッダーを表す単純なオブジェクト
戻り値
createPipelineFromOptions(InternalPipelineOptions)
カスタマイズ可能なポリシーの既定のセットを使用して、新しいパイプラインを作成します。
function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline
パラメーター
- options
- InternalPipelineOptions
カスタム パイプラインを構成するためのオプション。
戻り値
createPipelineRequest(PipelineRequestOptions)
指定したオプションを使用して新しいパイプライン要求を作成します。 この方法では、既定値を簡単に設定でき、必須ではありません。
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest
パラメーター
- options
- PipelineRequestOptions
要求を作成するオプション。
戻り値
decompressResponsePolicy()
ヘッダーに従って応答の圧縮解除を有効にするポリシー Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy
戻り値
defaultRetryPolicy(DefaultRetryPolicyOptions)
次の 3 つの方法に従って再試行するポリシー。
- サーバーが Retry-After ヘッダーを含む 429 応答を送信する場合。
- 基になるトランスポート層にエラーがある場合 (DNS 参照エラーなど)。
- または、送信要求が失敗した場合は、指数関数的に増加する遅延で再試行します。
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy
パラメーター
- options
- DefaultRetryPolicyOptions
戻り値
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
指数関数的に増加する遅延を導入しながら要求を再試行しようとするポリシー。
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy
パラメーター
- options
- ExponentialRetryPolicyOptions
再試行ロジックを構成するオプション。
戻り値
formDataPolicy()
getDefaultProxySettings(string)
このメソッドは、ProxyPolicy で使用するためにプロキシ URL を に ProxySettings
変換します。
引数が指定されていない場合は、環境変数 HTTPS_PROXY
または HTTP_PROXY
からプロキシ URL を解析しようとします。
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined
パラメーター
- proxyUrl
-
string
使用するプロキシの URL。 認証情報を含む場合があります。
戻り値
ProxySettings | undefined
isRestError(unknown)
RestError の Typeguard
function isRestError(e: unknown): e
パラメーター
- e
-
unknown
catch 句によってキャッチされた内容。
戻り値
e
logPolicy(LogPolicyOptions)
すべての要求と応答をログに記録するポリシー。
function logPolicy(options?: LogPolicyOptions): PipelinePolicy
パラメーター
- options
- LogPolicyOptions
logPolicy を構成するためのオプション。
戻り値
ndJsonPolicy()
ndJsonPolicy は、すべての要求のキープ アライブ設定を制御するために使用されるポリシーです。
function ndJsonPolicy(): PipelinePolicy
戻り値
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
すべての要求にプロキシ設定を適用できるようにするポリシー。 静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy
パラメーター
- proxySettings
- ProxySettings
各要求で使用する ProxySettings。
- options
-
{ customNoProxyList?: string[] }
カスタム NO_PROXY パターンなど、追加の設定
戻り値
redirectPolicy(RedirectPolicyOptions)
サーバー側のリダイレクトをサポートするために、サーバーからの場所ヘッダーに従うポリシー。 ブラウザーでは、このポリシーは使用されません。
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
パラメーター
- options
- RedirectPolicyOptions
ポリシーの動作を制御するためのオプション。
戻り値
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy は、特定の条件が満たされたときに再試行要求を有効にする汎用ポリシーです
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy
パラメーター
- strategies
- options
- RetryPolicyOptions
戻り値
setClientRequestIdPolicy(string)
各 PipelineRequest は、作成時に一意の ID を取得します。 このポリシーでは、HTTP ヘッダーを介してその一意の ID を渡して、テレメトリとトレースを向上させます。
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy
パラメーター
- requestIdHeaderName
-
string
要求 ID を渡すヘッダーの名前。
戻り値
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
サーバー自体からの再試行可能なエラー コードではなく、基になるトランスポート層のエラー (DNS 参照エラーなど) を処理することを特に求める再試行ポリシー。
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy
パラメーター
- options
- SystemErrorRetryPolicyOptions
ポリシーをカスタマイズするオプション。
戻り値
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
サーバーが Retry-After ヘッダーを含む 429 応答を送信するときに再試行するポリシー。
詳細については、 をhttps://docs.microsoft.com/en-us/azure/azure-subscription-service-limits参照してくださいhttps://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits。https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy
パラメーター
- options
- ThrottlingRetryPolicyOptions
再試行ロジックを構成するオプション。
戻り値
tlsPolicy(TlsSettings)
認証のために HttpClient エージェントにクライアント証明書を追加するパイプライン ポリシーを取得します。
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy
パラメーター
- tlsSettings
- TlsSettings
戻り値
tracingPolicy(TracingPolicyOptions)
親を持つ SpanOptions を持つパイプラインによって行われた要求ごとに OpenTelemetry Spans を作成するための単純なポリシー。 親 Span なしで行われた要求は記録されません。
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy
パラメーター
- options
- TracingPolicyOptions
トレース ポリシーによってログに記録されるテレメトリを構成するためのオプション。
戻り値
userAgentPolicy(UserAgentPolicyOptions)
ライブラリのバージョンを反映するように User-Agent ヘッダー (または同等) を設定するポリシー。
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy
パラメーター
- options
- UserAgentPolicyOptions
ユーザー エージェントの値をカスタマイズするためのオプション。