WebResource interface

Paquete:

@azure/storage-blob

Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.

Propiedades

abortSignal	Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y la espera de una respuesta.
body	Contenido del cuerpo HTTP de la solicitud.
decompressResponse	Si se va a descomprimir o no la respuesta según Accept-Encoding encabezado (solo captura de nodo)
formData	Datos del formulario, que se usan para compilar el cuerpo de la solicitud.
headers	Encabezados HTTP que se van a usar al realizar la solicitud.
keepAlive	Si se debe reutilizar la conexión.
method	Método HTTP que se va a usar al realizar la solicitud.
onDownloadProgress	Devolución de llamada que se activa tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se activa tras el progreso de la carga.
proxySettings	Configuración de proxy.
query	Cadena de consulta representada como un objeto .
requestId	Identificador único de la solicitud. Se usa para el registro y el seguimiento.
streamResponseBody	Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.
streamResponseStatusCodes	Una lista de códigos de estado de respuesta cuyo cuerpo HttpOperationResponse correspondiente debe tratarse como una secuencia.
timeout	El número de milisegundos que una solicitud puede realizar antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .
url	Dirección URL a la que accede la solicitud.
withCredentials	Si las credenciales (cookies) se deben enviar durante una XHR.

Métodos

clone()	Clone este objeto de solicitud.
prepare(unknown)	Se trata de una operación no operativa con fines de compatibilidad y se producirá si se llama a .
validateRequestProperties()	Valida que se definen las propiedades necesarias, como method, url, headers["Content-Type"], headers["accept-language"]. Se producirá un error si no se define una de las propiedades mencionadas anteriormente. Nota: esta operación no es op para propósitos de compatibilidad.

Detalles de las propiedades

abortSignal

Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y la espera de una respuesta.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

body

Contenido del cuerpo HTTP de la solicitud.

body?: any

Valor de propiedad

any

decompressResponse

Si se va a descomprimir o no la respuesta según Accept-Encoding encabezado (solo captura de nodo)

decompressResponse?: boolean

Valor de propiedad

boolean

formData

Datos del formulario, que se usan para compilar el cuerpo de la solicitud.

formData?: any

Valor de propiedad

any

headers

Encabezados HTTP que se van a usar al realizar la solicitud.

headers: HttpHeadersLike

Valor de propiedad

HttpHeaders

keepAlive

Si se debe reutilizar la conexión.

keepAlive?: boolean

Valor de propiedad

boolean

method

Método HTTP que se va a usar al realizar la solicitud.

method: HttpMethods

Valor de propiedad

HttpMethods

onDownloadProgress

Devolución de llamada que se activa tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

onUploadProgress

Devolución de llamada que se activa tras el progreso de la carga.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

proxySettings

Configuración de proxy.

proxySettings?: ProxySettings

Valor de propiedad

ProxySettings

query

Cadena de consulta representada como un objeto .

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

Valor de propiedad

{[key: string]: any}

requestId

Identificador único de la solicitud. Se usa para el registro y el seguimiento.

requestId: string

Valor de propiedad

string

streamResponseBody

Advertencia

Esta API ya está en desuso.

Use streamResponseStatusCodes property instead.

Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.

streamResponseBody?: boolean

Valor de propiedad

boolean

streamResponseStatusCodes

Una lista de códigos de estado de respuesta cuyo cuerpo HttpOperationResponse correspondiente debe tratarse como una secuencia.

streamResponseStatusCodes?: Set<number>

Valor de propiedad

Set<number>

timeout

El número de milisegundos que una solicitud puede realizar antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .

timeout: number

Valor de propiedad

number

url

Dirección URL a la que accede la solicitud.

url: string

Valor de propiedad

string

withCredentials

Si las credenciales (cookies) se deben enviar durante una XHR.

withCredentials: boolean

Valor de propiedad

boolean

Detalles del método

clone()

Clone este objeto de solicitud.

function clone(): WebResourceLike

Devoluciones

WebResource

prepare(unknown)

Se trata de una operación no operativa con fines de compatibilidad y se producirá si se llama a .

function prepare(options: unknown): WebResourceLike

Parámetros

options

unknown

Devoluciones

WebResource

validateRequestProperties()

Valida que se definen las propiedades necesarias, como method, url, headers["Content-Type"], headers["accept-language"]. Se producirá un error si no se define una de las propiedades mencionadas anteriormente. Nota: esta operación no es op para propósitos de compatibilidad.

function validateRequestProperties()