@azure/ms-rest-js package

Classes

ApiKeyCredentials	Autentica em um serviço usando uma chave de API.
AzureIdentityCredentialAdapter	Essa classe fornece uma extensão simples para usar <xref:TokenCredential> de @azure/identity biblioteca para usar com SDKs do Azure herdados que aceitam ServiceClientCredentials família de credenciais para autenticação.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	Autentica 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 um RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials	Um objeto de credenciais que usa uma cadeia de caracteres de token e um esquema de autorização para autenticar.
TopicCredentials	Autentica em um serviço usando uma chave de API.
URLBuilder	Uma classe que lida com a criação, modificação e análise de URLs.
URLQuery	Uma classe que manipula a parte de consulta de um URLBuilder.
WebResource	Cria um novo objeto WebResource. Esta classe fornece uma abstração sobre 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 abortada após o disparo do evento "abort". Compatível com o navegador built-in AbortSignal e polyfills comuns.
AgentSettings	Agentes HTTP e HTTPS (apenasNode.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 propriedade parsedBody quando o corpo da resposta é recebido em JSON ou XML.
HttpPipelineLogger	Um Logger 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á presente.
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 Operation estendem.
OperationQueryParameter	Um parâmetro para uma operação que será adicionado 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 (somenteNode.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 um RequestPolicy.
RequestPrepareOptions
RestResponse	A resposta achatada a uma chamada REST. Contém o subjacente HttpOperationResponse, 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 sobre uma chamada REST.

Alias de Tipo

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
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	Disparado em resposta ao progresso do upload ou download.

Enums

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 um novo RequestPolicyCreator de serialização que serializará corpos de solicitação HTTP à medida que 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 deste 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 fornecido 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 removida da solicitação Http que não contém o cabeçalho Authorization.
stripResponse(HttpOperationResponse)	Retorna uma versão removida da resposta http que contém apenas corpo, cabeçalhos e o status.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Variáveis

MapperType
Constants
isNode	Uma constante que indica se o ambiente é node.js ou baseado num navegador.

Detalhes da Função

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parâmetros

agentSettings

AgentSettings

Regressos

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 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 ser resolvido após um tempo limite de t milissegundos.

Regressos

Promise<T>

Promessa resolvida

deserializationPolicy(DeserializationContentTypes)

Crie um novo RequestPolicyCreator de serialização que serializará corpos de solicitação HTTP à medida que eles passarem pelo pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parâmetros

deserializationContentTypes

DeserializationContentTypes

Regressos

RequestPolicyFactory

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

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

Parâmetros

jsonContentTypes

string[]

xmlContentTypes

string[]

response

HttpOperationResponse

Regressos

Promise<HttpOperationResponse>

encodeUri(string)

Codifica um URI.

function encodeUri(uri: string): string

Parâmetros

uri

string

O URI a ser codificado.

Regressos

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 blog incrível sobre promessas!

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

Parâmetros

promiseFactories

any[]

Uma série de fábricas de promessa (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 fornecida, a cadeia de promessas começa com indefinida.

Regressos

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

Regressos

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

Parâmetros

_response

HttpOperationResponse

responseSpec

undefined | OperationResponse

Regressos

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parâmetros

requestIdHeaderName

string

Regressos

RequestPolicyFactory

generateUuid()

UUID gerado

function generateUuid(): string

Regressos

string

RFC4122 UUID v4.

getDefaultProxySettings(string)

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

Parâmetros

proxyUrl

string

Regressos

ProxySettings | undefined

getDefaultUserAgentValue()

function getDefaultUserAgentValue(): string

Regressos

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.

Regressos

boolean

true se for válido, false de outra forma.

isValidUuid(string)

Valida o uuid fornecido 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

Regressos

boolean

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

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

Parâmetros

logger

any

Regressos

RequestPolicyFactory

promiseToCallback(Promise<any>)

Aviso

Esta API está agora obsoleta.

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 de ser convertido em um retorno de chamada

Regressos

Function

Uma função que recebe o retorno de chamada (cb: Função): 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 convertido em um retorno de chamada de serviço

Regressos

Function

Uma função que leva o retorno de chamada de serviço (cb: ServiceCallback<T>): void

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parâmetros

proxySettings

ProxySettings

Regressos

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parâmetros

maximumRetries

number

Regressos

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

Parâmetros

toSerialize

any

Regressos

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parâmetros

authenticationProvider

ServiceClientCredentials

Regressos

RequestPolicyFactory

stripRequest(WebResourceLike)

Retorna uma versão removida da solicitação Http que não contém o cabeçalho Authorization.

function stripRequest(request: WebResourceLike): WebResourceLike

Parâmetros

request

WebResourceLike

O objeto Http Request

Regressos

WebResourceLike

A versão despojada do Http Request.

stripResponse(HttpOperationResponse)

Retorna uma versão removida 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

Regressos

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

Regressos

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parâmetros

maxRetries

number

Regressos

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parâmetros

userAgentData

TelemetryInfo

Regressos

RequestPolicyFactory

Variable Details

MapperType

MapperType: { Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }

Tipo

{ Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }

Constants

Constants: { ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { TooManyRequests: number } }, NO_PROXY: string, msRestVersion: string }

Tipo

{ ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { TooManyRequests: number } }, NO_PROXY: string, msRestVersion: string }

isNode

Uma constante que indica se o ambiente é node.js ou baseado num navegador.

isNode: boolean

Tipo

boolean