@azure/core-https package
クラス
| DefaultHttpsClient |
Nodeの「https」モジュールを使用してHTTPSリクエストを送信するHttpsClient実装。 |
| RestError |
失敗したパイプライン要求のカスタム エラーの種類。 |
インターフェイス
| AddPipelineOptions |
パイプラインにポリシーを追加するときのオプション。 他のポリシーへの依存関係を表すために使用されます。 |
| BearerTokenAuthenticationPolicyOptions |
bearerTokenAuthenticationPolicy を構成するためのオプション |
| ExponentialRetryPolicyOptions |
失敗した要求を再試行する方法を制御するオプション。 |
| HttpHeaders |
要求/応答の HTTP ヘッダーのセットを表します。 ヘッダー名は、大文字と小文字が区別されないものとして扱われます。 |
| HttpsClient |
パイプラインに代わって HTTPS 要求を行うクライアントに必要なインターフェイス。 |
| InternalPipelineOptions |
SDK クライアントの HTTP パイプラインの内部オプションを構成するために使用されるオプションを定義します。 |
| LogPolicyOptions |
logPolicy を構成するためのオプション。 |
| Pipeline |
URL に対して HTTPS 要求を行うためのパイプラインを表します。 パイプラインには、サーバーに対して行われる前と後の各要求の操作を管理するための複数のポリシーを含めることができます。 |
| PipelineOptions |
SDK クライアントの HTTP パイプラインを構成するために使用するオプションを定義します。 |
| PipelinePolicy |
パイプライン ポリシーは、パイプラインを通過する要求を操作します。 これは概念的には、要求が行われる前に変更できるミドルウェアであり、受信時の応答も許可されます。 |
| PipelineRequest |
パイプラインによって行われている要求に関するメタデータ。 |
| PipelineRequestOptions |
要求を初期化するための設定。 Partial<PipelineRequest>とほぼ同じですが、urlは必須です。 |
| PipelineResponse |
パイプラインによって受信された応答に関するメタデータ。 |
| ProxySettings |
送信要求のプロキシを構成するオプション (Node.js のみ)。 |
| RedirectPolicyOptions |
リダイレクト応答の処理方法のオプション。 |
| RestErrorOptions |
RestError でサポートされるオプション。 |
| SystemErrorRetryPolicyOptions |
失敗した要求を再試行する方法を制御するオプション。 |
| TracingPolicyOptions |
トレース ポリシーを構成するためのオプション。 |
| UserAgentPolicyOptions |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
型エイリアス
| FormDataMap |
ブラウザー フォームの場合と同様に、フォーム データを提供する単純なオブジェクト。 |
| FormDataValue |
各フォームデータエントリは、文字列または(ブラウザーでは)Blobにすることができます。 |
| HttpMethods |
要求を行うときに使用する HTTP メソッドがサポートされています。 |
| PipelinePhase |
ポリシーは段階的に実行されます。 実行順序は次のとおりです。
|
| RawHttpHeaders |
単純な JSON オブジェクトとして表される HttpHeaders コレクション。 |
| RequestBodyType |
要求でサポートされる本文の種類。 NodeJS.ReadableStreamはノードのみです。 BLOB はブラウザーのみです。 |
| SendRequest |
パイプライン要求を行い、応答を受信するための単純なインターフェイス。 |
| TransferProgressEvent |
アップロードまたはダウンロードの進行状況に応じて発生します。 |
関数
| bearer |
TokenCredential 実装からトークンを要求し、それをベアラー トークンとして要求の Authorization ヘッダーに適用できるポリシー。 |
| create |
完全に空のパイプラインを作成します。 カスタムのものをテストまたは作成する場合に便利です。 |
| create |
|
| create |
カスタマイズ可能なポリシーの既定のセットを使用して、新しいパイプラインを作成します。 |
| create |
指定されたオプションを使用して新しいパイプライン要求を作成します。 この方法では、既定値を簡単に設定でき、必須ではありません。 |
| decompress |
ヘッダー https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding に従って応答の展開を有効にするポリシー Accept-Encoding |
| exponential |
指数関数的に増加する遅延を導入しながら要求を再試行しようとするポリシー。 |
| form |
要求の FormData を本文にエンコードするポリシー。 |
| get |
このメソッドは、プロキシ URL を ProxyPolicy で使用する |
| log |
すべての要求と応答をログに記録するポリシー。 |
| nd |
ndJsonPolicy は、すべての要求のキープ アライブ設定を制御するために使用されるポリシーです。 |
| proxy |
すべての要求にプロキシ設定を適用できるようにするポリシー。 静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。 |
| redirect |
サーバー側のリダイレクトをサポートするために、サーバーから Location ヘッダーに従うポリシー。 |
| set |
各 PipelineRequest は、作成時に一意の ID を取得します。 このポリシーは、テレメトリとトレースを向上させるために、その一意の ID を HTTP ヘッダーを介して渡します。 |
| system |
サーバー自体からの再試行可能なエラー コードではなく、基になるトランスポート層のエラー (DNS 参照エラーなど) を処理することを特に求める再試行ポリシー。 |
| throttling |
サーバーが Retry-After ヘッダーを使用して 429 応答を送信するときに再試行するポリシー。 詳細については、https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits、https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits、https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors を参照してください |
| tracing |
親を持つ SpanOptions を持つパイプラインによって行われた要求ごとに OpenTelemetry Spans を作成する簡単なポリシー。 親 Span なしで行われた要求は記録されません。 |
| user |
ライブラリのバージョンを反映するように User-Agent ヘッダー (またはそれと同等) を設定するポリシー。 |
変数
| bearer |
ベアラーTokenAuthenticationPolicyのプログラム識別子。 |
| decompress |
decompressResponsePolicyのプログラム識別子です。 |
| expontential |
指数関数的RetryPolicyのプログラム識別子です。 |
| form |
formDataPolicyのプログラム識別子。 |
| log |
logPolicyのプログラム識別子。 |
| nd |
ndJsonPolicyのプログラム識別子です。 |
| proxy |
プロキシポリシーのプログラム識別子。 |
| redirect |
リダイレクトポリシーのプログラム識別子。 |
| set |
setClientRequestIdPolicy のプログラム識別子です。 |
| system |
systemErrorRetryPolicyのプログラム識別子。 |
| throttling |
スロットリングRetryPolicyのプログラム識別子です。 |
| tracing |
トレーシングポリシーのプログラム識別子。 |
| user |
userAgentPolicyのプログラム識別子。 |
関数の詳細
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
TokenCredential 実装からトークンを要求し、それをベアラー トークンとして要求の Authorization ヘッダーに適用できるポリシー。
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicyパラメーター
戻り値
createEmptyPipeline()
createHttpHeaders(RawHttpHeaders)
HttpHeaders インターフェイスを満たすオブジェクトを作成します。
function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeadersパラメーター
- rawHeaders
- RawHttpHeaders
初期ヘッダーを表す単純なオブジェクト
戻り値
createPipelineFromOptions(InternalPipelineOptions)
カスタマイズ可能なポリシーの既定のセットを使用して、新しいパイプラインを作成します。
function createPipelineFromOptions(options: InternalPipelineOptions): Pipelineパラメーター
- options
- InternalPipelineOptions
カスタム パイプラインを構成するためのオプション。
戻り値
createPipelineRequest(PipelineRequestOptions)
指定されたオプションを使用して新しいパイプライン要求を作成します。 この方法では、既定値を簡単に設定でき、必須ではありません。
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequestパラメーター
- options
- PipelineRequestOptions
要求の作成に使用するオプション。
戻り値
decompressResponsePolicy()
ヘッダー https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding に従って応答の展開を有効にするポリシー Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy戻り値
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
指数関数的に増加する遅延を導入しながら要求を再試行しようとするポリシー。
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicyパラメーター
- options
- ExponentialRetryPolicyOptions
再試行ロジックを構成するオプション。
戻り値
formDataPolicy()
getDefaultProxySettings(string)
このメソッドは、プロキシ URL を ProxyPolicy で使用する ProxySettings に変換します。
引数が指定されていない場合は、環境変数 HTTPS_PROXY または HTTP_PROXYからプロキシ URL の解析を試みます。
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefinedパラメーター
- proxyUrl
-
string
使用するプロキシの URL。 認証情報を含む場合があります。
戻り値
ProxySettings | undefined
logPolicy(LogPolicyOptions)
すべての要求と応答をログに記録するポリシー。
function logPolicy(options?: LogPolicyOptions): PipelinePolicyパラメーター
- options
- LogPolicyOptions
logPolicy を構成するためのオプション。
戻り値
ndJsonPolicy()
ndJsonPolicy は、すべての要求のキープ アライブ設定を制御するために使用されるポリシーです。
function ndJsonPolicy(): PipelinePolicy戻り値
proxyPolicy(ProxySettings)
すべての要求にプロキシ設定を適用できるようにするポリシー。 静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。
function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicyパラメーター
- proxySettings
- ProxySettings
各要求で使用する ProxySettings。
戻り値
redirectPolicy(RedirectPolicyOptions)
サーバー側のリダイレクトをサポートするために、サーバーから Location ヘッダーに従うポリシー。
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicyパラメーター
- options
- RedirectPolicyOptions
ポリシーの動作を制御するためのオプション。
戻り値
setClientRequestIdPolicy(string)
各 PipelineRequest は、作成時に一意の ID を取得します。 このポリシーは、テレメトリとトレースを向上させるために、その一意の ID を HTTP ヘッダーを介して渡します。
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicyパラメーター
- requestIdHeaderName
-
string
要求 ID を渡すヘッダーの名前。
戻り値
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
サーバー自体からの再試行可能なエラー コードではなく、基になるトランスポート層のエラー (DNS 参照エラーなど) を処理することを特に求める再試行ポリシー。
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicyパラメーター
- options
- SystemErrorRetryPolicyOptions
ポリシーをカスタマイズするオプション。
戻り値
throttlingRetryPolicy()
サーバーが Retry-After ヘッダーを使用して 429 応答を送信するときに再試行するポリシー。
詳細については、https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits、https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits、https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors を参照してください
function throttlingRetryPolicy(): PipelinePolicy戻り値
tracingPolicy(TracingPolicyOptions)
親を持つ SpanOptions を持つパイプラインによって行われた要求ごとに OpenTelemetry Spans を作成する簡単なポリシー。 親 Span なしで行われた要求は記録されません。
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicyパラメーター
- options
- TracingPolicyOptions
トレース ポリシーによってログに記録されるテレメトリを構成するためのオプション。
戻り値
userAgentPolicy(UserAgentPolicyOptions)
ライブラリのバージョンを反映するように User-Agent ヘッダー (またはそれと同等) を設定するポリシー。
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicyパラメーター
- options
- UserAgentPolicyOptions
ユーザー エージェントの値をカスタマイズするためのオプション。
戻り値
Variable Details
bearerTokenAuthenticationPolicyName
ベアラーTokenAuthenticationPolicyのプログラム識別子。
bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"型
"bearerTokenAuthenticationPolicy"
decompressResponsePolicyName
decompressResponsePolicyのプログラム識別子です。
decompressResponsePolicyName: "decompressResponsePolicy"型
"decompressResponsePolicy"
expontentialRetryPolicyName
指数関数的RetryPolicyのプログラム識別子です。
expontentialRetryPolicyName: "exponentialRetryPolicy"型
"exponentialRetryPolicy"
formDataPolicyName
formDataPolicyのプログラム識別子。
formDataPolicyName: "formDataPolicy"型
"formDataPolicy"
logPolicyName
logPolicyのプログラム識別子。
logPolicyName: "logPolicy"型
"logPolicy"
ndJsonPolicyName
ndJsonPolicyのプログラム識別子です。
ndJsonPolicyName: "ndJsonPolicy"型
"ndJsonPolicy"
proxyPolicyName
プロキシポリシーのプログラム識別子。
proxyPolicyName: "proxyPolicy"型
"proxyPolicy"
redirectPolicyName
リダイレクトポリシーのプログラム識別子。
redirectPolicyName: "redirectPolicy"型
"redirectPolicy"
setClientRequestIdPolicyName
setClientRequestIdPolicy のプログラム識別子です。
setClientRequestIdPolicyName: "setClientRequestIdPolicy"型
"setClientRequestIdPolicy"
systemErrorRetryPolicyName
systemErrorRetryPolicyのプログラム識別子。
systemErrorRetryPolicyName: "systemErrorRetryPolicy"型
"systemErrorRetryPolicy"
throttlingRetryPolicyName
スロットリングRetryPolicyのプログラム識別子です。
throttlingRetryPolicyName: "throttlingRetryPolicy"型
"throttlingRetryPolicy"
tracingPolicyName
トレーシングポリシーのプログラム識別子。
tracingPolicyName: "tracingPolicy"型
"tracingPolicy"
userAgentPolicyName
userAgentPolicyのプログラム識別子。
userAgentPolicyName: "userAgentPolicy"型
"userAgentPolicy"
