@azure/core-http package

sourceCtors のプロトタイプのプロパティを targetCtor のプロトタイプに適用します

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

パラメーター

要求のヘッダーにベアラー トークンを適用する RequestPolicy の新しいファクトリを Authorization 作成します。

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

パラメーター

戻り値

指定されたオプションに基づいて HTTP パイプラインを作成します。

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

パラメーター

戻り値

新しい ServiceClient を作成するために渡すことができる一連のオプション。

timeInMs ミリ秒後に promise を解決する setTimeout のラッパー。

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

パラメーター

戻り値

timeInMs の後に解決される Promise

HTTP パイプラインを通過する際に HTTP 要求本文をシリアル化する新しいシリアル化 RequestPolicyCreator を作成します。

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

パラメーター

戻り値

JSON または XML として解析するコンテンツ タイプの特定のセットを指定すると、HTTP 応答を使用して、要求の OperationSpec によって定義された結果オブジェクトが生成されます。

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

パラメーター

戻り値

ServiceClient によって返される、解析された HttpOperationResponse オブジェクト。

のインスタンス <xref:DisableResponseDecompressionPolicy>を作成するために使用できる要求ポリシー ファクトリを返します。

function disableResponseDecompressionPolicy(): RequestPolicyFactory

戻り値

URI をエンコードします。

function encodeUri(uri: string): string

パラメーター

戻り値

エンコードされた URI。

promise の配列を順番に実行します。 このメソッドのインスピレーションは次のとおりです。 https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html 約束に関する素晴らしいブログ!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

パラメーター

戻り値

解決または拒否された約束のチェーン

最大再試行時間間隔が指定されている限り、構成された回数だけ要求を再試行するポリシー。各再試行は最後の時刻よりも長く待機します。

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

パラメーター

戻り値

HttpOperationResponse を正規化された HTTP 応答オブジェクト (RestResponse) に解析します。

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

パラメーター

戻り値

• 正規化された応答オブジェクト。

送信要求に一意の要求 ID を割り当てるポリシーを作成します。

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

パラメーター

戻り値

生成された UUID

function generateUuid(): string

戻り値

RFC4122 v4 UUID。

プロキシ サーバーの特定の URL を に ProxySettings 変換するか、現在の環境から取得 ProxySettings を試みます (渡されない場合)。

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

パラメーター

戻り値

既定のプロキシ設定(未定義)。

ユーザー エージェントを生成するための既定の方法。 このパッケージの静的情報と、ランタイムから使用可能なシステム情報を使用します。

function getDefaultUserAgentValue(): string

戻り値

指定された文字列が ISO 8601 形式であるかどうかを示します。

function isDuration(value: string): boolean

パラメーター

戻り値

true 有効な場合は 。 false それ以外の場合は 。

オブジェクトをテストして、TokenCredential を実装するかどうかを判断します。

function isTokenCredential(credential: unknown): credential

パラメーター

戻り値

指定された uuid を文字列として検証します

function isValidUuid(uuid: string): boolean

パラメーター

戻り値

Uuid が有効な場合は True。それ以外の場合は false。

今後の要求で HTTP 接続を維持するかどうかを制御するポリシーを作成します。

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

パラメーター

戻り値

のインスタンス <xref:KeepAlivePolicy>

送信要求と受信応答に関する情報をログに記録するポリシーを作成します。

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

パラメーター

戻り値

のインスタンス <xref:LogPolicy>

OperationOptions を RequestOptionsBase に変換します

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

パラメーター

戻り値

指定された XML 文字列を JSON に変換します

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

パラメーター

戻り値

Promise をコールバックに変換します。

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

パラメーター

戻り値

コールバックを受け取る関数 (cb: Function) => void

Promise をサービス コールバックに変換します。

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

パラメーター

戻り値

サービス コールバックを受け取る関数 (cb: ServiceCallback): void

すべての要求にプロキシ設定を適用できるようにするポリシー。 静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): RequestPolicyFactory

パラメーター

戻り値

リダイレクト ポリシーを作成します。これは、応答が "location" ヘッダーと 300 から 307 の間の状態コードで到着した場合に、要求を新しい宛先に繰り返し送信します。

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

パラメーター

戻り値

のインスタンス <xref:RedirectPolicy>

バイナリ情報を含む可能性があるオブジェクトをプレーン オブジェクト、配列、または文字列にシリアル化するユーティリティ関数。

function serializeObject(toSerialize: unknown): any

パラメーター

戻り値

指定authenticationProvidersignRequestされた の メソッドを呼び出して送信要求に署名するポリシーを作成します。

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

パラメーター

戻り値

<xref:SigningPolicy>のインスタンス。

指定された JSON オブジェクトを XML 文字列に変換します

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

パラメーター

戻り値

Authorization ヘッダーを含まない Http 要求の削除されたバージョンを返します。

function stripRequest(request: WebResourceLike): WebResourceLike

パラメーター

戻り値

削除された Http 要求のバージョン。

本文、ヘッダー、および状態のみを含む Http 応答の削除されたバージョンを返します。

function stripResponse(response: HttpOperationResponse): any

パラメーター

戻り値

削除された Http 応答のバージョン。

システム エラーが発生したときに再試行するポリシー。コード "ETIMEDOUT"、"ESOCKETTIMEDOUT"、"ECONNREFUSED"、"ECONNRESET"、または "ENOENT" で識別されます。

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

パラメーター

戻り値

のインスタンス <xref:SystemErrorRetryPolicy>

調整の理由により要求が失敗したことを応答が示した場合に要求を再送信するポリシーを作成します。 たとえば、応答にヘッダーが含まれている Retry-After 場合、そのヘッダーの値に基づいて要求の送信が再試行されます。

詳細については、 を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(): RequestPolicyFactory

戻り値

送信要求をトレーススパンでラップするポリシーを作成します。

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

パラメーター

戻り値

<xref:TracingPolicy> クラスのインスタンス。

指定された TelemetryInfo に基づいて、ユーザー エージェント ヘッダーを送信要求に追加するポリシーを返します。

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

パラメーター

戻り値

新しい <xref:UserAgentPolicy>。