Share via

WebResource class

  • リファレンス
パッケージ:
@azure/storage-blob

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

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

コンストラクター

WebResource(string, HttpMethods, unknown, {[key: string]: any}, HttpHeadersLike | {[key: string]: any}, 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}, HttpHeadersLike | {[key: string]: any}, 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?: HttpHeadersLike | {[key: string]: any}, 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

HttpHeadersLike | {[key: string]: any}

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 Request) オブジェクトを返します。

validateRequestProperties()

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

function validateRequestProperties()