@azure/core-http package

クラス

AccessTokenRefresher	現在新しいトークンを待機していない場合に新しいトークンを要求することで、core-http トークン認証ポリシーを支援します。
ApiKeyCredentials	API キーを使用してサービスに対して認証します。
BaseRequestPolicy	すべての要求ポリシーの派生元となる基底クラス。
BasicAuthenticationCredentials	ユーザー名とパスワードを使用して認証する単純な <xref:ServiceClientCredential> 。
DefaultHttpClient	を使用 node-fetchする HTTP クライアント。
ExpiringAccessTokenCache	expiresOnTimestamp が経過した後にキャッシュされた AccessToken をクリアする AccessTokenCache 実装を提供します。
HttpHeaders	HTTP ヘッダーのキーと値のペアのコレクション。
RequestPolicyOptions	RequestPolicy の作成時に使用できる省略可能なプロパティ。
RestError	サービス エンドポイントへの HTTP 要求の結果として発生するエラー。
Serializer	生の応答オブジェクトを最終的な図形にマップするために使用されます。 JSON に組み込まれていない日付やその他のエンコードされた型のパッキングとアンパックに役立ちます。 また、ヘッダーから値をプルしたり、既定値や定数を挿入したりすることもできます。
ServiceClient	ServiceClient はサービス要求を送信し、応答を受信します。
TopicCredentials	Azure Event Gridに使用される TopicCredentials オブジェクト。
URLBuilder	URL の作成、変更、解析を処理するクラス。
URLQuery	URLBuilder のクエリ部分を処理するクラス。
WebResource	新しい WebResource オブジェクトを作成します。 このクラスは、ライブラリ/実装に依存せず、要求を開始するために必要なプロパティをラップすることで、REST 呼び出しを抽象化します。

インターフェイス

