Compartir a través de

WebResource class

  • Referencia
Paquete:
@azure/core-http

Crea un nuevo objeto WebResource.

Esta clase proporciona una abstracción sobre una llamada REST, ya que es independiente de la biblioteca o implementación y ajusta las propiedades necesarias para iniciar una solicitud.

Constructores

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

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

Cuerpo 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.
keepAlive

Si se deben mantener activas las conexiones HTTP a lo largo de las solicitudes.
method

Método HTTP que se va a usar.
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.
operationResponseGetter

Función que devuelve el operationResponse adecuado para la combinación OperationSpec y HttpOperationResponse especificada. Si no está definido, se usará una búsqueda de código de estado simple.
operationSpec

Especificación de la solicitud HTTP.
proxySettings

Qué proxy se va a usar, si es necesario.
query

Consulta agregada a la dirección URL.
requestId

Identificador único de la solicitud saliente.
shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si no está definido, se debe deserializar HttpOperationResponse.
spanOptions

Seguimiento: opciones usadas para crear un intervalo cuando el seguimiento está habilitado.
streamResponseBody

Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.
streamResponseStatusCodes

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

Cuánto tiempo se debe esperar en milisegundos antes de anular la solicitud.
tracingContext

Seguimiento: contexto usado al crear intervalos.
url

Dirección URL de la solicitud saliente.
withCredentials

Si se envían credenciales (a través de cookies, encabezados de autorización o certificados de cliente TLS) al realizar una solicitud en el explorador a un destino entre sitios.

Métodos

clone()

Clone este objeto de solicitud HTTP de WebResource.
prepare(RequestPrepareOptions)

Prepara la solicitud.
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.

Detalles del constructor

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

Parámetros

url

string

method
HttpMethods
body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

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>

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

Cuerpo 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.

headers: HttpHeadersLike

Valor de propiedad

HttpHeadersLike

keepAlive

Si se deben mantener activas las conexiones HTTP a lo largo de las solicitudes.

keepAlive?: boolean

Valor de propiedad

boolean

method

Método HTTP que se va a usar.

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

operationResponseGetter

Función que devuelve el operationResponse adecuado para la combinación OperationSpec y HttpOperationResponse especificada. Si no está definido, se usará una búsqueda de código de estado simple.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Valor de propiedad

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Especificación de la solicitud HTTP.

operationSpec?: OperationSpec

Valor de propiedad

OperationSpec

proxySettings

Qué proxy se va a usar, si es necesario.

proxySettings?: ProxySettings

Valor de propiedad

ProxySettings

query

Consulta agregada a la dirección URL.

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

Valor de propiedad

{[key: string]: any}

requestId

Identificador único de la solicitud saliente.

requestId: string

Valor de propiedad

string

shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si no está definido, se debe deserializar HttpOperationResponse.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Valor de propiedad

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Seguimiento: opciones usadas para crear un intervalo cuando el seguimiento está habilitado.

spanOptions?: SpanOptions

Valor de propiedad

@azure/core-tracing.SpanOptions

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 cuyo cuerpo HttpOperationResponse correspondiente debe tratarse como una secuencia.

streamResponseStatusCodes?: Set<number>

Valor de propiedad

Set<number>

timeout

Cuánto tiempo se debe esperar en milisegundos antes de anular la solicitud.

timeout: number

Valor de propiedad

number

tracingContext

Seguimiento: contexto usado al crear intervalos.

tracingContext?: Context

Valor de propiedad

@azure/core-tracing.Context

url

Dirección URL de la solicitud saliente.

url: string

Valor de propiedad

string

withCredentials

Si se envían credenciales (a través de cookies, encabezados de autorización o certificados de cliente TLS) al realizar una solicitud en el explorador a un destino entre sitios.

withCredentials: boolean

Valor de propiedad

boolean

Detalles del método

clone()

Clone este objeto de solicitud HTTP de WebResource.

function clone(): WebResource

Devoluciones

WebResource

Clon de este objeto de solicitud HTTP de WebResource.

prepare(RequestPrepareOptions)

Prepara la solicitud.

function prepare(options: RequestPrepareOptions): WebResource

Parámetros

options
RequestPrepareOptions

Opciones que se proporcionan para preparar la solicitud.

Devoluciones

WebResource

Devuelve el objeto WebResource (solicitud HTTP) preparado que debe proporcionarse a la canalización de solicitudes.

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.

function validateRequestProperties()