Partilhar via

@azure/ms-rest-js package

  • Referência

Classes

ApiKeyCredentials

Autentica-se num serviço com uma chave de API.
AzureIdentityCredentialAdapter

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

Autentica-se num serviço com uma chave de API.
HttpHeaders

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

Propriedades opcionais que podem ser utilizadas ao criar um RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials

Um objeto de credenciais que utiliza uma cadeia de tokens e um esquema de criação para autenticar.
TopicCredentials

Autentica-se num serviço com uma chave de API.
URLBuilder

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

Uma classe que processa a parte da consulta de um URLBuilder.
WebResource

Cria um novo objeto WebResource.

Esta classe fornece uma abstração através de uma chamada REST por ser agnóstica de biblioteca/implementação e encapsular as propriedades necessárias para iniciar um pedido.

Interfaces

AbortSignalLike

Permite que o pedido seja abortado após o acionamento do evento "abortar". Compatível com o browser AbortSignal incorporado e polifills comuns.
AgentSettings

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

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

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

Um cabeçalho individual numa coleção httpHeaders.
HttpHeadersLike

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

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

Um Logger que pode ser adicionado a um HttpPipeline. Isto permite que cada RequestPolicy registe mensagens que podem ser utilizadas para fins de depuração.
HttpResponse

As propriedades numa resposta HTTP que estarão sempre 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 expandem.
OperationQueryParameter

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

Uma OperationResponse que pode ser devolvida a partir de um pedido de operação para um único código de estado.
OperationSpec

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

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

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

Definições de proxy HTTP (apenas Node.js)
RedirectOptions

Opções para a forma como as respostas de redirecionamento são processadas.
RequestOptionsBase

Descreve a estrutura base do objeto de opções que será utilizado em todas as operações.
RequestPolicy
RequestPolicyOptionsLike

Propriedades opcionais que podem ser utilizadas ao criar um RequestPolicy.
RequestPrepareOptions
RestResponse

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

Opções a fornecer ao criar o cliente.
SimpleMapperType
TokenResponse

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

Uma abstração sobre 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 um novo RequestPolicy por pedido que utiliza a nextPolicy fornecida.
TelemetryInfo
TransferProgressEvent

Acionado em resposta ao progresso do carregamento ou transferência.

Enumerações

HttpPipelineLogLevel

Os diferentes níveis de registos que podem ser utilizados com o HttpPipelineLogger.
QueryCollectionFormat

O formato que será utilizado para associar 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 do targetCtor
delay<T>(number, T)

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

Crie um novo RequestPolicyCreator de serialização que serializará os organismos de pedidos HTTP à medida que passam pelo pipeline HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

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

Executa uma matriz de promessas sequencialmente. A inspiração deste método está aqui: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Um blogue fantástico 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 especificada está no formato ISO 8601.
isValidUuid(string)

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

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

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

Devolve uma versão despojada do Pedido http que não contém o cabeçalho Autorização.
stripResponse(HttpOperationResponse)

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

Detalhes de Função

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parâmetros

agentSettings
AgentSettings

Devoluções

RequestPolicyFactory

applyMixins(any, any[])

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

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

Parâmetros

targetCtor

any

O objeto de destino no qual as propriedades têm de ser aplicadas.

sourceCtors

any[]

Uma matriz de objetos de origem a partir dos quais as propriedades têm de ser tomadas.

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 atrasar.

value

T

O valor a resolver após um tempo limite de t milissegundos.

Devoluções

Promise<T>

Promessa resolvida

deserializationPolicy(DeserializationContentTypes)

Crie um novo RequestPolicyCreator de serialização que serializará os organismos de pedidos HTTP à medida que passam pelo pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parâmetros

deserializationContentTypes
DeserializationContentTypes

Devoluções

RequestPolicyFactory

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

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

Parâmetros

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Devoluções

Promise<HttpOperationResponse>

encodeUri(string)

Codifica um URI.

function encodeUri(uri: string): string

Parâmetros

uri

string

O URI a codificar.

Devoluções

string

O URI codificado.

executePromisesSequentially(any[], any)

Executa uma matriz de promessas sequencialmente. A inspiração deste método está aqui: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Um blogue fantástico 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 devolve uma promessa)

kickstart

any

Entrada para a primeira promessa que é usada para iniciar a cadeia de promessas. Se não for fornecida, a cadeia de promessas começa com indefinição.

Devoluções

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

Devoluções

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parâmetros

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Devoluções

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parâmetros

requestIdHeaderName

string

Devoluções

RequestPolicyFactory

generateUuid()

UUID gerado

function generateUuid(): string

Devoluções

string

RFC4122 v4 UUID.

getDefaultProxySettings(string) 

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

Parâmetros

proxyUrl

string

Devoluções

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Devoluções

string

isDuration(string)

Indica se a cadeia especificada está no formato ISO 8601.

function isDuration(value: string): boolean

Parâmetros

value

string

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

Devoluções

boolean

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

isValidUuid(string)

Valida o uuid especificado como uma cadeia

function isValidUuid(uuid: string): boolean

Parâmetros

uuid

string

O uuid como uma cadeia que precisa de ser validada

Devoluções

boolean

Verdadeiro se o uuid for válido; falso de outra forma.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parâmetros

logger

any

Devoluções

RequestPolicyFactory

promiseToCallback(Promise<any>)

Aviso

Esta API foi preterida.

generated code should instead depend on responseToBody

Converte uma Promessa numa chamada de retorno.

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

Parâmetros

promise

Promise<any>

A Promessa de ser convertida numa chamada de retorno

Devoluções

Function

Uma função que recebe a chamada de retorno (cb: Função): nulo

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte uma Promessa numa chamada de retorno de serviço.

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

Parâmetros

promise

Promise<HttpOperationResponse>

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

Devoluções

Function

Uma função que recebe a chamada de retorno do serviço (cb: ServiceCallback): nulo

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parâmetros

proxySettings
ProxySettings

Devoluções

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parâmetros

maximumRetries

number

Devoluções

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parâmetros

toSerialize

any

Devoluções

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parâmetros

authenticationProvider
ServiceClientCredentials

Devoluções

RequestPolicyFactory

stripRequest(WebResourceLike)

Devolve uma versão despojada do Pedido http que não contém o cabeçalho Autorização.

function stripRequest(request: WebResourceLike): WebResourceLike

Parâmetros

request
WebResourceLike

O objeto Http Request

Devoluções

WebResourceLike

A versão despojada do Pedido Http.

stripResponse(HttpOperationResponse)

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

function stripResponse(response: HttpOperationResponse): any

Parâmetros

response
HttpOperationResponse

A Resposta http

Devoluções

any

A versão despojada da Resposta 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

Devoluções

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parâmetros

maxRetries

number

Devoluções

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parâmetros

userAgentData
TelemetryInfo

Devoluções

RequestPolicyFactory