AbortSignalLike	"abort" イベントの発生時に要求を中止できるようにします。 ブラウザーに組み込まれている AbortSignal および一般的なポリフィルと互換性があります。
AccessToken	有効期限を持つアクセス トークンを表します。
AccessTokenCache	TokenCredential から返された AccessToken のキャッシュを提供します。
ApiKeyCredentialOptions	ApiKeyCredentials のインスタンスの作成時に指定するオプションについて説明します
BaseMapper	マッパーの基本定義。 XML およびプレーン JavaScript オブジェクトに使用できます。
CompositeMapper	他のマッパーで構成されるマッパー。
CompositeMapperType	他のマッパーに基づいてオブジェクトのプロパティのセットをマップする方法を説明するマッパーを構築するのに役立ちます。 存在する必要があるプロパティは className、、 modelProperties 、 additionalPropertiesのいずれかです。
DeserializationContentTypes	操作応答を特定の方法で逆シリアル化する必要があることを示すコンテンツ タイプ。
DeserializationOptions	API 応答の逆シリアル化を構成するためのオプション。
DictionaryMapper	キーと値のペアとして使用されるプレーンな JavaScript オブジェクトを記述するマッパー。
DictionaryMapperType	マップされた値のディクショナリを解析する方法を説明するマッパーを構築するのに役立ちます。
EnumMapper	列挙型の値を記述するマッパー。
EnumMapperType	列挙型の値を解析する方法を説明するマッパーを構築するのに役立ちます。
GetTokenOptions	TokenCredential.getToken のオプションを定義します。
HttpClient	HttpRequests を送信し、約束された HttpResponses を受信できるインターフェイス。
HttpHeader	HttpHeaders コレクション内の個々のヘッダー。
HttpHeadersLike	HTTP ヘッダーのキーと値のペアのコレクション。
HttpOperationResponse	http 要求と応答のラッパー オブジェクト。 逆シリアル化されたオブジェクトは、応答本文が JSON または XML で受信されるときに、 プロパティに格納されます parsedBody 。
HttpPipelineLogger	HttpPipeline に追加できるロガー。 これにより、各 RequestPolicy は、デバッグ目的で使用できるメッセージをログに記録できます。
HttpResponse	常に存在する HTTP 応答のプロパティ。
InternalPipelineOptions	SDK クライアントの HTTP パイプラインの内部オプションを構成するために使用されるオプションを定義します。
KeepAliveOptions	今後の要求に対して HTTP 接続を維持する方法のオプション。
LogPolicyOptions	logPolicy に渡すオプション。 既定では、ヘッダーのセット リストのみがログに記録されますが、これは構成できます。 要求と応答の本文はログに記録されません。
MapperConstraints	整数範囲や文字列正規表現など、さまざまな値制約の説明。
OperationArguments	操作の 1 つの呼び出しに適用されるプロパティのコレクション。
OperationOptions	すべての操作の基本オプションの種類。
OperationParameter	すべての Operation パラメーターが拡張する共通インターフェイス。
OperationQueryParameter	操作の HTTP 要求にクエリ パラメーターとして追加される操作のパラメーター。
OperationRequestOptions	SDK 操作によって行われた HTTP 要求の処理を構成できるオプション。
OperationResponse	1 つの状態コードの操作要求から返すことができる OperationResponse。
OperationSpec	要求情報をに適切にシリアル化し、 ServiceClient によって返されるオブジェクト ペイロードに逆シリアル化する方法など、HTTP 経由で特定のサービス操作を実行する方法を定義する仕様。
OperationURLParameter	操作の要求 URL に置き換えられる操作のパラメーター。
ParameterValue	RequestPrepareOptions のパスまたはクエリ パラメーターに指定された Parameter 値
PipelineOptions	SDK クライアントの HTTP パイプラインを構成するために使用するオプションを定義します。
PolymorphicDiscriminator	判別型共用体を明確にするために使用されます。 たとえば、応答に多くの図形を含めることができるが、'kind' フィールド (または類似) も含まれている場合、そのフィールドを使用して、応答を正しい型に逆シリアル化する方法を決定できます。
ProxySettings	送信要求のプロキシを構成するためのオプション (Node.jsのみ)。
RedirectOptions	リダイレクト応答の処理方法のオプション。
RequestOptionsBase	すべての操作で使用される options オブジェクトの基本構造について説明します。
RequestPolicy	要求ポリシーの基になる構造。
RequestPolicyOptionsLike	RequestPolicy の作成時に使用できる省略可能なプロパティ。
RequestPrepareOptions	送信 HTTP 要求を準備するためのオプション。
RestResponse	REST 呼び出しに対するフラット化された応答。 基になる HttpOperationResponse と、、parsedHeaders、などのマージされたプロパティがparsedBody含まれます。
RetryOptions	失敗した要求を再試行する方法を制御するオプション。
SequenceMapper	配列を記述するマッパー。
SequenceMapperType	マップされた値のシーケンスを解析する方法を説明するマッパーを作成するのに役立ちます。
SerializerOptions	xml パーサーとビルダーの動作を制御するためのオプション。
ServiceCallback
ServiceClientCredentials	送信要求に署名するメソッドを signRequest 持つオブジェクトまたはクラスを表します (たとえば、 ヘッダーを Authorization 設定します)。
ServiceClientOptions	クライアントの作成時に指定するオプション。
SimpleMapperType	単純なマッパーの型。
TokenCredential	認証トークンを提供できる資格情報を表します。
TracingPolicyOptions	トレース ポリシーをカスタマイズするためのオプション。
UrlParameterValue	URL パラメーター値を表すインターフェイス。
UserAgentOptions	送信要求にユーザー エージェントの詳細を追加するためのオプション。
WebResourceLike	リモート サーバーに対して行われる HTTP 要求の説明。

型エイリアス

Authenticator	チャレンジを受け取り、文字列トークンを使用して promise を解決する関数。
CommonRequestInfo	を fetch()呼び出すときに使用される文字列 URL。
CommonRequestInit	送信 HTTP 要求に関する情報を格納している オブジェクト。
CommonResponse	受信 HTTP 応答に関する情報を格納している オブジェクト。
HttpMethods	サポートされている HTTP メソッドの一覧。
HttpRequestBody	使用可能な HTTP 要求本文の種類
Mapper	マッパーは、ライブラリで使用されるデータ モデルの定義です。 これらのデータ モデルは、応答またはパラメーターの Operation または Client 定義の一部です。
MapperType	マッパーの種類。 既知のマッパーが含まれます。
ParameterPath	特定のオブジェクト データ ソース内の特定のプロパティにアクセスする方法を説明するパス。 単一のプロパティ名、入れ子になったプロパティ名を表す配列、または複雑なオブジェクト値の場合はパスを持つ複数の名前付きプロパティのセットを指定できます。
ProxyOptions	将来使用するための ProxySettings の エイリアス。
RawHttpHeaders	単純な JSON オブジェクトとして表される HttpHeaders コレクション。
RequestPolicyFactory	指定された nextPolicy を使用する要求ごとに新しい RequestPolicy を作成します。
TelemetryInfo	テレメトリ情報。 User-Agent文字列内に含めるキーと値のペア。
TransferProgressEvent	アップロードまたはダウンロードの進行状況に応じて発生します。

