@azure/core-rest-pipeline package

リファレンス

クラス

失敗したパイプライン要求のカスタムエラーの種類。

インターフェイス

AddPipelineOptions	パイプラインにポリシーを追加するときのオプション。他のポリシーへの依存関係を表すために使用されます。
Agent	NodeJS の `http.Agent`と互換性のあるインターフェイス。実際のインターフェイスはランタイムバージョンによって異なる可能性があるため、パブリックに再エクスポートしないようにする必要があります。
AuthorizeRequestOnChallengeOptions	authorizeRequestOnChallenge コールバックに送信されるオプション
AuthorizeRequestOptions	authorizeRequest コールバックに送信されるオプション
AuxiliaryAuthenticationHeaderPolicyOptions	auxiliaryAuthenticationHeaderPolicy を構成するためのオプション
BearerTokenAuthenticationPolicyOptions	bearerTokenAuthenticationPolicy を構成するためのオプション
BodyPart	マルチパート要求の要求本文の一部。
ChallengeCallbacks	の継続的アクセス評価課題の処理をオーバーライドするオプション。
CreateFileFromStreamOptions	ストリームが渡されるときの createFile の追加オプション。
CreateFileOptions	ファイルに関するメタデータを指定する createFile に渡されるオプション。
DefaultRetryPolicyOptions	失敗した要求を再試行する方法を制御するオプション。
ExponentialRetryPolicyOptions	失敗した要求を再試行する方法を制御するオプション。
HttpClient	パイプラインに代わって HTTP 要求を行うクライアントに必要なインターフェイス。
HttpHeaders	要求/応答の HTTP ヘッダーのセットを表します。ヘッダー名は、大文字と小文字が区別されないものとして扱われます。
InternalPipelineOptions	SDK クライアントの HTTP パイプラインの内部オプションを構成するために使用されるオプションを定義します。
KeyObject	NodeJS の `tls.KeyObject`と互換性のあるインターフェイス。実際のインターフェイスはランタイムバージョンによって異なる可能性があるため、パブリックに再エクスポートしないようにする必要があります。
LogPolicyOptions	logPolicy を構成するためのオプション。
MultipartRequestBody	複数の部分で構成される要求本文。
Pipeline	URL への HTTP 要求を行うパイプラインを表します。パイプラインには、サーバーに対して行われる前と後の各要求の操作を管理するための複数のポリシーを含めることができます。
PipelineOptions	SDK クライアントの HTTP パイプラインを構成するために使用するオプションを定義します。
PipelinePolicy	パイプラインポリシーは、パイプラインを通過する要求を操作します。これは概念的には、要求が行われる前に変更できるミドルウェアであり、受信時の応答も許可されます。
PipelineRequest	パイプラインによって行われている要求に関するメタデータ。
PipelineRequestOptions	要求を初期化するための設定。 Partial とほぼ同じですが、URL は必須です。
PipelineResponse	パイプラインによって受信された応答に関するメタデータ。
PipelineRetryOptions	失敗した要求を再試行する方法を制御するオプション。
ProxySettings	送信要求のプロキシを構成するオプション (Node.js のみ)。
PxfObject	NodeJS の `tls.PxfObject`と互換性のあるインターフェイス。実際のインターフェイスはランタイムバージョンによって異なる可能性があるため、パブリックに再エクスポートしないようにする必要があります。
RedirectPolicyOptions	リダイレクト応答の処理方法のオプション。
RestErrorOptions	RestError でサポートされるオプション。
RetryInformation	再試行ポリシーの現在の進行状況に関する再試行戦略に提供される情報。
RetryModifiers	再試行ポリシーの動作を変更できるプロパティ。
RetryPolicyOptions	retryPolicy のオプション
RetryStrategy	再試行戦略は、再試行するかどうか、および再試行する方法を定義することを目的としています。
SystemErrorRetryPolicyOptions	失敗した要求を再試行する方法を制御するオプション。
TelemetryOptions	一般的なテレメトリとトレース情報の構成に使用されるオプションを定義します
ThrottlingRetryPolicyOptions	失敗した要求を再試行する方法を制御するオプション。
TlsSettings	TLS 認証の証明書を表します。
TracingPolicyOptions	トレースポリシーを構成するためのオプション。
UserAgentPolicyOptions	送信要求にユーザーエージェントの詳細を追加するためのオプション。

