WebResource class

パッケージ:: @azure/core-http

新しい WebResource オブジェクトを作成します。

このクラスは、ライブラリ/実装に依存せず、要求を開始するために必要なプロパティをラップすることで、REST 呼び出しに対する抽象化を提供します。

コンストラクター

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

プロパティ

abortSignal	中止コントローラーの信号。ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
body	要求本文。
decompressResponse	Accept-Encoding ヘッダーに従って応答を展開するかどうか (ノードフェッチのみ)
formData	フォームデータ。要求本文の構築に使用されます。
headers	HTTP ヘッダー。
keepAlive	要求全体で HTTP 接続を維持するかどうかを指定します。
method	使用する HTTP メソッド。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
operationResponseGetter	指定された OperationSpec と HttpOperationResponse の組み合わせに対して適切な OperationResponse を返す関数。これが未定義の場合は、単純な状態コード参照が使用されます。
operationSpec	HTTP 要求の指定。
proxySettings	必要に応じて、使用するプロキシ。
query	URL に追加されたクエリ。
requestId	送信要求の一意識別子。
shouldDeserialize	HttpOperationResponse を逆シリアル化する必要があるかどうか。これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
spanOptions	トレース: トレースが有効な場合にスパンを作成するために使用されるオプション。
streamResponseBody	HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。
streamResponseStatusCodes	対応する HttpOperationResponse 本文をストリームとして扱う必要がある状態コードの一覧。
timeout	要求を中止するまでの待機時間 (ミリ秒単位)。
tracingContext	トレース: スパンの作成時に使用されるコンテキスト。
url	送信要求の URL。
withCredentials	ブラウザーでクロスサイトの宛先に要求を行うときに、資格情報 (Cookie、承認ヘッダー、または TLS クライアント証明書を介して) を送信するかどうか。

メソッド

clone()	この WebResource HTTP 要求オブジェクトを複製します。
prepare(RequestPrepareOptions)	要求を準備します。
validateRequestProperties()	メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。上記のプロパティのいずれかが定義されていない場合、エラーがスローされます。

コンストラクターの詳細

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

パラメーター

url: string

method: HttpMethods

body: unknown

query: {[key: string]: any}

headers: {[key: string]: any} | HttpHeadersLike

streamResponseBody: boolean

withCredentials: boolean

abortSignal: AbortSignalLike

timeout: number

onUploadProgress: (progress: TransferProgressEvent) => void

onDownloadProgress: (progress: TransferProgressEvent) => void

proxySettings: ProxySettings

keepAlive: boolean

decompressResponse: boolean

streamResponseStatusCodes: Set<number>

プロパティの詳細

abortSignal

中止コントローラーの信号。ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

body

要求本文。

body?: any

プロパティ値

any

decompressResponse

Accept-Encoding ヘッダーに従って応答を展開するかどうか (ノードフェッチのみ)

decompressResponse?: boolean

プロパティ値

boolean

formData

フォームデータ。要求本文の構築に使用されます。

formData?: any

プロパティ値

any

headers

HTTP ヘッダー。

headers: HttpHeadersLike

プロパティ値

HttpHeadersLike

keepAlive

要求全体で HTTP 接続を維持するかどうかを指定します。

keepAlive?: boolean

プロパティ値

boolean

method

使用する HTTP メソッド。

method: HttpMethods

プロパティ値

HttpMethods

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

operationResponseGetter

指定された OperationSpec と HttpOperationResponse の組み合わせに対して適切な OperationResponse を返す関数。これが未定義の場合は、単純な状態コード参照が使用されます。

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

プロパティ値

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

HTTP 要求の指定。

operationSpec?: OperationSpec

プロパティ値

OperationSpec

proxySettings

必要に応じて、使用するプロキシ。

proxySettings?: ProxySettings

プロパティ値

ProxySettings

query

URL に追加されたクエリ。

query?: {[key: string]: any}

プロパティ値

{[key: string]: any}

requestId

送信要求の一意識別子。

requestId: string

プロパティ値

string

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

プロパティ値

boolean | (response: HttpOperationResponse) => boolean

spanOptions

トレース: トレースが有効な場合にスパンを作成するために使用されるオプション。

spanOptions?: SpanOptions

プロパティ値

@azure/core-tracing.SpanOptions

streamResponseBody

警告

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

Use streamResponseStatusCodes property instead.

HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。

streamResponseBody?: boolean

プロパティ値

boolean

streamResponseStatusCodes

対応する HttpOperationResponse 本文をストリームとして扱う必要がある状態コードの一覧。

streamResponseStatusCodes?: Set<number>

プロパティ値

Set<number>

timeout

要求を中止するまでの待機時間 (ミリ秒単位)。

timeout: number

プロパティ値

number

tracingContext

トレース: スパンの作成時に使用されるコンテキスト。

tracingContext?: Context

プロパティ値

@azure/core-tracing.Context

url

送信要求の URL。

url: string

プロパティ値

string

withCredentials

ブラウザーでクロスサイトの宛先に要求を行うときに、資格情報 (Cookie、承認ヘッダー、または TLS クライアント証明書を介して) を送信するかどうか。

withCredentials: boolean

プロパティ値

boolean

メソッドの詳細

clone()

この WebResource HTTP 要求オブジェクトを複製します。

function clone(): WebResource

戻り値

WebResource

この WebResource HTTP 要求オブジェクトの複製。

prepare(RequestPrepareOptions)

要求を準備します。

function prepare(options: RequestPrepareOptions): WebResource

パラメーター

options: RequestPrepareOptions

要求を準備するためのオプション。

戻り値

WebResource

要求パイプラインに渡す必要がある準備済みの WebResource (HTTP 要求) オブジェクトを返します。

validateRequestProperties()

メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。上記のプロパティのいずれかが定義されていない場合、エラーがスローされます。

function validateRequestProperties()

次の方法で共有

WebResource class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

パラメーター

プロパティの詳細

abortSignal

プロパティ値

body

プロパティ値

decompressResponse

プロパティ値

formData

プロパティ値

headers

プロパティ値

keepAlive

プロパティ値

method

プロパティ値

onDownloadProgress

プロパティ値

onUploadProgress

プロパティ値

operationResponseGetter

プロパティ値

operationSpec

プロパティ値

proxySettings

プロパティ値

query

プロパティ値

requestId

プロパティ値

shouldDeserialize

プロパティ値

spanOptions

プロパティ値

streamResponseBody

プロパティ値

streamResponseStatusCodes

プロパティ値

timeout

プロパティ値

tracingContext

プロパティ値

url

プロパティ値

withCredentials

プロパティ値

メソッドの詳細

clone()

戻り値

prepare(RequestPrepareOptions)

パラメーター

戻り値

validateRequestProperties()