@azure/core-http package

Referencia

Clases

AccessTokenRefresher	Ayuda a las directivas de autenticación de tokens core-http con la solicitud de un nuevo token si actualmente no estamos esperando un nuevo token.
ApiKeyCredentials	Se autentica en un servicio mediante una clave de API.
BaseRequestPolicy	Clase base de la que derivan todas las directivas de solicitud.
BasicAuthenticationCredentials	Sencillo <xref:ServiceClientCredential> que se autentica con un nombre de usuario y una contraseña.
DefaultHttpClient	Un cliente HTTP que usa `node-fetch`.
ExpiringAccessTokenCache	Proporciona una implementación de AccessTokenCache que borra el accessToken almacenado en caché después de que expiresOnTimestamp.
HttpHeaders	Colección de pares clave-valor de encabezado HTTP.
RequestPolicyOptions	Propiedades opcionales que se pueden usar al crear un RequestPolicy.
RestError	Error resultante de una solicitud HTTP a un punto de conexión de servicio.
Serializer	Se usa para asignar objetos de respuesta sin procesar a formas finales. Ayuda a empaquetar y desempaquetar fechas y otros tipos codificados que no son intrínsecos a JSON. También permite extraer valores de encabezados, así como insertar valores predeterminados y constantes.
ServiceClient	ServiceClient envía solicitudes de servicio y recibe respuestas.
TopicCredentials	Objeto TopicCredentials usado para Azure Event Grid.
URLBuilder	Clase que controla la creación, modificación y análisis de direcciones URL.
URLQuery	Clase que controla la parte de consulta de urlBuilder.
WebResource	Crea un nuevo objeto WebResource. Esta clase proporciona una abstracción sobre una llamada REST al ser independiente de la biblioteca o implementación y ajustar las propiedades necesarias para iniciar una solicitud.

Interfaces