型エイリアス

FormDataMap	ブラウザーフォームの場合と同様に、フォームデータを提供する単純なオブジェクト。
FormDataValue	各フォームデータエントリには、文字列、BLOB、またはファイルを指定できます。名前を持つファイルを渡したいが、File クラスにアクセスできない場合は、createFile ヘルパーを使用して作成できます。
HttpMethods	要求を行うときに使用する HTTP メソッドがサポートされています。
PipelinePhase	ポリシーは段階的に実行されます。実行順序は次のとおりです。シリアル化フェーズフェーズに含まれていないポリシー逆シリアル化フェーズ再試行フェーズ署名フェーズ
RawHttpHeaders	単純な JSON オブジェクトとして表される HttpHeaders コレクション。
RawHttpHeadersInput	単純な JSON オブジェクトとして表される、入力用の HttpHeaders コレクション。
RequestBodyType	要求でサポートされる本文の種類。 NodeJS.ReadableStream および () = nodeJS.ReadableStream> ノードのみ。 BLOB、ReadableStream、および () => ReadableStream はブラウザーのみです。
SendRequest	パイプライン要求を行い、応答を受信するための単純なインターフェイス。
TransferProgressEvent	アップロードまたはダウンロードの進行状況に応じて発生します。

関数

agentPolicy(Agent)	http.agent を設定するパイプラインポリシーを取得します。
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	ヘッダーを `x-ms-authorization-auxiliary` する外部トークンのポリシー。このヘッダーは、テナント間アプリケーションを作成するときに、異なるテナントにあるリソースの認証要求を処理する必要がある場合に使用されます。 ARM ドキュメント、この機能のしくみの概要を確認できます
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	TokenCredential 実装からトークンを要求し、それをベアラートークンとして要求の Authorization ヘッダーに適用できるポリシー。
createDefaultHttpClient()	現在の環境に適した HttpClient を作成します。
createEmptyPipeline()	完全に空のパイプラインを作成します。カスタムのものをテストまたは作成する場合に便利です。
createFile(Uint8Array, string, CreateFileOptions)	ファイルインターフェイスを実装するオブジェクトを作成します。このオブジェクトは RequestBodyType.formData に渡すことを目的としており、他の状況では期待どおりに動作することが保証されていません。この関数を使用して、グローバル File オブジェクトが使用できない環境で RequestBodyType.formData で使用する File オブジェクトを作成します。
createFileFromStream(() => ReadableStream<Uint8Array> \| ReadableStream, string, CreateFileFromStreamOptions)	ファイルインターフェイスを実装するオブジェクトを作成します。このオブジェクトは RequestBodyType.formData に渡すことを目的としており、他の状況では期待どおりに動作することが保証されていません。この関数を使用して、次の操作を行います。グローバル File オブジェクトが使用できない環境で RequestBodyType.formData で使用する File オブジェクトを作成します。ストリームをメモリに読み込まずに、読み取り可能なストリームからファイルのようなオブジェクトを作成します。
createHttpHeaders(RawHttpHeadersInput)	`HttpHeaders` インターフェイスを満たすオブジェクトを作成します。
createPipelineFromOptions(InternalPipelineOptions)	カスタマイズ可能なポリシーの既定のセットを使用して、新しいパイプラインを作成します。
createPipelineRequest(PipelineRequestOptions)	指定されたオプションを使用して新しいパイプライン要求を作成します。この方法では、既定値を簡単に設定でき、必須ではありません。
decompressResponsePolicy()	ヘッダー https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding に従って応答の展開を有効にするポリシー Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	次の 3 つの戦略に従って再試行するポリシー。サーバーが Retry-After ヘッダーを含む 429 応答を送信する場合。基になるトランスポート層にエラーがある場合 (DNS 参照エラーなど)。または、送信要求が失敗した場合は、指数関数的に増加する遅延で再試行されます。
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	指数関数的に増加する遅延を導入しながら要求を再試行しようとするポリシー。
formDataPolicy()	要求の FormData を本文にエンコードするポリシー。
getDefaultProxySettings(string)	このメソッドは、プロキシ URL を ProxyPolicy で使用する `ProxySettings` に変換します。引数が指定されていない場合は、環境変数 `HTTPS_PROXY` または `HTTP_PROXY`からプロキシ URL の解析を試みます。
isRestError(unknown)	RestError の Typeguard
logPolicy(LogPolicyOptions)	すべての要求と応答をログに記録するポリシー。
multipartPolicy()	マルチパート要求のパイプラインポリシー
ndJsonPolicy()	ndJsonPolicy は、すべての要求のキープアライブ設定を制御するために使用されるポリシーです。
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	すべての要求にプロキシ設定を適用できるようにするポリシー。静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。
redirectPolicy(RedirectPolicyOptions)	サーバー側のリダイレクトをサポートするために、サーバーから Location ヘッダーに従うポリシー。ブラウザーでは、このポリシーは使用されません。
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy は、特定の条件が満たされたときに要求の再試行を有効にする汎用ポリシーです
setClientRequestIdPolicy(string)	各 PipelineRequest は、作成時に一意の ID を取得します。このポリシーは、テレメトリとトレースを向上させるために、その一意の ID を HTTP ヘッダーを介して渡します。
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	サーバー自体からの再試行可能なエラーコードではなく、基になるトランスポート層のエラー (DNS 参照エラーなど) を処理することを特に求める再試行ポリシー。
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	サーバーが Retry-After ヘッダーを使用して 429 応答を送信するときに再試行するポリシー。詳細については、https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits、https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits、https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors を参照してください
tlsPolicy(TlsSettings)	認証のために HttpClient エージェントにクライアント証明書を追加するパイプラインポリシーを取得します。
tracingPolicy(TracingPolicyOptions)	親を持つ SpanOptions を持つパイプラインによって行われた要求ごとに OpenTelemetry Spans を作成する簡単なポリシー。親 Span なしで行われた要求は記録されません。
userAgentPolicy(UserAgentPolicyOptions)	ライブラリのバージョンを反映するように User-Agent ヘッダー (またはそれと同等) を設定するポリシー。

