Compartilhar via

@azure/ms-rest-js package

  • Referência

Classes

ApiKeyCredentials

Autentica-se em um serviço usando uma chave de API.
AzureIdentityCredentialAdapter

Essa classe fornece uma extensão simples a ser usada <xref:TokenCredential> da @azure/identity biblioteca para usar com SDKs herdados do Azure que aceitam a família de credenciais ServiceClientCredentials para autenticação.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

Autentica-se em um serviço usando uma chave de API.
HttpHeaders

Uma coleção de pares chave/valor de cabeçalho HTTP.
RequestPolicyOptions

Propriedades opcionais que podem ser usadas ao criar uma RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials

Um objeto de credenciais que usa uma cadeia de caracteres de token e um esquema de autorização para autenticação.
TopicCredentials

Autentica-se em um serviço usando uma chave de API.
URLBuilder

Uma classe que manipula a criação, a modificação e a análise de URLs.
URLQuery

Uma classe que manipula a parte de consulta de um URLBuilder.
WebResource

Cria um novo objeto WebResource.

Essa classe fornece uma abstração em uma chamada REST sendo independente de biblioteca/implementação e encapsulando as propriedades necessárias para iniciar uma solicitação.

Interfaces

AbortSignalLike

Permite que a solicitação seja anulada ao disparar o evento "abort". Compatível com o abortSignal interno do navegador e polyfills comuns.
AgentSettings