AbortSignalLike	Permite anular la solicitud al desencadenar el evento "abort". Compatible con el explorador integrado AbortSignal y polyfills comunes.
AccessToken	Representa un token de acceso con una hora de expiración.
AccessTokenCache	Proporciona una memoria caché para un AccessToken que se devolvió desde un TokenCredential.
ApiKeyCredentialOptions	Describe las opciones que se deben proporcionar al crear una instancia de ApiKeyCredentials.
BaseMapper	Definición base de un asignador. Se puede usar para objetos XML y JavaScript sin formato.
CompositeMapper	Asignador compuesto por otros asignadores.
CompositeMapperType	Ayuda a crear un asignador que describe cómo asignar un conjunto de propiedades de un objeto en función de otros asignadores. Solo una de las siguientes propiedades debe estar presente: `className`, `modelProperties` y `additionalProperties`.
DeserializationContentTypes	Los tipos de contenido que indicarán que se debe deserializar una respuesta de operación de una manera determinada.
DeserializationOptions	Opciones para configurar la deserialización de respuesta de API.
DictionaryMapper	Asignador que describe objetos JavaScript sin formato que se usan como pares clave-valor.
DictionaryMapperType	Ayuda a crear un asignador que describe cómo analizar un diccionario de valores asignados.
EnumMapper	Asignador que describe un valor de enumeración.
EnumMapperType	Ayuda a crear un asignador que describe cómo analizar un valor de enumeración.
GetTokenOptions	Define las opciones de TokenCredential.getToken.
HttpClient	Interfaz que puede enviar HttpRequests y recibir httpResponses prometidos.
HttpHeader	Un encabezado individual dentro de una colección HttpHeaders.
HttpHeadersLike	Colección de pares clave-valor de encabezado HTTP.
HttpOperationResponse	Objeto contenedor para la solicitud http y la respuesta. El objeto deserializado se almacena en la `parsedBody` propiedad cuando el cuerpo de la respuesta se recibe en JSON o XML.
HttpPipelineLogger	Registrador que se puede agregar a httpPipeline. Esto permite a cada RequestPolicy registrar los mensajes que se pueden usar con fines de depuración.
HttpResponse	Las propiedades de una respuesta HTTP que siempre estarán presentes.
InternalPipelineOptions	Define las opciones que se usan para configurar opciones internas de la canalización HTTP para un cliente del SDK.
KeepAliveOptions	Opciones de cómo se deben mantener las conexiones HTTP para solicitudes futuras.
LogPolicyOptions	Opciones para pasar a logPolicy. De forma predeterminada, solo se registra una lista de conjuntos de encabezados, aunque se puede configurar. Los cuerpos de solicitud y respuesta nunca se registran.
MapperConstraints	Descripción de varias restricciones de valor, como intervalos enteros y regex de cadena.
OperationArguments	Colección de propiedades que se aplican a una sola invocación de una operación.
OperationOptions	Tipo de opciones base para todas las operaciones.
OperationParameter	Interfaz común que extiende todo el parámetro Operation.
OperationQueryParameter	Parámetro para una operación que se agregará como parámetro de consulta a la solicitud HTTP de la operación.
OperationRequestOptions	Opciones que permiten configurar el control de las solicitudes HTTP realizadas por una operación del SDK.
OperationResponse	OperationResponse que se puede devolver desde una solicitud de operación para un único código de estado.
OperationSpec	Especificación que define cómo realizar una operación de servicio determinada a través de HTTP, incluido cómo serializar correctamente la información de solicitud en y deserializar la información de respuesta en una carga de objeto que devuelve ServiceClient.
OperationURLParameter	Parámetro para una operación que se sustituirá en la dirección URL de solicitud de la operación.
ParameterValue	Valor de parámetro proporcionado para los parámetros de ruta de acceso o consulta en RequestPrepareOptions
PipelineOptions	Define las opciones que se usan para configurar la canalización HTTP para un cliente del SDK.
PolymorphicDiscriminator	Se usa para eliminar la ambigüedad de las uniones de tipos discriminadas. Por ejemplo, si la respuesta puede tener muchas formas, pero también incluye un campo "kind" (o similar), ese campo se puede usar para determinar cómo deserializar la respuesta al tipo correcto.
ProxySettings	Opciones para configurar un proxy para las solicitudes salientes (solo Node.js).
RedirectOptions	Opciones para controlar las respuestas de redireccionamiento.
RequestOptionsBase	Describe la estructura base del objeto options que se usará en cada operación.
RequestPolicy	Estructura subyacente de una directiva de solicitud.
RequestPolicyOptionsLike	Propiedades opcionales que se pueden usar al crear un RequestPolicy.
RequestPrepareOptions	Opciones para preparar una solicitud HTTP saliente.
RestResponse	Respuesta acoplada a una llamada REST. Contiene httpOperationResponse subyacente, así como las propiedades combinadas de `parsedBody`, `parsedHeaders`, etc.
RetryOptions	Opciones que controlan cómo reintentar solicitudes con error.
SequenceMapper	Asignador que describe matrices.
SequenceMapperType	Ayuda a crear un asignador que describe cómo analizar una secuencia de valores asignados.
SerializerOptions	Opciones para controlar el comportamiento del analizador xml y del generador.
ServiceCallback
ServiceClientCredentials	Representa un objeto o clase con un `signRequest` método que firmará las solicitudes salientes (por ejemplo, estableciendo el `Authorization` encabezado ).
ServiceClientOptions	Opciones que se deben proporcionar al crear el cliente.
SimpleMapperType	Tipo de asignador simple.
TokenCredential	Representa una credencial capaz de proporcionar un token de autenticación.
TracingPolicyOptions	Opciones para personalizar la directiva de seguimiento.
UrlParameterValue	Interfaz que representa un valor de parámetro de dirección URL.
UserAgentOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.
WebResourceLike	Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.

Alias de tipos

Authenticator	Función que recibe un desafío y resuelve una promesa con un token de cadena.
CommonRequestInfo	Direcciones URL de cadena usadas al llamar a `fetch()`.
CommonRequestInit	Objeto que contiene información sobre la solicitud HTTP saliente.
CommonResponse	Objeto que contiene información sobre la respuesta HTTP entrante.
HttpMethods	Lista de métodos HTTP admitidos.
HttpRequestBody	Posibles tipos de cuerpo de solicitud HTTP
Mapper	Los asignadores son definiciones de los modelos de datos usados en la biblioteca. Estos modelos de datos forman parte de las definiciones de operación o cliente en las respuestas o parámetros.
MapperType	Tipo del asignador. Incluye asignadores conocidos.
ParameterPath	Ruta de acceso que describe cómo obtener acceso a una propiedad determinada en un origen de datos de objeto determinado. Puede ser un nombre de propiedad único, una matriz que denota nombres de propiedad anidados o un conjunto de varias propiedades con nombre con rutas de acceso en el caso de valores de objeto complejos.
ProxyOptions	Alias de ProxySettings para su uso futuro.
RawHttpHeaders	Colección HttpHeaders representada como un objeto JSON simple.
RequestPolicyFactory	Crea una solicitud RequestPolicy por solicitud que usa el elemento nextPolicy proporcionado.
TelemetryInfo	Información de telemetría. Pares clave-valor que se van a incluir dentro de la cadena de User-Agent.
TransferProgressEvent	Se desencadena en respuesta a la carga o descarga del progreso.

