@azure/ms-rest-js package
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 |
| 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 |
| 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 |
| 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
Detalhes da função
agentPolicy(AgentSettings)
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactoryParâmetros
- agentSettings
- AgentSettings
Retornos
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): RequestPolicyFactoryParâmetros
- deserializationContentTypes
- DeserializationContentTypes
Retornos
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): stringParâ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): RequestPolicyFactoryParâmetros
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
Retornos
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponseParâmetros
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
Retornos
generateClientRequestIdPolicy(string)
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactoryParâmetros
- requestIdHeaderName
-
string
Retornos
generateUuid()
UUID gerado
function generateUuid(): stringRetornos
string
RFC4122 v4 UUID.
getDefaultProxySettings(string)
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefinedParâmetros
- proxyUrl
-
string
Retornos
ProxySettings | undefined
getDefaultUserAgentValue()
function getDefaultUserAgentValue(): stringRetornos
string
isDuration(string)
Indica se a cadeia de caracteres fornecida está no formato ISO 8601.
function isDuration(value: string): booleanParâ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): booleanParâ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): RequestPolicyFactoryParâmetros
- logger
-
any
Retornos
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>): FunctionParâ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>): FunctionParâ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): RequestPolicyFactoryParâmetros
- proxySettings
- ProxySettings
Retornos
redirectPolicy(number)
function redirectPolicy(maximumRetries?: number): RequestPolicyFactoryParâmetros
- maximumRetries
-
number
Retornos
serializeObject(any)
function serializeObject(toSerialize: any): anyParâmetros
- toSerialize
-
any
Retornos
any
signingPolicy(ServiceClientCredentials)
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactoryParâmetros
- authenticationProvider
- ServiceClientCredentials
Retornos
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): WebResourceLikeParâmetros
- request
- WebResourceLike
O objeto Http Request
Retornos
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): anyParâ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): RequestPolicyFactoryParâmetros
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
Retornos
throttlingRetryPolicy(number)
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactoryParâmetros
- maxRetries
-
number
Retornos
userAgentPolicy(TelemetryInfo)
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactoryParâmetros
- userAgentData
- TelemetryInfo