@azure/core-https package

Clases

DefaultHttpsClient	Una implementación de HttpsClient que usa el módulo "https" de Node para enviar solicitudes HTTPS.
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.
BearerTokenAuthenticationPolicyOptions	Opciones para configurar bearerTokenAuthenticationPolicy
ExponentialRetryPolicyOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
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.
HttpsClient	La interfaz necesaria para un cliente que realiza solicitudes HTTPS en nombre de una canalización.
InternalPipelineOptions	Define las opciones que se usan para configurar opciones internas de la canalización HTTP para un cliente del SDK.
LogPolicyOptions	Opciones para configurar logPolicy.
Pipeline	Representa una canalización para realizar una solicitud HTTPS a 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 PipelineRequest< parcial>, pero url es obligatorio.
PipelineResponse	Metadatos sobre una respuesta recibida por la canalización.
ProxySettings	Opciones para configurar un proxy para las solicitudes salientes (soloNode.js).
RedirectPolicyOptions	Opciones para controlar las respuestas de redirección.
RestErrorOptions	Las opciones admitidas por RestError.
SystemErrorRetryPolicyOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
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 o (en el navegador) un Blob.
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
RawHttpHeaders	Colección HttpHeaders representada como un objeto JSON simple.
RequestBodyType	Tipos de cuerpos admitidos en la solicitud. NodeJS.ReadableStream es solo Node. Blob es solo del 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

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.
createEmptyPipeline()	Crea una canalización totalmente vacía. Resulta útil para probar o crear uno personalizado.
createHttpHeaders(RawHttpHeaders)	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
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.
logPolicy(LogPolicyOptions)	Directiva que registra todas las solicitudes y respuestas.
ndJsonPolicy()	ndJsonPolicy es una directiva que se usa para controlar la configuración de mantenimiento activo para cada solicitud.
proxyPolicy(ProxySettings)	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.
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()	Directiva que reintenta cuando el servidor envía una respuesta 429 con un encabezado Retry-After. Para obtener más información, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits y https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
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.

Variables

bearerTokenAuthenticationPolicyName	El identificador programático de la BoletaAutenticaciónPolítica de TokenBearer.
decompressResponsePolicyName	El identificador programático de la política decompressResponsePolicy.
expontentialRetryPolicyName	El identificador programático de la RetryPolicy exponencial.
formDataPolicyName	El identificador programático de la formulDataPolicy.
logPolicyName	El identificador programático de la logPolicy.
ndJsonPolicyName	El identificador programático de ndJsonPolicy.
proxyPolicyName	El identificador programático del proxy Policy.
redirectPolicyName	El identificador programático de la política redirectPolicy.
setClientRequestIdPolicyName	El identificador programático de la política setClientRequestIdPolicy.
systemErrorRetryPolicyName	El identificador programático de la política systemErrorRetryPolicy.
throttlingRetryPolicyName	El identificador programático de throttlingRetryPolicy.
tracingPolicyName	El identificador programático de la TrazingPolicy.
userAgentPolicyName	El identificador programático de la userAgentPolicy.

Detalles de la función

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

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Devoluciones

Pipeline

createHttpHeaders(RawHttpHeaders)

Crea un objeto que satisface la interfaz HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parámetros

rawHeaders

RawHttpHeaders

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

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)

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

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

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)

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): PipelinePolicy

Parámetros

proxySettings

ProxySettings

ProxySettings que se va a usar en cada solicitud.

Devoluciones

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Directiva para seguir los encabezados de ubicación del servidor para admitir el redireccionamiento del lado servidor.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parámetros

options

RedirectPolicyOptions

Opciones para controlar el comportamiento de la directiva.

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()

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

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

function throttlingRetryPolicy(): PipelinePolicy

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

Variable Details

bearerTokenAuthenticationPolicyName

El identificador programático de la BoletaAutenticaciónPolítica de TokenBearer.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Tipo

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

El identificador programático de la política decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Tipo

"decompressResponsePolicy"

expontentialRetryPolicyName

El identificador programático de la RetryPolicy exponencial.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Tipo

"exponentialRetryPolicy"

formDataPolicyName

El identificador programático de la formulDataPolicy.

formDataPolicyName: "formDataPolicy"

Tipo

"formDataPolicy"

logPolicyName

El identificador programático de la logPolicy.

logPolicyName: "logPolicy"

Tipo

"logPolicy"

ndJsonPolicyName

El identificador programático de ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Tipo

"ndJsonPolicy"

proxyPolicyName

El identificador programático del proxy Policy.

proxyPolicyName: "proxyPolicy"

Tipo

"proxyPolicy"

redirectPolicyName

El identificador programático de la política redirectPolicy.

redirectPolicyName: "redirectPolicy"

Tipo

"redirectPolicy"

setClientRequestIdPolicyName

El identificador programático de la política setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Tipo

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

El identificador programático de la política systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Tipo

"systemErrorRetryPolicy"

throttlingRetryPolicyName

El identificador programático de throttlingRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Tipo

"throttlingRetryPolicy"

tracingPolicyName

El identificador programático de la TrazingPolicy.

tracingPolicyName: "tracingPolicy"

Tipo

"tracingPolicy"

userAgentPolicyName

El identificador programático de la userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Tipo

"userAgentPolicy"