Enumeraciones

HttpPipelineLogLevel	Los distintos niveles de registros que se pueden usar con HttpPipelineLogger.
QueryCollectionFormat	Formato que se usará para combinar una matriz de valores para un valor de parámetro de consulta.
RetryMode	Describe el tipo modo de reintento. Actualmente solo admite Exponencial.

Funciones

applyMixins(unknown, any[])	Aplica las propiedades del prototipo de sourceCtors al prototipo de targetCtor.
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	Crea una nueva fábrica para un RequestPolicy que aplica un token de portador a los encabezados de `Authorization` las solicitudes.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Crea una canalización HTTP basada en las opciones especificadas.
delay(number, DelayOptions)	Contenedor para setTimeout que resuelve una promesa después de milisegundos timeInMs.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Cree una nueva requestPolicyCreator de serialización que serializará los cuerpos de solicitud HTTP a medida que pasan a través de la canalización HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Dado un conjunto determinado de tipos de contenido que se van a analizar como JSON o XML, consume la respuesta HTTP para generar el objeto de resultado definido por operationSpec de la solicitud.
disableResponseDecompressionPolicy()	Devuelve un generador de directivas de solicitud que se puede usar para crear una instancia de <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Codifica un URI.
executePromisesSequentially(any[], unknown)	Ejecuta secuencialmente una matriz de promesas. La inspiración de este método está aquí: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. ¡Un blog impresionante sobre promesas!
exponentialRetryPolicy(number, number, number)	Directiva que reintenta la solicitud tantas veces como esté configurada siempre y cuando se especifique el intervalo máximo de tiempo de reintento, cada reintento que espera más tiempo para comenzar que la última vez.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Analiza httpOperationResponse en un objeto de respuesta HTTP normalizado (RestResponse).
generateClientRequestIdPolicy(string)	Crea una directiva que asigna un identificador de solicitud único a las solicitudes salientes.
generateUuid()	UUID generado
getDefaultProxySettings(string)	Convierte una dirección URL determinada de un servidor proxy en `ProxySettings` o intenta recuperarse `ProxySettings` del entorno actual si no se pasa ninguna.
getDefaultUserAgentValue()	Enfoque predeterminado para generar agentes de usuario. Usa información estática de este paquete, además de la información del sistema disponible en tiempo de ejecución.
isDuration(string)	Indica si la cadena especificada está en formato ISO 8601.
isTokenCredential(unknown)	Prueba un objeto para determinar si implementa TokenCredential.
isValidUuid(string)	Valida el uuid dado como una cadena.
keepAlivePolicy(KeepAliveOptions)	Crea una directiva que controla si las conexiones HTTP se mantienen en solicitudes futuras.
logPolicy(LogPolicyOptions)	Crea una directiva que registra información sobre la solicitud saliente y las respuestas entrantes.
operationOptionsToRequestOptionsBase<T>(T)	Convierte operationOptions en requestOptionsBase
parseXML(string, SerializerOptions)	Convierte una cadena XML determinada en JSON.
promiseToCallback(Promise<any>)	Convierte una promesa en una devolución de llamada.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Convierte una promesa en una devolución de llamada de servicio.
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 de HTTPS_PROXY o HTTP_PROXY.
redirectPolicy(number)	Crea una directiva de redireccionamiento, que envía una solicitud a un nuevo destino si una respuesta llega con un encabezado "location" y un código de estado entre 300 y 307.
serializeObject(unknown)	Función de utilidad que serializa un objeto que puede contener información binaria en un objeto, matriz o cadena sin formato.
signingPolicy(ServiceClientCredentials)	Crea una directiva que firma las solicitudes salientes llamando al método proporcionado`authenticationProvidersignRequest`.
stringifyXML(unknown, SerializerOptions)	Convierte un objeto JSON dado en una cadena XML.
stripRequest(WebResourceLike)	Devuelve una versión quitada de la solicitud HTTP que no contiene el encabezado Authorization.
stripResponse(HttpOperationResponse)	Devuelve una versión quitada de la respuesta Http que solo contiene el cuerpo, los encabezados y el estado.
systemErrorRetryPolicy(number, number, number, number)	Una directiva que reintenta cuando se produce un error del sistema, identificado por los códigos "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" o "ENOENT".
throttlingRetryPolicy()	Crea una directiva que vuelve a enviar la solicitud si la respuesta indica que se produjo un error en la solicitud debido a motivos de limitación. Por ejemplo, si la respuesta contiene un `Retry-After` encabezado, volverá a intentar enviar la solicitud en función del valor de ese encabezado. Para más información, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsy . https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Crea una directiva que ajusta las solicitudes salientes con un intervalo de seguimiento.
userAgentPolicy(TelemetryInfo)	Devuelve una directiva que agrega el encabezado del agente de usuario a las solicitudes salientes basadas en el elemento TelemetryInfo especificado.

