PipelineRequest interface

Paquete:

@azure/core-rest-pipeline

Metadatos sobre una solicitud realizada por la canalización.

Propiedades

abortSignal	Se usa para anular la solicitud más adelante.
agent	SOLO NODEJS Una opción de solo nodo para proporcionar un http.Agent/https.Agentpersonalizado. No hace nada cuando se ejecuta en el explorador.
allowInsecureConnection	Establézcalo en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
body	El contenido del cuerpo HTTP (si existe)
disableKeepAlive	Si no se debe reutilizar la conexión.
enableBrowserStreams	SOLO EXPLORADOR Una opción de solo explorador para habilitar secuencias del explorador. Si se establece esta opción y una respuesta es una secuencia, la respuesta tendrá una propiedad browserStream en lugar de blobBody que no estará definida. El valor predeterminado es false
formData	Para simular una publicación de formulario del explorador
headers	Encabezados HTTP que se van a usar al realizar la solicitud.
method	Método HTTP que se va a usar al realizar la solicitud.
multipartBody	Cuerpo de una solicitud de varias partes.
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 del proxy.
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í invalidarán cualquier propiedad de los mismos nombres cuando HttpClient envíe la solicitud.
streamResponseStatusCodes	Lista de códigos de estado de respuesta cuyo cuerpo pipelineResponse correspondiente debe tratarse como una secuencia. Cuando streamResponseStatusCodes contiene el valor Number.POSITIVE_INFINITY cualquier estado se trataría 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. El valor predeterminado es 0, que deshabilita el tiempo de espera.
tlsSettings	Configuración para configurar la autenticación TLS
tracingOptions	Opciones de seguimiento que se usarán para los intervalos creados.
url	Dirección URL a la que se va a realizar la solicitud.
withCredentials	Indica si el agente de usuario debe enviar cookies desde el otro dominio en el caso de solicitudes entre orígenes. 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

agent

SOLO NODEJS

Una opción de solo nodo para proporcionar un http.Agent/https.Agentpersonalizado. No hace nada cuando se ejecuta en el explorador.

agent?: Agent

Valor de propiedad

Agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor de propiedad

boolean

body

El contenido del cuerpo HTTP (si existe)

body?: RequestBodyType

Valor de propiedad

RequestBodyType

disableKeepAlive

Si no se debe reutilizar la conexión.

disableKeepAlive?: boolean

Valor de propiedad

boolean

enableBrowserStreams

SOLO EXPLORADOR

Una opción de solo explorador para habilitar secuencias del explorador. Si se establece esta opción y una respuesta es una secuencia, la respuesta tendrá una propiedad browserStream en lugar de blobBody que no estará definida.

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 van a usar 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

multipartBody

Cuerpo de una solicitud de varias partes.

multipartBody?: MultipartRequestBody

Valor de propiedad

MultipartRequestBody

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 del 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

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í invalidarán cualquier propiedad de los mismos nombres cuando HttpClient envíe la solicitud.

requestOverrides?: Record<string, unknown>

Valor de propiedad

Record<string, unknown>

streamResponseStatusCodes

Lista de códigos de estado de respuesta cuyo cuerpo pipelineResponse correspondiente debe tratarse como una secuencia. Cuando streamResponseStatusCodes contiene el valor Number.POSITIVE_INFINITY cualquier estado se trataría 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. El valor predeterminado es 0, que deshabilita el tiempo de espera.

timeout: number

Valor de propiedad

number

tlsSettings

Configuración para configurar la autenticación TLS

tlsSettings?: TlsSettings

Valor de propiedad

TlsSettings

tracingOptions

Opciones de seguimiento que se usarán para los intervalos creados.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

url

Dirección URL a la que se va a realizar la solicitud.

url: string

Valor de propiedad

string

withCredentials

Indica si el agente de usuario debe enviar cookies desde el otro dominio en el caso de solicitudes entre orígenes. El valor predeterminado es false.

withCredentials: boolean

Valor de propiedad

boolean