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 (только node-fetch)
formData	Данные формы, используемые для построения текста запроса.
headers	Заголовки HTTP.
keepAlive	Следует ли поддерживать HTTP-подключения в активном состоянии во время запросов.
method	Используемый метод HTTP.
onDownloadProgress	Обратный вызов, который срабатывает при скачивании.
onUploadProgress	Обратный вызов, который срабатывает при выполнении отправки.
operationResponseGetter	Функция, которая возвращает правильный operationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если этот параметр не определен, будет использоваться простой поиск кода состояния.
operationSpec	Спецификация HTTP-запроса.
proxySettings	Какой прокси-сервер следует использовать, если это необходимо.
query	Запрос, добавленный к URL-адресу.
requestId	Уникальный идентификатор исходящего запроса.
shouldDeserialize	Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse.
spanOptions	Трассировка: параметры, используемые для создания диапазона при включенной трассировке.
streamResponseBody	Указывает, следует ли рассматривать тело HttpOperationResponse как поток.
streamResponseStatusCodes	Список кодов состояния, соответствующий текст HttpOperationResponse которого должен рассматриваться как поток.
timeout	Время ожидания в миллисекундах перед прерыванием запроса.
tracingContext	Трассировка: контекст, используемый при создании диапазонов.
url	URL-адрес исходящего запроса.
withCredentials	Следует ли отправлять учетные данные (с помощью файлов cookie, заголовков авторизации или сертификатов клиента TLS) при выполнении запроса в браузере к межсайтовой точке назначения.

Методы

clone()	Клонируйте объект HTTP-запроса WebResource.
prepare(RequestPrepareOptions)	Подготавливает запрос.
validateRequestProperties()	Проверяет, определены ли необходимые свойства, такие как method, 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 (только node-fetch)

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

Функция, которая возвращает правильный operationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если этот параметр не определен, будет использоваться простой поиск кода состояния.

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()

Клонируйте объект HTTP-запроса WebResource.

function clone(): WebResource

Возвращаемое значение

WebResource

Клон объекта HTTP-запроса WebResource.

prepare(RequestPrepareOptions)

Подготавливает запрос.

function prepare(options: RequestPrepareOptions): WebResource

Параметры

options

RequestPrepareOptions

Параметры для подготовки запроса.

Возвращаемое значение

WebResource

Возвращает подготовленный объект WebResource (HTTP-запрос), который должен быть передан конвейеру запроса.

validateRequestProperties()

Проверяет, определены ли необходимые свойства, такие как method, url, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, будет выдаваться ошибка.

function validateRequestProperties()