Detalles de la función

applyMixins(unknown, any[])

Aplica las propiedades del prototipo de sourceCtors al prototipo de targetCtor.

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Parámetros

targetCtorParam: unknown

sourceCtors: any[]

Matriz de objetos de origen desde los que se deben tomar las propiedades.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Crea una nueva fábrica para un RequestPolicy que aplica un token de portador a los encabezados de Authorization las solicitudes.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Parámetros

credential: TokenCredential

Implementación de TokenCredential que puede proporcionar el token de portador.

scopes: string | string[]

Ámbitos para los que se aplica el token de portador.

Devoluciones

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Crea una canalización HTTP basada en las opciones especificadas.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Parámetros

pipelineOptions: InternalPipelineOptions

Define las opciones que se usan para configurar directivas en la canalización HTTP para un cliente del SDK.

authPolicyFactory: RequestPolicyFactory

Un generador de directivas de autenticación opcional que se va a usar para firmar solicitudes.

Devoluciones

ServiceClientOptions

Conjunto de opciones que se pueden pasar para crear un nuevo ServiceClient.

delay(number, DelayOptions)

Contenedor para setTimeout que resuelve una promesa después de milisegundos timeInMs.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Parámetros

timeInMs: number

Número de milisegundos que se van a retrasar.

options: DelayOptions

Opciones de retraso: opciones de anulación actualmente

Devoluciones

Promise<void>

Promesa que se resuelve después de timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Cree una nueva requestPolicyCreator de serialización que serializará los cuerpos de solicitud HTTP a medida que pasan a través de la canalización HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parámetros

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Devoluciones

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Dado un conjunto determinado de tipos de contenido que se van a analizar como JSON o XML, consume la respuesta HTTP para generar el objeto de resultado definido por operationSpec de la solicitud.

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

Parámetros

jsonContentTypes: string[]

Tipos de contenido de respuesta para analizar el cuerpo como JSON.

xmlContentTypes: string[]

Tipos de contenido de respuesta para analizar el cuerpo como XML.

response: HttpOperationResponse

Respuesta HTTP de la canalización.

options: SerializerOptions

Opciones para el serializador, principalmente para configurar el analizador XML si es necesario.

Devoluciones

Promise<HttpOperationResponse>

Objeto HttpOperationResponse analizado que serviceClient puede devolver.

disableResponseDecompressionPolicy()

Devuelve un generador de directivas de solicitud que se puede usar para crear una instancia de <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Devoluciones

RequestPolicyFactory

encodeUri(string)

Codifica un URI.

function encodeUri(uri: string): string

Parámetros

uri: string

URI que se va a codificar.

Devoluciones

string

URI codificado.

executePromisesSequentially(any[], unknown)

Ejecuta secuencialmente una matriz de promesas. La inspiración de este método está aquí: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. ¡Un blog impresionante sobre promesas!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

Parámetros

promiseFactories: any[]

Matriz de fábricas de promesas (función que devuelve una promesa)

kickstart: unknown

Entrada a la primera promesa que se usa para iniciar la cadena de promesas. Si no se proporciona, la cadena de promesas comienza con undefined.

Devoluciones

Promise<any>

Una cadena de promesas resueltas o rechazadas

exponentialRetryPolicy(number, number, number)

Directiva que reintenta la solicitud tantas veces como esté configurada siempre y cuando se especifique el intervalo máximo de tiempo de reintento, cada reintento que espera más tiempo para comenzar que la última vez.

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Parámetros

retryCount: number

Número máximo de reintentos.

retryInterval: number

Tiempo base entre reintentos.

maxRetryInterval: number

Tiempo máximo de espera entre reintentos.

Devoluciones

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analiza httpOperationResponse en un objeto de respuesta HTTP normalizado (RestResponse).

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

