Compartir a través de

PipelineRequestOptions interface

  • Referencia
Paquete:
@azure/core-rest-pipeline

Configuración para inicializar una solicitud. Casi equivalente a Partial, pero la dirección URL es obligatoria.

Propiedades

abortSignal

Se usa para anular la solicitud más adelante.
allowInsecureConnection

Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
body

Contenido del cuerpo HTTP (si existe)
disableKeepAlive

Si la conexión no se debe reutilizar.
enableBrowserStreams

SOLO EXPLORADOR

Una opción solo del explorador para habilitar el uso de Streams API. Si se establece esta opción y se usa el streaming (consulte streamResponseStatusCodes), la respuesta tendrá una propiedad browserStream en lugar de blobBody la cual no se definirá.

El valor predeterminado es False
formData

Para simular una publicación de formulario del explorador
headers

Encabezados HTTP que se usarán al realizar la solicitud.
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.
requestId

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

Lista de códigos de estado de respuesta cuyo cuerpo pipelineResponse 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 una AbortError excepción . El valor predeterminado es 0, que deshabilita el tiempo de espera.
tracingOptions

Opciones usadas para crear un intervalo cuando el seguimiento está habilitado.
url

Dirección URL en la que se va a hacer la solicitud.
withCredentials

Si las credenciales (cookies) deben enviarse durante una XHR. El valor predeterminado es "false".

Detalles de las propiedades

abortSignal

Se usa para anular la solicitud más adelante.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

allowInsecureConnection

Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.

allowInsecureConnection?: boolean

Valor de propiedad

boolean

body

Contenido del cuerpo HTTP (si existe)

body?: RequestBodyType

Valor de propiedad

RequestBodyType

disableKeepAlive

Si la conexión no se debe reutilizar.

disableKeepAlive?: boolean

Valor de propiedad

boolean

enableBrowserStreams

SOLO EXPLORADOR

Una opción solo del explorador para habilitar el uso de Streams API. Si se establece esta opción y se usa el streaming (consulte streamResponseStatusCodes), la respuesta tendrá una propiedad browserStream en lugar de blobBody la cual no se definirá.

El valor predeterminado es False

enableBrowserStreams?: boolean

Valor de propiedad

boolean

formData

Para simular una publicación de formulario del explorador

formData?: FormDataMap

Valor de propiedad

FormDataMap

headers

Encabezados HTTP que se usarán al realizar la solicitud.

headers?: HttpHeaders

Valor de propiedad

HttpHeaders

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

requestId

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

requestId?: string

Valor de propiedad

string

streamResponseStatusCodes

Lista de códigos de estado de respuesta cuyo cuerpo pipelineResponse 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 una AbortError excepción . El valor predeterminado es 0, que deshabilita el tiempo de espera.

timeout?: number

Valor de propiedad

number

tracingOptions

Opciones usadas para crear un intervalo cuando el seguimiento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

url

Dirección URL en la que se va a hacer la solicitud.

url: string

Valor de propiedad

string

withCredentials

Si las credenciales (cookies) deben enviarse durante una XHR. El valor predeterminado es "false".

withCredentials?: boolean

Valor de propiedad

boolean