関数の詳細

agentPolicy(Agent)

http.agent を設定するパイプラインポリシーを取得します。

function agentPolicy(agent?: Agent): PipelinePolicy

パラメーター

agent: Agent

戻り値

PipelinePolicy

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

ヘッダーを x-ms-authorization-auxiliary する外部トークンのポリシー。このヘッダーは、テナント間アプリケーションを作成するときに、異なるテナントにあるリソースの認証要求を処理する必要がある場合に使用されます。 ARM ドキュメント、この機能のしくみの概要を確認できます

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

パラメーター

options: AuxiliaryAuthenticationHeaderPolicyOptions

戻り値

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

TokenCredential 実装からトークンを要求し、それをベアラートークンとして要求の Authorization ヘッダーに適用できるポリシー。

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

パラメーター

options: BearerTokenAuthenticationPolicyOptions

戻り値

PipelinePolicy

createDefaultHttpClient()

現在の環境に適した HttpClient を作成します。

function createDefaultHttpClient(): HttpClient

戻り値

HttpClient

createEmptyPipeline()

完全に空のパイプラインを作成します。カスタムのものをテストまたは作成する場合に便利です。

function createEmptyPipeline(): Pipeline

戻り値

Pipeline

createFile(Uint8Array, string, CreateFileOptions)