Parámetros

_response: HttpOperationResponse

Objeto contenedor para la respuesta http.

responseSpec: undefined | OperationResponse

Asignadores para analizar las propiedades de respuesta.

Devoluciones

RestResponse

Objeto de respuesta normalizado.

generateClientRequestIdPolicy(string)

Crea una directiva que asigna un identificador de solicitud único a las solicitudes salientes.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parámetros

requestIdHeaderName: string

Nombre del encabezado que se va a usar al asignar el identificador único a la solicitud.

Devoluciones

RequestPolicyFactory

generateUuid()

UUID generado

function generateUuid(): string

Devoluciones

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Convierte una dirección URL determinada de un servidor proxy en ProxySettings o intenta recuperarse ProxySettings del entorno actual si no se pasa ninguna.

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

Parámetros

proxyUrl: string

Dirección URL del proxy

Devoluciones

ProxySettings | undefined

Configuración predeterminada del proxy o sin definir.

getDefaultUserAgentValue()

Enfoque predeterminado para generar agentes de usuario. Usa información estática de este paquete, además de la información del sistema disponible en tiempo de ejecución.

function getDefaultUserAgentValue(): string

Devoluciones

string

isDuration(string)

Indica si la cadena especificada está en formato ISO 8601.

function isDuration(value: string): boolean

Parámetros

value: string

Valor que se va a validar para el formato de duración ISO 8601.

Devoluciones

boolean

true es si es válido; de lo contrario, false es .

isTokenCredential(unknown)

Prueba un objeto para determinar si implementa TokenCredential.

function isTokenCredential(credential: unknown): credential

Parámetros

credential: unknown

TokenCredential asumido que se va a probar.

Devoluciones

credential

isValidUuid(string)

Valida el uuid dado como una cadena.

function isValidUuid(uuid: string): boolean

Parámetros

uuid: string

Uuid como una cadena que se debe validar

Devoluciones

boolean

True si el uuid es válido; False en caso contrario.

keepAlivePolicy(KeepAliveOptions)

Crea una directiva que controla si las conexiones HTTP se mantienen en solicitudes futuras.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parámetros

keepAliveOptions: KeepAliveOptions

Mantener las opciones activas. De forma predeterminada, las conexiones HTTP se mantienen para solicitudes futuras.

Devoluciones

RequestPolicyFactory

Una instancia de . <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Crea una directiva que registra información sobre la solicitud saliente y las respuestas entrantes.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parámetros

loggingOptions: LogPolicyOptions

Opciones de registro.

Devoluciones

RequestPolicyFactory

Una instancia de . <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Convierte operationOptions en requestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Parámetros

opts: T

OperationOptions (objeto) que se va a convertir en RequestOptionsBase

Devoluciones

RequestOptionsBase

parseXML(string, SerializerOptions)

Convierte una cadena XML determinada en JSON.

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Parámetros

str: string

Cadena que contiene el contenido XML que se va a analizar en JSON

opts: SerializerOptions

Opciones que rigen el análisis de una cadena xml determinada

Devoluciones

Promise<any>

promiseToCallback(Promise<any>)

Advertencia

Esta API ya está en desuso.

generated code should instead depend on responseToBody

Convierte una promesa en una devolución de llamada.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

Parámetros

promise: Promise<any>

Promesa que se va a convertir en una devolución de llamada

Devoluciones

(cb: Function) => void