列挙型

HttpPipelineLogLevel	HttpPipelineLogger で使用できるさまざまなレベルのログ。
QueryCollectionFormat	クエリ パラメーター値の値の配列を結合するために使用される形式。
RetryMode	再試行モードの種類について説明します。 現在、指数関数のみをサポートしています。

機能

applyMixins(unknown, any[])	sourceCtors のプロトタイプのプロパティを targetCtor のプロトタイプに適用します
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	要求のヘッダーにベアラー トークンを適用する RequestPolicy の新しいファクトリを Authorization 作成します。
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	指定されたオプションに基づいて HTTP パイプラインを作成します。
delay(number, DelayOptions)	timeInMs ミリ秒後に promise を解決する setTimeout のラッパー。
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	HTTP パイプラインを通過する際に HTTP 要求本文をシリアル化する新しいシリアル化 RequestPolicyCreator を作成します。
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	JSON または XML として解析するコンテンツ タイプの特定のセットを指定すると、HTTP 応答を使用して、要求の OperationSpec によって定義された結果オブジェクトが生成されます。
disableResponseDecompressionPolicy()	のインスタンス <xref:DisableResponseDecompressionPolicy>を作成するために使用できる要求ポリシー ファクトリを返します。
encodeUri(string)	URI をエンコードします。
executePromisesSequentially(any[], unknown)	promise の配列を順番に実行します。 このメソッドのインスピレーションは次のとおりです。 https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html 約束に関する素晴らしいブログ!
exponentialRetryPolicy(number, number, number)	最大再試行時間間隔が指定されている限り、構成された回数だけ要求を再試行するポリシー。各再試行は最後の時刻よりも長く待機します。
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	HttpOperationResponse を正規化された HTTP 応答オブジェクト (RestResponse) に解析します。
generateClientRequestIdPolicy(string)	送信要求に一意の要求 ID を割り当てるポリシーを作成します。
generateUuid()	生成された UUID
getDefaultProxySettings(string)	プロキシ サーバーの特定の URL を に ProxySettings 変換するか、現在の環境から取得 ProxySettings を試みます (渡されない場合)。
getDefaultUserAgentValue()	ユーザー エージェントを生成するための既定の方法。 このパッケージの静的情報と、ランタイムから使用可能なシステム情報を使用します。
isDuration(string)	指定された文字列が ISO 8601 形式であるかどうかを示します。
isTokenCredential(unknown)	オブジェクトをテストして、TokenCredential を実装するかどうかを判断します。
isValidUuid(string)	指定された uuid を文字列として検証します
keepAlivePolicy(KeepAliveOptions)	今後の要求で HTTP 接続を維持するかどうかを制御するポリシーを作成します。
logPolicy(LogPolicyOptions)	送信要求と受信応答に関する情報をログに記録するポリシーを作成します。
operationOptionsToRequestOptionsBase<T>(T)	OperationOptions を RequestOptionsBase に変換します
parseXML(string, SerializerOptions)	指定された XML 文字列を JSON に変換します
promiseToCallback(Promise<any>)	Promise をコールバックに変換します。
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Promise をサービス コールバックに変換します。
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	すべての要求にプロキシ設定を適用できるようにするポリシー。 静的設定が渡されない場合は、HTTPS_PROXYまたはHTTP_PROXY環境変数から取得されます。
redirectPolicy(number)	リダイレクト ポリシーを作成します。これは、応答が "location" ヘッダーと 300 から 307 の間の状態コードで到着した場合に、要求を新しい宛先に繰り返し送信します。
serializeObject(unknown)	バイナリ情報を含む可能性があるオブジェクトをプレーン オブジェクト、配列、または文字列にシリアル化するユーティリティ関数。
signingPolicy(ServiceClientCredentials)	指定authenticationProvidersignRequestされた の メソッドを呼び出して送信要求に署名するポリシーを作成します。
stringifyXML(unknown, SerializerOptions)	指定された JSON オブジェクトを XML 文字列に変換します
stripRequest(WebResourceLike)	Authorization ヘッダーを含まない Http 要求の削除されたバージョンを返します。
stripResponse(HttpOperationResponse)	本文、ヘッダー、および状態のみを含む Http 応答の削除されたバージョンを返します。
systemErrorRetryPolicy(number, number, number, number)	システム エラーが発生したときに再試行するポリシー。コード "ETIMEDOUT"、"ESOCKETTIMEDOUT"、"ECONNREFUSED"、"ECONNRESET"、または "ENOENT" で識別されます。
throttlingRetryPolicy()	調整の理由により要求が失敗したことを応答が示した場合に要求を再送信するポリシーを作成します。 たとえば、応答にヘッダーが含まれている 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
tracingPolicy(TracingPolicyOptions)	送信要求をトレーススパンでラップするポリシーを作成します。
userAgentPolicy(TelemetryInfo)	指定された TelemetryInfo に基づいて、ユーザー エージェント ヘッダーを送信要求に追加するポリシーを返します。