Agentes HTTP e HTTPS (somente Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

Os tipos de conteúdo que indicarão que uma resposta de operação deve ser desserializada de uma maneira específica.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

Uma interface que pode enviar HttpRequests e receber HttpResponses prometidos.
HttpHeader

Um cabeçalho individual dentro de uma coleção HttpHeaders.
HttpHeadersLike

Uma coleção de pares chave/valor de cabeçalho HTTP.
HttpOperationResponse

Objeto wrapper para solicitação e resposta http. O objeto desserializado é armazenado na parsedBody propriedade quando o corpo da resposta é recebido em JSON ou XML.
HttpPipelineLogger

Um agente que pode ser adicionado a um HttpPipeline. Isso permite que cada RequestPolicy registre mensagens que podem ser usadas para fins de depuração.
HttpResponse

As propriedades em uma resposta HTTP que sempre estarão presentes.
MapperConstraints
OperationArguments

Uma coleção de propriedades que se aplicam a uma única invocação de uma operação.
OperationParameter

Uma interface comum que todos os parâmetros da Operação estendem.
OperationQueryParameter

Um parâmetro para uma operação que será adicionada como um parâmetro de consulta à solicitação HTTP da operação.
OperationResponse

Um OperationResponse que pode ser retornado de uma solicitação de operação para um único código de status.
OperationSpec

Uma especificação que define uma operação.
OperationURLParameter

Um parâmetro para uma operação que será substituída na URL de solicitação da operação.
ParameterValue

O valor parameter fornecido para parâmetros de caminho ou consulta em RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings

Configurações de proxy HTTP (somente Node.js)
RedirectOptions

Opções de como as respostas de redirecionamento são tratadas.
RequestOptionsBase

Descreve a estrutura base do objeto options que será usado em cada operação.
RequestPolicy
RequestPolicyOptionsLike

Propriedades opcionais que podem ser usadas ao criar uma RequestPolicy.
RequestPrepareOptions
RestResponse

A resposta nivelada para uma chamada REST. Contém o HttpOperationResponse subjacente, bem como as propriedades mescladas do parsedBody, parsedHeaders etc.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Opções a serem fornecidas durante a criação do cliente.
SimpleMapperType
TokenResponse

TokenResponse é definido em @azure/ms-rest-nodeauth e é copiado aqui para não adicionar uma dependência desnecessária.
UrlParameterValue
WebResourceLike

Uma abstração em uma chamada REST.

Aliases de tipo

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

Uma coleção HttpHeaders representada como um objeto JSON simples.
RequestPolicyFactory

Cria uma nova RequestPolicy por solicitação que usa a nextPolicy fornecida.
TelemetryInfo
TransferProgressEvent

Acionado em resposta ao progresso do upload ou do download.

Enumerações

HttpPipelineLogLevel

Os diferentes níveis de logs que podem ser usados com o HttpPipelineLogger.
QueryCollectionFormat

O formato que será usado para unir uma matriz de valores para um valor de parâmetro de consulta.

Funções

agentPolicy(AgentSettings)
applyMixins(any, any[])

Aplica as propriedades no protótipo de sourceCtors ao protótipo de targetCtor
delay<T>(number, T)

Um wrapper para setTimeout que resolve uma promessa após t milissegundos.
deserializationPolicy(DeserializationContentTypes)

Crie uma nova serialização RequestPolicyCreator que serializará corpos de solicitação HTTP conforme eles passarem pelo pipeline HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

Codifica um URI.
executePromisesSequentially(any[], any)

Executa uma matriz de promessas sequencialmente. A inspiração desse método está aqui: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Um blog incrível sobre promessas!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

UUID gerado
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Indica se a cadeia de caracteres fornecida está no formato ISO 8601.
isValidUuid(string)

Valida o uuid especificado como uma cadeia de caracteres
logPolicy(any)
promiseToCallback(Promise<any>)

Converte uma Promessa em um retorno de chamada.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte uma Promessa em um retorno de chamada de serviço.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Retorna uma versão despojada da Solicitação Http que não contém o cabeçalho Autorização.
stripResponse(HttpOperationResponse)

Retorna uma versão despojada da Resposta Http que contém apenas corpo, cabeçalhos e o status.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Detalhes da função

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parâmetros

agentSettings
AgentSettings

Retornos

RequestPolicyFactory

applyMixins(any, any[])

Aplica as propriedades no protótipo de sourceCtors ao protótipo de targetCtor

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

Parâmetros

targetCtor

any

O objeto de destino no qual as propriedades precisam ser aplicadas.

sourceCtors

any[]

Uma matriz de objetos de origem dos quais as propriedades precisam ser obtidas.

delay<T>(number, T)

Um wrapper para setTimeout que resolve uma promessa após t milissegundos.

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

Parâmetros

t

number

O número de milissegundos a serem atrasados.

value

T

O valor a ser resolvido com após um tempo limite de t milissegundos.

Retornos

Promise<T>

Promessa resolvida

deserializationPolicy(DeserializationContentTypes)

Crie uma nova serialização RequestPolicyCreator que serializará corpos de solicitação HTTP conforme eles passarem pelo pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parâmetros

deserializationContentTypes
DeserializationContentTypes

Retornos

RequestPolicyFactory

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

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

Parâmetros

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Retornos

Promise<HttpOperationResponse>

encodeUri(string)

Codifica um URI.

function encodeUri(uri: string): string

Parâmetros

uri

string

O URI a ser codificado.

Retornos

string

O URI codificado.

executePromisesSequentially(any[], any)

Executa uma matriz de promessas sequencialmente. A inspiração desse método está aqui: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Um blog incrível sobre promessas!

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

Parâmetros

promiseFactories

any[]

Uma matriz de fábricas de promessas (uma função que retorna uma promessa)

kickstart

any

Entrada para a primeira promessa que é usada para iniciar a cadeia de promessas. Se não for fornecido, a cadeia de promessas começará com indefinido.

Retornos

Promise<any>

Uma cadeia de promessas resolvidas ou rejeitadas

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

Retornos

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parâmetros

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Retornos

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parâmetros

requestIdHeaderName

string

Retornos

RequestPolicyFactory

generateUuid()

UUID gerado

function generateUuid(): string

Retornos

string

RFC4122 v4 UUID.

getDefaultProxySettings(string) 

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

Parâmetros

proxyUrl

string

Retornos

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Retornos

string

isDuration(string)

Indica se a cadeia de caracteres fornecida está no formato ISO 8601.

function isDuration(value: string): boolean

Parâmetros

value

string

O valor a ser validado para o formato de duração ISO 8601.

Retornos

boolean

true se for válido, false caso contrário.

isValidUuid(string)

Valida o uuid especificado como uma cadeia de caracteres

function isValidUuid(uuid: string): boolean

Parâmetros

uuid

string

O uuid como uma cadeia de caracteres que precisa ser validada

Retornos

boolean

True se o uuid for válido; caso contrário, false.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parâmetros

logger

any

Retornos

RequestPolicyFactory

promiseToCallback(Promise<any>)

Aviso

Essa API foi preterida.

generated code should instead depend on responseToBody

Converte uma Promessa em um retorno de chamada.

function promiseToCallback(promise: Promise<any>): Function

Parâmetros

promise

Promise<any>

A Promessa a ser convertida em um retorno de chamada

Retornos

Function

Uma função que recebe o retorno de chamada (cb: Function): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte uma Promessa em um retorno de chamada de serviço.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function

Parâmetros

promise

Promise<HttpOperationResponse>

A Promessa de HttpOperationResponse a ser convertida em um retorno de chamada de serviço

Retornos

Function

Uma função que usa o retorno de chamada de serviço (cb: ServiceCallback): void

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parâmetros

proxySettings
ProxySettings

Retornos

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parâmetros

maximumRetries

number

Retornos

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parâmetros

toSerialize

any

Retornos

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parâmetros

authenticationProvider
ServiceClientCredentials

Retornos

RequestPolicyFactory

stripRequest(WebResourceLike)

Retorna uma versão despojada da Solicitação Http que não contém o cabeçalho Autorização.

function stripRequest(request: WebResourceLike): WebResourceLike

Parâmetros

request
WebResourceLike

O objeto Http Request

Retornos

WebResourceLike

A versão despojada da Solicitação Http.

stripResponse(HttpOperationResponse)

Retorna uma versão despojada da Resposta Http que contém apenas corpo, cabeçalhos e o status.

function stripResponse(response: HttpOperationResponse): any

Parâmetros

response
HttpOperationResponse

A resposta http

Retornos

any

A versão despojada do Http Response.

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

Retornos

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parâmetros

maxRetries

number

Retornos

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parâmetros

userAgentData
TelemetryInfo

Retornos

RequestPolicyFactory