Función que toma la devolución de llamada. (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Convierte una promesa en una devolución de llamada de servicio.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

Parámetros

promise: Promise<HttpOperationResponse>

Promesa de HttpOperationResponse que se va a convertir en una devolución de llamada de servicio

Devoluciones

(cb: ServiceCallback<T>) => void

Función que toma la devolución de llamada del servicio (cb: ServiceCallback): void

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 de HTTPS_PROXY o HTTP_PROXY.

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

Parámetros

proxySettings: ProxySettings

ProxySettings para usar en cada solicitud.

options: { customNoProxyList?: string[] }

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

Devoluciones

RequestPolicyFactory

redirectPolicy(number)

Crea una directiva de redireccionamiento, que envía una solicitud a un nuevo destino si una respuesta llega con un encabezado "location" y un código de estado entre 300 y 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parámetros

maximumRetries: number

Número máximo de redireccionamientos que se deben seguir.

Devoluciones

RequestPolicyFactory

Una instancia de . <xref:RedirectPolicy>

serializeObject(unknown)

Función de utilidad que serializa un objeto que puede contener información binaria en un objeto, matriz o cadena sin formato.

function serializeObject(toSerialize: unknown): any

Parámetros

toSerialize: unknown

Devoluciones

any

signingPolicy(ServiceClientCredentials)

Crea una directiva que firma las solicitudes salientes llamando al método proporcionadoauthenticationProvidersignRequest.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parámetros

authenticationProvider: ServiceClientCredentials

Proveedor de autenticación.

Devoluciones

RequestPolicyFactory

Una instancia del <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Convierte un objeto JSON dado en una cadena XML.

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Parámetros

obj: unknown

Objeto JSON que se va a convertir en cadena XML

opts: SerializerOptions

Opciones que rigen el análisis de un objeto JSON determinado

Devoluciones

string

stripRequest(WebResourceLike)

Devuelve una versión quitada de la solicitud HTTP que no contiene el encabezado Authorization.

function stripRequest(request: WebResourceLike): WebResourceLike

Parámetros

request: WebResourceLike

El objeto Http Request

Devoluciones

WebResourceLike

La versión quitada de la solicitud Http.

stripResponse(HttpOperationResponse)

Devuelve una versión quitada de la respuesta Http que solo contiene el cuerpo, los encabezados y el estado.

function stripResponse(response: HttpOperationResponse): any

Parámetros

response: HttpOperationResponse

Respuesta HTTP

Devoluciones

any

Versión quitada de la respuesta Http.

systemErrorRetryPolicy(number, number, number, number)

Una directiva que reintenta cuando se produce un error del sistema, identificado por los códigos "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" o "ENOENT".

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Parámetros

retryCount: number

Número máximo de reintentos.

retryInterval: number

Intervalo de reintento del cliente, en milisegundos.

minRetryInterval: number

Intervalo mínimo de reintento, en milisegundos.

maxRetryInterval: number

Intervalo máximo de reintento, en milisegundos.

Devoluciones

RequestPolicyFactory

Una instancia de . <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Crea una directiva que vuelve a enviar la solicitud si la respuesta indica que se produjo un error en la solicitud debido a motivos de limitación. Por ejemplo, si la respuesta contiene un Retry-After encabezado, volverá a intentar enviar la solicitud en función del valor de ese encabezado.

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

function throttlingRetryPolicy(): RequestPolicyFactory

Devoluciones

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Crea una directiva que ajusta las solicitudes salientes con un intervalo de seguimiento.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parámetros

tracingOptions: TracingPolicyOptions

Opciones de seguimiento.

Devoluciones

RequestPolicyFactory

Instancia de la clase <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Devuelve una directiva que agrega el encabezado del agente de usuario a las solicitudes salientes basadas en el elemento TelemetryInfo especificado.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parámetros

userAgentData: TelemetryInfo

Información de telemetría.

Devoluciones

RequestPolicyFactory

Un nuevo objeto <xref:UserAgentPolicy>.

Compartir a través de

@azure/core-http package

Clases

Interfaces

Alias de tipos

Enumeraciones

Funciones

Detalles de la función

applyMixins(unknown, any[])

Parámetros

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Parámetros

Devoluciones

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Parámetros

Devoluciones

delay(number, DelayOptions)

Parámetros

Devoluciones

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Parámetros

Devoluciones

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Parámetros

Devoluciones

disableResponseDecompressionPolicy()

Devoluciones

encodeUri(string)

Parámetros

Devoluciones

executePromisesSequentially(any[], unknown)

Parámetros

Devoluciones

exponentialRetryPolicy(number, number, number)

Parámetros

Devoluciones

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parámetros

Devoluciones

generateClientRequestIdPolicy(string)

Parámetros

Devoluciones

generateUuid()

Devoluciones

getDefaultProxySettings(string)

Parámetros

Devoluciones

getDefaultUserAgentValue()

Devoluciones

isDuration(string)

Parámetros

Devoluciones

isTokenCredential(unknown)

Parámetros

Devoluciones

isValidUuid(string)

Parámetros

Devoluciones

keepAlivePolicy(KeepAliveOptions)

Parámetros

Devoluciones

logPolicy(LogPolicyOptions)

Parámetros

Devoluciones

operationOptionsToRequestOptionsBase<T>(T)

Parámetros

Devoluciones

parseXML(string, SerializerOptions)

Parámetros

Devoluciones

promiseToCallback(Promise<any>)

Parámetros

Devoluciones

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

redirectPolicy(number)