ファイルインターフェイスを実装するオブジェクトを作成します。このオブジェクトは RequestBodyType.formData に渡すことを目的としており、他の状況では期待どおりに動作することが保証されていません。

この関数を使用して、グローバル File オブジェクトが使用できない環境で RequestBodyType.formData で使用する File オブジェクトを作成します。

function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File

パラメーター

content: Uint8Array

メモリ内の Uint8Array としてのファイルの内容。

name: string

ファイルの名前。

options: CreateFileOptions

ファイルに関する省略可能なメタデータ (ファイル名、ファイルサイズ、MIME の種類など)。

戻り値

File

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

この関数を使用して、次の操作を行います。

グローバル File オブジェクトが使用できない環境で RequestBodyType.formData で使用する File オブジェクトを作成します。
ストリームをメモリに読み込まずに、読み取り可能なストリームからファイルのようなオブジェクトを作成します。

function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

パラメーター

stream: () => ReadableStream<Uint8Array> | ReadableStream

ストリームを返すコールバックとしてのファイルの内容。 createFile を使用して作成された File オブジェクトが要求のフォームデータマップで渡されると、ストリームはメモリに読み込まれません。代わりに、要求が行われるとストリーミングされます。再試行が発生した場合、ストリームを再度読み取る必要があるため、このコールバックは可能であれば新しいストリームを返す必要があります (SHOULD)。

name: string

ファイルの名前。

options: CreateFileFromStreamOptions

ファイルに関する省略可能なメタデータ (ファイル名、ファイルサイズ、MIME の種類など)。

戻り値

File

createHttpHeaders(RawHttpHeadersInput)

HttpHeaders インターフェイスを満たすオブジェクトを作成します。

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

パラメーター

rawHeaders: RawHttpHeadersInput

初期ヘッダーを表す単純なオブジェクト

戻り値

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

カスタマイズ可能なポリシーの既定のセットを使用して、新しいパイプラインを作成します。

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

パラメーター

options: InternalPipelineOptions

カスタムパイプラインを構成するためのオプション。

戻り値

Pipeline

createPipelineRequest(PipelineRequestOptions)

指定されたオプションを使用して新しいパイプライン要求を作成します。この方法では、既定値を簡単に設定でき、必須ではありません。

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

パラメーター

options: PipelineRequestOptions

要求の作成に使用するオプション。

戻り値

PipelineRequest

decompressResponsePolicy()

ヘッダー https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding に従って応答の展開を有効にするポリシー Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

戻り値

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

次の 3 つの戦略に従って再試行するポリシー。

サーバーが Retry-After ヘッダーを含む 429 応答を送信する場合。
基になるトランスポート層にエラーがある場合 (DNS 参照エラーなど)。
または、送信要求が失敗した場合は、指数関数的に増加する遅延で再試行されます。

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

パラメーター

options: DefaultRetryPolicyOptions

戻り値

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

指数関数的に増加する遅延を導入しながら要求を再試行しようとするポリシー。

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

パラメーター

options: ExponentialRetryPolicyOptions

再試行ロジックを構成するオプション。

戻り値

PipelinePolicy

formDataPolicy()

要求の FormData を本文にエンコードするポリシー。

function formDataPolicy(): PipelinePolicy

戻り値

PipelinePolicy

getDefaultProxySettings(string)

警告

この API は非推奨になりました。

Internally this method is no longer necessary when setting proxy information.

このメソッドは、プロキシ URL を ProxyPolicy で使用する 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 句によってキャッチされる何か。

戻り値

logPolicy(LogPolicyOptions)

すべての要求と応答をログに記録するポリシー。

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

パラメーター

options: LogPolicyOptions

logPolicy を構成するためのオプション。

戻り値

PipelinePolicy

multipartPolicy()

マルチパート要求のパイプラインポリシー

function multipartPolicy(): PipelinePolicy

戻り値

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy は、すべての要求のキープアライブ設定を制御するために使用されるポリシーです。

function ndJsonPolicy(): PipelinePolicy

