@azure/core-rest-pipeline package

Clases

RestError

Tipo de error personalizado para solicitudes de canalización con error.

Interfaces

AddPipelineOptions	Opciones al agregar una directiva a la canalización. Se usa para expresar dependencias en otras directivas.
Agent	Interfaz compatible con el http.Agentde NodeJS. Queremos evitar volver a exportar públicamente la interfaz real, ya que puede variar entre versiones en tiempo de ejecución.
AuthorizeRequestOnChallengeOptions	Opciones enviadas a la devolución de llamada authorizeRequestOnChallenge
AuthorizeRequestOptions	Opciones enviadas a la devolución de llamada authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Opciones para configurar auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Opciones para configurar bearerTokenAuthenticationPolicy
BodyPart	Parte del cuerpo de la solicitud en una solicitud de varias partes.
ChallengeCallbacks	Opciones para invalidar el procesamiento de evaluación continua del acceso desafíos.
CreateFileFromStreamOptions	Opciones adicionales para createFile cuando se pasa una secuencia.
CreateFileOptions	Opciones pasadas a createFile que especifican metadatos sobre el archivo.
DefaultRetryPolicyOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
ExponentialRetryPolicyOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
HttpClient	Interfaz necesaria para un cliente que realiza solicitudes HTTP en nombre de una canalización.
HttpHeaders	Representa un conjunto de encabezados HTTP en una solicitud o respuesta. Los nombres de encabezado se tratan como no distinguen mayúsculas de minúsculas.
InternalPipelineOptions	Define las opciones que se usan para configurar opciones internas de la canalización HTTP para un cliente del SDK.
KeyObject	Interfaz compatible con el tls.KeyObjectde NodeJS. Queremos evitar volver a exportar públicamente la interfaz real, ya que puede variar entre versiones en tiempo de ejecución.
LogPolicyOptions	Opciones para configurar logPolicy.
MultipartRequestBody	Cuerpo de la solicitud que consta de varias partes.
Pipeline	Representa una canalización para realizar una solicitud HTTP en una dirección URL. Las canalizaciones pueden tener varias directivas para administrar la manipulación de cada solicitud antes y después de realizarla en el servidor.
PipelineOptions	Define las opciones que se usan para configurar la canalización HTTP para un cliente del SDK.
PipelinePolicy	Una directiva de canalización manipula una solicitud a medida que recorre la canalización. Conceptualmente, es un middleware que puede modificar la solicitud antes de que se realice, así como la respuesta cuando se reciba.
PipelineRequest	Metadatos sobre una solicitud realizada por la canalización.
PipelineRequestOptions	Configuración para inicializar una solicitud. Casi equivalente a Partial, pero la dirección URL es obligatoria.
PipelineResponse	Metadatos sobre una respuesta recibida por la canalización.
PipelineRetryOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
ProxySettings	Opciones para configurar un proxy para las solicitudes salientes (soloNode.js).
PxfObject	Interfaz compatible con el tls.PxfObjectde NodeJS. Queremos evitar volver a exportar públicamente la interfaz real, ya que puede variar entre versiones en tiempo de ejecución.
RedirectPolicyOptions	Opciones para controlar las respuestas de redirección.
RestErrorOptions	Las opciones admitidas por RestError.
RetryInformation	Información proporcionada a la estrategia de reintento sobre el progreso actual de la directiva de reintento.
RetryModifiers	Propiedades que pueden modificar el comportamiento de la directiva de reintento.
RetryPolicyOptions	Opciones para el retryPolicy de
RetryStrategy	Una estrategia de reintento está pensada para definir si se reintenta o no y cómo reintentar.
SystemErrorRetryPolicyOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
TelemetryOptions	Define las opciones que se usan para configurar información de seguimiento y telemetría comunes.
ThrottlingRetryPolicyOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
TlsSettings	Representa un certificado para la autenticación TLS.
TracingPolicyOptions	Opciones para configurar la directiva de seguimiento.
UserAgentPolicyOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Alias de tipos

FormDataMap	Objeto simple que proporciona datos de formulario, como si fuera de un formulario del explorador.
FormDataValue	Cada entrada de datos de formulario puede ser una cadena, un blob o un archivo. Si desea pasar un archivo con un nombre, pero no tiene acceso a la clase File, puede usar el asistente createFile para crear uno.
HttpMethods	Métodos HTTP admitidos que se usarán al realizar solicitudes.
PipelinePhase	Las directivas se ejecutan en fases. El orden de ejecución es: Fase de serialización Directivas que no están en una fase Fase de deserialización Fase de reintento Fase de firma
RawHttpHeaders	Colección HttpHeaders representada como un objeto JSON simple.
RawHttpHeadersInput	Colección HttpHeaders para la entrada, representada como un objeto JSON simple.
RequestBodyType	Tipos de cuerpos admitidos en la solicitud. NodeJS.ReadableStream y () => NodeJS.ReadableStream es solo Node. Blob, ReadableStream y () => ReadableStream son solo el explorador.
SendRequest	Interfaz sencilla para realizar una solicitud de canalización y recibir una respuesta.
TransferProgressEvent	Se desencadena en respuesta a la carga o descarga del progreso.

