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 esperar una respuesta.
agent	SOLO NODEJS Una opción de solo nodo para proporcionar un http.Agent/https.Agentpersonalizado. NOTA: Normalmente, esta debe ser una instancia compartida por varias solicitudes para que se pueda reutilizar la conexión subyacente al servicio. No hace nada cuando se ejecuta en el explorador.
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, usados 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 desencadena tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se desencadena 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.
requestOverrides	Opciones adicionales para establecer en la solicitud. Esto proporciona una manera de invalidar las existentes o proporcionar propiedades de solicitud que no están declaradas. Para conocer las posibles propiedades válidas, consulte Opciones de NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback Solicitud de inicio del navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit ADVERTENCIA: Las opciones especificadas aquí anularán cualquier propiedad de los mismos nombres cuando la solicitud sea enviada por <xref:HttpClient>.
streamResponseBody	Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.
streamResponseStatusCodes	Lista de códigos de estado de respuesta cuyo cuerpo HttpOperationResponse correspondiente debe tratarse como una secuencia.
timeout	El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce un AbortError.
url	Dirección URL a la que accede la solicitud.
withCredentials	Si las credenciales (cookies) deben enviarse durante una XHR.

Métodos

clone()	Clone este objeto de solicitud.
prepare(unknown)	Se trata de un no-op 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: este no-op con fines 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 esperar una respuesta.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

agent

SOLO NODEJS

Una opción de solo nodo para proporcionar un http.Agent/https.Agentpersonalizado. NOTA: Normalmente, esta debe ser una instancia compartida por varias solicitudes para que se pueda reutilizar la conexión subyacente al servicio. No hace nada cuando se ejecuta en el explorador.

agent?: Agent

Valor de propiedad

Agent

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, usados 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 desencadena tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

onUploadProgress

Devolución de llamada que se desencadena 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

requestOverrides

Opciones adicionales para establecer en la solicitud. Esto proporciona una manera de invalidar las existentes o proporcionar propiedades de solicitud que no están declaradas.

Para conocer las posibles propiedades válidas, consulte

• Opciones de NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback
• Solicitud de inicio del navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

ADVERTENCIA: Las opciones especificadas aquí anularán cualquier propiedad de los mismos nombres cuando la solicitud sea enviada por <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

Valor de propiedad

Record<string, unknown>

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

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 puede tomar una solicitud antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce un AbortError.

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) deben enviarse 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 un no-op 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: este no-op con fines de compatibilidad.

function validateRequestProperties()