関数の詳細

applyMixins(unknown, any[])

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

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

パラメーター

targetCtorParam

unknown

sourceCtors

any[]

プロパティを取得する必要があるソース オブジェクトの配列。

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

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

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

パラメーター

credential

TokenCredential

ベアラー トークンを指定できる TokenCredential 実装。

scopes

string | string[]

ベアラー トークンが適用されるスコープ。

戻り値

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

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

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

パラメーター

pipelineOptions

InternalPipelineOptions

SDK クライアントの HTTP パイプラインでポリシーを構成するために使用されるオプションを定義します。

authPolicyFactory

RequestPolicyFactory

署名要求に使用するオプションの認証ポリシー ファクトリ。

戻り値

ServiceClientOptions

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

delay(number, DelayOptions)

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

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

パラメーター

timeInMs

number

遅延するミリ秒数。

options

DelayOptions

遅延のオプション - 現在中止オプション

戻り値

Promise<void>

timeInMs の後に解決される Promise

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

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

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

パラメーター

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

戻り値

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

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

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

パラメーター

jsonContentTypes

string[]

本文を JSON として解析するための応答コンテンツ タイプ。

xmlContentTypes

string[]

本文を XML として解析するための応答コンテンツ タイプ。

response

HttpOperationResponse

パイプラインからの HTTP 応答。

options

SerializerOptions

シリアライザーへのオプション。主に、必要に応じて XML パーサーを構成するためのオプション。

戻り値

Promise<HttpOperationResponse>

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

disableResponseDecompressionPolicy()

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

function disableResponseDecompressionPolicy(): RequestPolicyFactory

戻り値

RequestPolicyFactory

encodeUri(string)

URI をエンコードします。

function encodeUri(uri: string): string

パラメーター

uri

string

エンコードする URI。

戻り値

string

エンコードされた URI。

executePromisesSequentially(any[], unknown)

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

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

パラメーター

promiseFactories

any[]

promise ファクトリの配列 (promise を返す関数)

kickstart

unknown

Promise チェーンを開始するために使用される最初の promise への入力。 指定されていない場合、promise チェーンは undefined で始まります。

戻り値

Promise<any>

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

exponentialRetryPolicy(number, number, number)

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

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

パラメーター

retryCount

number

[最大再試行回数]。

retryInterval

number

再試行の基本時間。

maxRetryInterval

number

再試行の間に待機する最大時間。

戻り値

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

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

パラメーター

_response

HttpOperationResponse

http 応答のラッパー オブジェクト。

responseSpec

undefined | OperationResponse

応答プロパティを解析する方法のマッパー。

戻り値

RestResponse

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

generateClientRequestIdPolicy(string)

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

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

パラメーター

requestIdHeaderName

string

要求に一意の ID を割り当てるときに使用するヘッダーの名前。

戻り値

RequestPolicyFactory

generateUuid()

生成された UUID

function generateUuid(): string

戻り値

string

RFC4122 v4 UUID。

getDefaultProxySettings(string)

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

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

パラメーター

proxyUrl

string

プロキシの URL

戻り値

ProxySettings | undefined

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