Funciones

agentPolicy(Agent)	Obtiene una directiva de canalización que establece http.agent.
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Directiva de tokens externos para x-ms-authorization-auxiliary encabezado. Este encabezado se usará al crear una aplicación entre inquilinos, es posible que necesitemos controlar las solicitudes de autenticación de los recursos que se encuentran en distintos inquilinos. Puede ver documentos de ARM para ver un resumen de cómo funciona esta característica.
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Directiva que puede solicitar un token desde una implementación de TokenCredential y, a continuación, aplicarla al encabezado authorization de una solicitud como token de portador.
createDefaultHttpClient()	Cree el httpClient correcto para el entorno actual.
createEmptyPipeline()	Crea una canalización totalmente vacía. Resulta útil para probar o crear uno personalizado.
createFile(Uint8Array, string, CreateFileOptions)	Cree un objeto que implemente la interfaz File. Este objeto está pensado para pasarse a RequestBodyType.formData y no se garantiza que funcione según lo previsto en otras situaciones. Use esta función para crear un objeto File para usarlo en RequestBodyType.formData en entornos en los que el objeto File global no está disponible.
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)	Cree un objeto que implemente la interfaz File. Este objeto está pensado para pasarse a RequestBodyType.formData y no se garantiza que funcione según lo previsto en otras situaciones. Use esta función para: Cree un objeto File para su uso en RequestBodyType.formData en entornos en los que el objeto File global no está disponible. Cree un objeto similar a un archivo a partir de una secuencia legible sin leer la secuencia en memoria.
createHttpHeaders(RawHttpHeadersInput)	Crea un objeto que satisface la interfaz HttpHeaders.
createPipelineFromOptions(InternalPipelineOptions)	Cree una nueva canalización con un conjunto predeterminado de directivas personalizables.
createPipelineRequest(PipelineRequestOptions)	Crea una nueva solicitud de canalización con las opciones especificadas. Este método es permitir la configuración sencilla de los valores predeterminados y no es necesario.
decompressResponsePolicy()	Directiva para habilitar la descompresión de respuesta según Accept-Encoding encabezado https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Directiva que reintenta según tres estrategias: Cuando el servidor envía una respuesta 429 con un encabezado Retry-After. Cuando hay errores en la capa de transporte subyacente (por ejemplo, errores de búsqueda de DNS). O bien, si se produce un error en la solicitud saliente, volverá a intentarlo con un retraso exponencialmente creciente.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Directiva que intenta reintentar solicitudes al introducir un retraso exponencialmente creciente.
formDataPolicy()	Directiva que codifica FormData en la solicitud en el cuerpo.
getDefaultProxySettings(string)	Este método convierte una dirección URL de proxy en ProxySettings para su uso con ProxyPolicy. Si no se proporciona ningún argumento, intenta analizar una dirección URL de proxy de las variables de entorno HTTPS_PROXY o HTTP_PROXY.
isRestError(unknown)	Typeguard para RestError
logPolicy(LogPolicyOptions)	Directiva que registra todas las solicitudes y respuestas.
multipartPolicy()	Directiva de canalización para solicitudes de varias partes
ndJsonPolicy()	ndJsonPolicy es una directiva que se usa para controlar la configuración de mantenimiento activo para cada solicitud.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Directiva que permite aplicar una configuración de proxy a todas las solicitudes. Si no se pasa la configuración estática, se recuperarán de las variables de entorno HTTPS_PROXY o HTTP_PROXY.
redirectPolicy(RedirectPolicyOptions)	Directiva para seguir los encabezados de ubicación del servidor para admitir el redireccionamiento del lado servidor. En el explorador, esta directiva no se usa.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy es una directiva genérica para habilitar las solicitudes de reintento cuando se cumplen determinadas condiciones.
setClientRequestIdPolicy(string)	Cada PipelineRequest obtiene un identificador único tras la creación. Esta directiva pasa ese identificador único a través de un encabezado HTTP para permitir una mejor telemetría y seguimiento.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Directiva de reintento que busca específicamente controlar errores en la capa de transporte subyacente (por ejemplo, errores de búsqueda dns) en lugar de códigos de error que se pueden reintentar desde el propio servidor.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Directiva que reintenta cuando el servidor envía una respuesta 429 con un encabezado Retry-After. Para obtener más información, consulte https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits y https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Obtiene una directiva de canalización que agrega el certificado de cliente al agente HttpClient para la autenticación.
tracingPolicy(TracingPolicyOptions)	Una directiva sencilla para crear intervalos de OpenTelemetry para cada solicitud realizada por la canalización que tiene SpanOptions con un elemento primario. Las solicitudes realizadas sin un intervalo primario no se registrarán.
userAgentPolicy(UserAgentPolicyOptions)	Directiva que establece el encabezado User-Agent (o equivalente) para reflejar la versión de la biblioteca.

