@azure/ms-rest-js package

Clases

ApiKeyCredentials	Se autentica en un servicio mediante una clave de API.
AzureIdentityCredentialAdapter	Esta clase proporciona una extensión sencilla que se usa <xref:TokenCredential> desde la @azure/identity biblioteca para usarla con los SDK de Azure heredados que aceptan la familia de credenciales ServiceClientCredentials para la autenticación.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	Se autentica en un servicio mediante una clave de API.
HttpHeaders	Colección de pares clave-valor de encabezado HTTP.
RequestPolicyOptions	Propiedades opcionales que se pueden usar al crear una requestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials	Objeto de credenciales que usa una cadena de token y un esquema de creación para autenticarse.
TopicCredentials	Se autentica en un servicio mediante una clave de API.
URLBuilder	Clase que controla la creación, modificación y análisis de direcciones URL.
URLQuery	Clase que controla la parte de consulta de un objeto URLBuilder.
WebResource	Crea un nuevo objeto WebResource. Esta clase proporciona una abstracción sobre una llamada REST, ya que es independiente de la biblioteca o implementación y ajusta 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.
AgentSettings	Agentes HTTP y HTTPS (solo Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes	Los tipos de contenido que indicarán que se debe deserializar una respuesta de operación de una manera determinada.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
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.
MapperConstraints
OperationArguments	Colección de propiedades que se aplican a una única invocación de una operación.
OperationParameter	Interfaz común que extiende todo el parámetro Operation.
OperationQueryParameter	Parámetro de una operación que se agregará como parámetro de consulta a la solicitud HTTP de la operación.
OperationResponse	OperationResponse que se puede devolver desde una solicitud de operación para un único código de estado.
OperationSpec	Especificación que define una operación.
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
PolymorphicDiscriminator
ProxySettings	Configuración del proxy HTTP (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
RequestPolicyOptionsLike	Propiedades opcionales que se pueden usar al crear una requestPolicy.
RequestPrepareOptions
RestResponse	Respuesta acoplada a una llamada REST. Contiene httpOperationResponse subyacente, así como las propiedades combinadas de parsedBody, parsedHeaders, etc.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions	Opciones que se proporcionarán al crear el cliente.
SimpleMapperType
TokenResponse	TokenResponse se define en @azure/ms-rest-nodeauth y se copia aquí para no agregar una dependencia innecesaria.
UrlParameterValue
WebResourceLike	Abstracción a través de una llamada DE REST.

Alias de tipos

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders	Colección HttpHeaders representada como un objeto JSON simple.
RequestPolicyFactory	Crea una nueva requestPolicy por solicitud que usa nextPolicy proporcionada.
TelemetryInfo
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.

Funciones

agentPolicy(AgentSettings)
applyMixins(any, any[])	Aplica las propiedades en el prototipo de sourceCtors al prototipo de targetCtor.
delay<T>(number, T)	Contenedor para setTimeout que resuelve una promesa después de milisegundos.
deserializationPolicy(DeserializationContentTypes)	Cree una nueva serialización RequestPolicyCreator que serializará los cuerpos de solicitud HTTP a medida que pasan a través de la canalización HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)	Codifica un URI.
executePromisesSequentially(any[], any)	Ejecuta una matriz de promesas secuencialmente. 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, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()	UUID generado
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)	Indica si la cadena especificada está en formato ISO 8601.
isValidUuid(string)	Valida el uuid especificado como una cadena.
logPolicy(any)
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)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
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)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Detalles de la función

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parámetros

agentSettings

AgentSettings

Devoluciones

RequestPolicyFactory

applyMixins(any, any[])

Aplica las propiedades en el prototipo de sourceCtors al prototipo de targetCtor.

function applyMixins(targetCtor: any, sourceCtors: any[])

Parámetros

targetCtor

any

Objeto de destino en el que se deben aplicar las propiedades.

sourceCtors

any[]

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

delay<T>(number, T)

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

function delay<T>(t: number, value?: T): Promise<T>

Parámetros

t

number

Número de milisegundos que se van a retrasar.

value

T

Valor que se va a resolver con después de un tiempo de espera de milisegundos.

Devoluciones

Promise<T>

Promesa resuelta

deserializationPolicy(DeserializationContentTypes)

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

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parámetros

deserializationContentTypes

DeserializationContentTypes

Devoluciones

RequestPolicyFactory

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

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

Parámetros

jsonContentTypes

string[]

xmlContentTypes

string[]

response

HttpOperationResponse

Devoluciones

Promise<HttpOperationResponse>

encodeUri(string)

Codifica un URI.

function encodeUri(uri: string): string

Parámetros

uri

string

Identificador URI que se va a codificar.

Devoluciones

string

URI codificado.

executePromisesSequentially(any[], any)

Ejecuta una matriz de promesas secuencialmente. 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?: any): Promise<any>

Parámetros

promiseFactories

any[]

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

kickstart

any

Entrada a la primera promesa que se usa para iniciar la cadena de promesas. Si no se proporciona, la cadena de promesas comienza por sin definir.

Devoluciones

Promise<any>

Cadena de promesas resueltas o rechazadas

exponentialRetryPolicy(number, number, number, number)

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

Parámetros

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Devoluciones

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

Parámetros

_response

HttpOperationResponse

responseSpec

undefined | OperationResponse

Devoluciones

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parámetros

requestIdHeaderName

string

Devoluciones

RequestPolicyFactory

generateUuid()

UUID generado

function generateUuid(): string

Devoluciones

string

UUID RFC4122 v4.

getDefaultProxySettings(string)

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

Parámetros

proxyUrl

string

Devoluciones

ProxySettings | undefined

getDefaultUserAgentValue()

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 si es válido; de lo contrario, false .

isValidUuid(string)

Valida el uuid especificado 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.

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

Parámetros

logger

any

Devoluciones

RequestPolicyFactory

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

Parámetros

promise

Promise<any>

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

Devoluciones

Function

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

Parámetros

promise

Promise<HttpOperationResponse>

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

Devoluciones

Function

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

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parámetros

proxySettings

ProxySettings

Devoluciones

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parámetros

maximumRetries

number

Devoluciones

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

Parámetros

toSerialize

any

Devoluciones

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parámetros

authenticationProvider

ServiceClientCredentials

Devoluciones

RequestPolicyFactory

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)

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

Parámetros

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Devoluciones

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parámetros

maxRetries

number

Devoluciones

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parámetros

userAgentData

TelemetryInfo

Devoluciones

RequestPolicyFactory