戻り値

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 パターンなど、追加の設定

戻り値

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

サーバー側のリダイレクトをサポートするために、サーバーから Location ヘッダーに従うポリシー。ブラウザーでは、このポリシーは使用されません。

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

パラメーター

options: RedirectPolicyOptions

ポリシーの動作を制御するためのオプション。

戻り値

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy は、特定の条件が満たされたときに要求の再試行を有効にする汎用ポリシーです

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

パラメーター

strategies: RetryStrategy[]

options: RetryPolicyOptions

戻り値

PipelinePolicy

setClientRequestIdPolicy(string)

各 PipelineRequest は、作成時に一意の ID を取得します。このポリシーは、テレメトリとトレースを向上させるために、その一意の ID を HTTP ヘッダーを介して渡します。

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

パラメーター

requestIdHeaderName: string

要求 ID を渡すヘッダーの名前。

戻り値

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

サーバー自体からの再試行可能なエラーコードではなく、基になるトランスポート層のエラー (DNS 参照エラーなど) を処理することを特に求める再試行ポリシー。

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

パラメーター

options: SystemErrorRetryPolicyOptions

ポリシーをカスタマイズするオプション。

戻り値

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

サーバーが Retry-After ヘッダーを使用して 429 応答を送信するときに再試行するポリシー。

詳細については、https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits、https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits、https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors を参照してください

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

パラメーター

options: ThrottlingRetryPolicyOptions

再試行ロジックを構成するオプション。

戻り値

PipelinePolicy

tlsPolicy(TlsSettings)

認証のために HttpClient エージェントにクライアント証明書を追加するパイプラインポリシーを取得します。

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

パラメーター

tlsSettings: TlsSettings

戻り値

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

親を持つ SpanOptions を持つパイプラインによって行われた要求ごとに OpenTelemetry Spans を作成する簡単なポリシー。親 Span なしで行われた要求は記録されません。

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

パラメーター

options: TracingPolicyOptions

トレースポリシーによってログに記録されるテレメトリを構成するためのオプション。

戻り値

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

ライブラリのバージョンを反映するように User-Agent ヘッダー (またはそれと同等) を設定するポリシー。

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

パラメーター

options: UserAgentPolicyOptions

ユーザーエージェントの値をカスタマイズするためのオプション。

戻り値

PipelinePolicy

次の方法で共有

@azure/core-rest-pipeline package

クラス

インターフェイス

型エイリアス

関数

関数の詳細

agentPolicy(Agent)

パラメーター

戻り値

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

パラメーター

戻り値

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

パラメーター

戻り値

createDefaultHttpClient()

戻り値

createEmptyPipeline()

戻り値

createFile(Uint8Array, string, CreateFileOptions)

パラメーター

戻り値

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

パラメーター

戻り値

createHttpHeaders(RawHttpHeadersInput)

パラメーター

戻り値

createPipelineFromOptions(InternalPipelineOptions)

パラメーター

戻り値

createPipelineRequest(PipelineRequestOptions)

パラメーター

戻り値

decompressResponsePolicy()

戻り値

defaultRetryPolicy(DefaultRetryPolicyOptions)

パラメーター

戻り値

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

パラメーター

戻り値

formDataPolicy()

戻り値

getDefaultProxySettings(string)

パラメーター

戻り値

isRestError(unknown)

パラメーター

戻り値

logPolicy(LogPolicyOptions)

パラメーター

戻り値

multipartPolicy()

戻り値

ndJsonPolicy()

戻り値

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

パラメーター

戻り値

redirectPolicy(RedirectPolicyOptions)

パラメーター

戻り値

retryPolicy(RetryStrategy[], RetryPolicyOptions)

パラメーター

戻り値

setClientRequestIdPolicy(string)

パラメーター

戻り値

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

パラメーター

戻り値

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

パラメーター

戻り値

tlsPolicy(TlsSettings)

パラメーター

戻り値

tracingPolicy(TracingPolicyOptions)