Detalles de la función

agentPolicy(Agent)

Obtiene una directiva de canalización que establece http.agent.

function agentPolicy(agent?: Agent): PipelinePolicy

Parámetros

agent

Agent

Devoluciones

PipelinePolicy

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Directiva de tokens externos para x-ms-authorization-auxiliary encabezado. Este encabezado se usará al crear una aplicación entre inquilinos, es posible que necesitemos controlar las solicitudes de autenticación de los recursos que se encuentran en distintos inquilinos. Puede ver documentos de ARM para ver un resumen de cómo funciona esta característica.

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parámetros

options

AuxiliaryAuthenticationHeaderPolicyOptions

Devoluciones

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Directiva que puede solicitar un token desde una implementación de TokenCredential y, a continuación, aplicarla al encabezado authorization de una solicitud como token de portador.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parámetros

options

BearerTokenAuthenticationPolicyOptions

Devoluciones

PipelinePolicy

createDefaultHttpClient()

Cree el httpClient correcto para el entorno actual.

function createDefaultHttpClient(): HttpClient

Devoluciones

HttpClient

createEmptyPipeline()

Crea una canalización totalmente vacía. Resulta útil para probar o crear uno personalizado.

function createEmptyPipeline(): Pipeline

Devoluciones

Pipeline

createFile(Uint8Array, string, CreateFileOptions)

Cree un objeto que implemente la interfaz File. Este objeto está pensado para pasarse a RequestBodyType.formData y no se garantiza que funcione según lo previsto en otras situaciones.

Use esta función para crear un objeto File para usarlo en RequestBodyType.formData en entornos en los que el objeto File global no está disponible.

function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File

Parámetros

content

Uint8Array

el contenido del archivo como Uint8Array en memoria.

name

string

el nombre del archivo.

options

CreateFileOptions

metadatos opcionales sobre el archivo, por ejemplo, nombre de archivo, tamaño de archivo, tipo MIME.

Devoluciones

File

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

Cree un objeto que implemente la interfaz File. Este objeto está pensado para pasarse a RequestBodyType.formData y no se garantiza que funcione según lo previsto en otras situaciones.

Use esta función para:

• Cree un objeto File para su uso en RequestBodyType.formData en entornos en los que el objeto File global no está disponible.
• Cree un objeto similar a un archivo a partir de una secuencia legible sin leer la secuencia en memoria.

function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

Parámetros

stream

() => ReadableStream<Uint8Array> | ReadableStream

el contenido del archivo como devolución de llamada que devuelve una secuencia. Cuando se pasa un objeto File mediante createFile en el mapa de datos del formulario de una solicitud, la secuencia no se leerá en la memoria y, en su lugar, se transmitirá cuando se realice la solicitud. En caso de reintento, la secuencia debe leerse de nuevo, por lo que esta devolución de llamada DEBE devolver una secuencia nueva si es posible.

name

string

el nombre del archivo.

options

CreateFileFromStreamOptions

metadatos opcionales sobre el archivo, por ejemplo, nombre de archivo, tamaño de archivo, tipo MIME.

Devoluciones

File

createHttpHeaders(RawHttpHeadersInput)

Crea un objeto que satisface la interfaz HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parámetros

rawHeaders

RawHttpHeadersInput

Objeto simple que representa encabezados iniciales

Devoluciones

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Cree una nueva canalización con un conjunto predeterminado de directivas personalizables.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parámetros

options

InternalPipelineOptions

Opciones para configurar una canalización personalizada.

Devoluciones

Pipeline

createPipelineRequest(PipelineRequestOptions)

Crea una nueva solicitud de canalización con las opciones especificadas. Este método es permitir la configuración sencilla de los valores predeterminados y no es necesario.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parámetros

options

PipelineRequestOptions

Opciones para crear la solicitud con.

Devoluciones

PipelineRequest

decompressResponsePolicy()

Directiva para habilitar la descompresión de respuesta según Accept-Encoding encabezado https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Devoluciones

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Directiva que reintenta según tres estrategias:

• Cuando el servidor envía una respuesta 429 con un encabezado Retry-After.
• Cuando hay errores en la capa de transporte subyacente (por ejemplo, errores de búsqueda de DNS).
• O bien, si se produce un error en la solicitud saliente, volverá a intentarlo con un retraso exponencialmente creciente.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parámetros

options

DefaultRetryPolicyOptions

Devoluciones

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Directiva que intenta reintentar solicitudes al introducir un retraso exponencialmente creciente.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parámetros

options

ExponentialRetryPolicyOptions

Opciones que configuran la lógica de reintento.

Devoluciones

PipelinePolicy

formDataPolicy()

Directiva que codifica FormData en la solicitud en el cuerpo.

function formDataPolicy(): PipelinePolicy

Devoluciones

PipelinePolicy

getDefaultProxySettings(string)

Advertencia

Esta API ya está en desuso.

• Internally this method is no longer necessary when setting proxy information.

Este método convierte una dirección URL de proxy en ProxySettings para su uso con ProxyPolicy. Si no se proporciona ningún argumento, intenta analizar una dirección URL de proxy de las variables de entorno HTTPS_PROXY o HTTP_PROXY.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

Parámetros

proxyUrl

string

Dirección URL del proxy que se va a usar. Puede contener información de autenticación.

Devoluciones

ProxySettings | undefined

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parámetros

e

unknown

Algo capturado por una cláusula catch.

Devoluciones

e

logPolicy(LogPolicyOptions)

Directiva que registra todas las solicitudes y respuestas.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parámetros

options

LogPolicyOptions

Opciones para configurar logPolicy.

Devoluciones

PipelinePolicy

multipartPolicy()

Directiva de canalización para solicitudes de varias partes

function multipartPolicy(): PipelinePolicy

Devoluciones

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy es una directiva que se usa para controlar la configuración de mantenimiento activo para cada solicitud.

function ndJsonPolicy(): PipelinePolicy

Devoluciones

PipelinePolicy

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Directiva que permite aplicar una configuración de proxy a todas las solicitudes. Si no se pasa la configuración estática, se recuperarán de las variables de entorno HTTPS_PROXY o HTTP_PROXY.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy

Parámetros

proxySettings

ProxySettings

ProxySettings que se va a usar en cada solicitud.

options

{ customNoProxyList?: string[] }

configuración adicional, por ejemplo, patrones de NO_PROXY personalizados

Devoluciones

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Directiva para seguir los encabezados de ubicación del servidor para admitir el redireccionamiento del lado servidor. En el explorador, esta directiva no se usa.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parámetros

options

RedirectPolicyOptions

Opciones para controlar el comportamiento de la directiva.

Devoluciones

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy es una directiva genérica para habilitar las solicitudes de reintento cuando se cumplen determinadas condiciones.

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Parámetros

strategies

RetryStrategy[]

options

RetryPolicyOptions

Devoluciones

PipelinePolicy

setClientRequestIdPolicy(string)

Cada PipelineRequest obtiene un identificador único tras la creación. Esta directiva pasa ese identificador único a través de un encabezado HTTP para permitir una mejor telemetría y seguimiento.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parámetros

requestIdHeaderName

string

Nombre del encabezado al que se va a pasar el identificador de solicitud.

Devoluciones

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Directiva de reintento que busca específicamente controlar errores en la capa de transporte subyacente (por ejemplo, errores de búsqueda dns) en lugar de códigos de error que se pueden reintentar desde el propio servidor.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parámetros

options

SystemErrorRetryPolicyOptions

Opciones que personalizan la directiva.

Devoluciones

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Directiva que reintenta cuando el servidor envía una respuesta 429 con un encabezado Retry-After.

Para obtener más información, consulte https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits y https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parámetros

options

ThrottlingRetryPolicyOptions

Opciones que configuran la lógica de reintento.

Devoluciones

PipelinePolicy

tlsPolicy(TlsSettings)

Obtiene una directiva de canalización que agrega el certificado de cliente al agente HttpClient para la autenticación.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parámetros

tlsSettings

TlsSettings

Devoluciones

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Una directiva sencilla para crear intervalos de OpenTelemetry para cada solicitud realizada por la canalización que tiene SpanOptions con un elemento primario. Las solicitudes realizadas sin un intervalo primario no se registrarán.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parámetros

options

TracingPolicyOptions

Opciones para configurar la telemetría registrada por la directiva de seguimiento.

Devoluciones

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Directiva que establece el encabezado User-Agent (o equivalente) para reflejar la versión de la biblioteca.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parámetros

options

UserAgentPolicyOptions

Opciones para personalizar el valor del agente de usuario.

Devoluciones

PipelinePolicy