getDefaultUserAgentValue()

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

function getDefaultUserAgentValue(): string

戻り値

string

isDuration(string)

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

function isDuration(value: string): boolean

パラメーター

value

string

ISO 8601 期間形式で検証される値。

戻り値

boolean

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

isTokenCredential(unknown)

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

function isTokenCredential(credential: unknown): credential

パラメーター

credential

unknown

テスト対象の TokenCredential を想定しています。

戻り値

credential

isValidUuid(string)

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

function isValidUuid(uuid: string): boolean

パラメーター

uuid

string

検証する必要がある文字列としての uuid

戻り値

boolean

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

keepAlivePolicy(KeepAliveOptions)

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

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

パラメーター

keepAliveOptions

KeepAliveOptions

キープ アライブ オプション。 既定では、HTTP 接続は今後の要求に対して維持されます。

戻り値

RequestPolicyFactory

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

logPolicy(LogPolicyOptions)

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

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

パラメーター

loggingOptions

LogPolicyOptions

ログ オプション。

戻り値

RequestPolicyFactory

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

operationOptionsToRequestOptionsBase<T>(T)

OperationOptions を RequestOptionsBase に変換します

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

パラメーター

opts

T

RequestOptionsBase に変換する OperationOptions オブジェクト

戻り値

RequestOptionsBase

parseXML(string, SerializerOptions)

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

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

パラメーター

str

string

JSON に解析される XML コンテンツを含む文字列

opts

SerializerOptions

指定された xml 文字列の解析を制御するオプション

戻り値

Promise<any>

promiseToCallback(Promise<any>)

警告

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

generated code should instead depend on responseToBody

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

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

パラメーター

promise

Promise<any>

コールバックに変換される Promise

戻り値

(cb: Function) => void

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

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

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

パラメーター

promise

Promise<HttpOperationResponse>

サービス コールバックに変換される HttpOperationResponse の Promise

戻り値

(cb: ServiceCallback<T>) => void

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

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

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

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

パラメーター

proxySettings

ProxySettings

各要求で使用する ProxySettings。

options

{ customNoProxyList?: string[] }

カスタム NO_PROXY パターンなど、追加の設定

戻り値

RequestPolicyFactory

redirectPolicy(number)

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

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

パラメーター

maximumRetries

number

従うリダイレクトの最大数。

戻り値

RequestPolicyFactory

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

serializeObject(unknown)

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

function serializeObject(toSerialize: unknown): any

パラメーター

toSerialize

unknown

戻り値

any

signingPolicy(ServiceClientCredentials)

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

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

パラメーター

authenticationProvider

ServiceClientCredentials

認証プロバイダー。

戻り値

RequestPolicyFactory

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

stringifyXML(unknown, SerializerOptions)

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

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

パラメーター

obj

unknown

XML 文字列に変換される JSON オブジェクト

opts

SerializerOptions

指定された JSON オブジェクトの解析を制御するオプション

戻り値

string

stripRequest(WebResourceLike)

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

function stripRequest(request: WebResourceLike): WebResourceLike

パラメーター

request

WebResourceLike

Http Request オブジェクト

戻り値

WebResourceLike

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

stripResponse(HttpOperationResponse)

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

function stripResponse(response: HttpOperationResponse): any

パラメーター

response

HttpOperationResponse

Http 応答

戻り値

any

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

systemErrorRetryPolicy(number, number, number, number)

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

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

パラメーター

retryCount

number

[最大再試行回数]。

retryInterval

number

クライアントの再試行間隔 (ミリ秒単位)。

minRetryInterval

number

最小再試行間隔 (ミリ秒単位)。

maxRetryInterval

number

最大再試行間隔 (ミリ秒単位)。

戻り値

RequestPolicyFactory

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

throttlingRetryPolicy()

調整の理由により要求が失敗したことを応答が示した場合に要求を再送信するポリシーを作成します。 たとえば、応答にヘッダーが含まれている 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

戻り値

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

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

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

パラメーター

tracingOptions

TracingPolicyOptions

トレース オプション。

戻り値

RequestPolicyFactory

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

userAgentPolicy(TelemetryInfo)

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

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

パラメーター

userAgentData

TelemetryInfo

テレメトリ情報。

戻り値

RequestPolicyFactory

新しい <xref:UserAgentPolicy>。