WebResource interface

パッケージ:

@azure/storage-blob

リモート サーバーに対して行われる HTTP 要求の説明。

プロパティ

abortSignal	中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
body	要求の HTTP 本文の内容。
decompressResponse	Accept-Encoding ヘッダーに従って応答を展開するかどうか (ノードフェッチのみ)
formData	要求本文の作成に使用されるフォーム データ。
headers	要求を行うときに使用する HTTP ヘッダー。
keepAlive	接続を再利用する必要がある場合。
method	要求を行うときに使用する HTTP メソッド。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
proxySettings	プロキシの構成。
query	オブジェクトとして表されるクエリ文字列。
requestId	要求の一意の識別子。 ログ記録とトレースに使用されます。
streamResponseBody	HttpOperationResponse の本文をストリームとして扱う必要があるかどうか。
streamResponseStatusCodes	対応する HttpOperationResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。
url	要求によってアクセスされる URL。
withCredentials	XHR 中に資格情報 (Cookie) を一緒に送信する必要がある場合。

メソッド

clone()	この要求オブジェクトを複製します。
prepare(unknown)	これは互換性を目的とした非操作であり、呼び出された場合は スローされます。
validateRequestProperties()	メソッド、url、headers["Content-Type"]、headers["accept-language"] などの必須プロパティが定義されていることを検証します。 上記のプロパティのいずれかが定義されていない場合は、エラーがスローされます。 注: これは互換性を目的とした操作なしです。

プロパティの詳細

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

body

要求の HTTP 本文の内容。

body?: any

プロパティ値

any

decompressResponse

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

decompressResponse?: boolean

プロパティ値

boolean

formData

要求本文の作成に使用されるフォーム データ。

formData?: any

プロパティ値

any

headers

要求を行うときに使用する HTTP ヘッダー。

headers: HttpHeadersLike

プロパティ値

HttpHeaders

keepAlive

接続を再利用する必要がある場合。

keepAlive?: boolean

プロパティ値

boolean

method

要求を行うときに使用する HTTP メソッド。

method: HttpMethods

プロパティ値

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

proxySettings

プロキシの構成。

proxySettings?: ProxySettings

プロパティ値

ProxySettings

query

オブジェクトとして表されるクエリ文字列。

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

プロパティ値

{[key: string]: any}

requestId

要求の一意の識別子。 ログ記録とトレースに使用されます。

requestId: string

プロパティ値

string

streamResponseBody

警告

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

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

プロパティ値

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

プロパティ値

Set<number>

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

timeout: number

プロパティ値

number

url

要求によってアクセスされる URL。

url: string

プロパティ値

string

withCredentials

XHR 中に資格情報 (Cookie) を一緒に送信する必要がある場合。

withCredentials: boolean

プロパティ値

boolean

メソッドの詳細

clone()

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

function clone(): WebResourceLike

戻り値

WebResource

prepare(unknown)

これは互換性を目的とした非操作であり、呼び出された場合は スローされます。

function prepare(options: unknown): WebResourceLike

パラメーター

options

unknown

戻り値

WebResource

validateRequestProperties()

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

function validateRequestProperties()