@azure/core-http package

Classes

AccessTokenRefresher	Ajuda as políticas de autenticação de token core-http a solicitar um novo token se não estivermos aguardando um novo token no momento.
ApiKeyCredentials	Autentica-se em um serviço usando uma chave de API.
BaseRequestPolicy	A classe base da qual todas as políticas de solicitação derivam.
BasicAuthenticationCredentials	Um simples <xref:ServiceClientCredential> que se autentica com um nome de usuário e uma senha.
DefaultHttpClient	Um cliente HTTP que usa node-fetch.
ExpiringAccessTokenCache	Fornece uma implementação accessTokenCache que limpa o AccessToken armazenado em cache após o expiresOnTimestamp ter passado.
HttpHeaders	Uma coleção de pares chave/valor de cabeçalho HTTP.
RequestPolicyOptions	Propriedades opcionais que podem ser usadas ao criar uma RequestPolicy.
RestError	Um erro resultante de uma solicitação HTTP para um ponto de extremidade de serviço.
Serializer	Usado para mapear objetos de resposta brutos para formas finais. Ajuda a empacotar e desempacotar Datas e outros tipos codificados que não são intrínsecos ao JSON. Também permite extrair valores de cabeçalhos, bem como inserir valores e constantes padrão.
ServiceClient	ServiceClient envia solicitações de serviço e recebe respostas.
TopicCredentials	Um objeto TopicCredentials usado para Grade de Eventos do Azure.
URLBuilder	Uma classe que manipula 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. 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.
AccessToken	Representa um token de acesso com um tempo de expiração.
AccessTokenCache	Fornece um cache para um AccessToken que foi retornado de um TokenCredential.
ApiKeyCredentialOptions	Descreve as opções a serem fornecidas ao criar uma instância de ApiKeyCredentials
BaseMapper	A definição base de um mapeador. Pode ser usado para objetos XML e JavaScript simples.
CompositeMapper	Um mapeador composto por outros mapeados.
CompositeMapperType	Ajuda a criar um mapeador que descreve como mapear um conjunto de propriedades de um objeto com base em outros mapeados. Apenas uma das seguintes propriedades deve estar presente: className, modelProperties e additionalProperties.
DeserializationContentTypes	Os tipos de conteúdo que indicarão que uma resposta de operação deve ser desserializada de uma maneira específica.
DeserializationOptions	Opções para configurar a desserialização de resposta da API.
DictionaryMapper	Um mapeador que descreve objetos JavaScript simples usados como pares chave/valor.
DictionaryMapperType	Ajuda a criar um mapeador que descreve como analisar um dicionário de valores mapeados.
EnumMapper	Um mapeador que descreve um valor de enumeração.
EnumMapperType	Ajuda a criar um mapeador que descreve como analisar um valor de enumeração.
GetTokenOptions	Define opções para TokenCredential.getToken.
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.
InternalPipelineOptions	Define as opções usadas para configurar opções internas do pipeline HTTP para um cliente do SDK.
KeepAliveOptions	Opções de como as conexões HTTP devem ser mantidas para solicitações futuras.
LogPolicyOptions	Opções para passar para o logPolicy. Por padrão, apenas uma lista de conjuntos de cabeçalhos é registrada, embora isso possa ser configurado. Os corpos de solicitação e resposta nunca são registrados.
MapperConstraints	Descrição de várias restrições de valor, como intervalos inteiros e regex de cadeia de caracteres.
OperationArguments	Uma coleção de propriedades que se aplicam a uma única invocação de uma operação.
OperationOptions	O tipo de opções base para todas as operações.
OperationParameter	Uma interface comum que todos os parâmetros de 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.
OperationRequestOptions	Opções que permitem configurar o tratamento de solicitações HTTP feitas por uma operação do SDK.
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 como executar uma operação de serviço específica por HTTP, incluindo como serializar corretamente as informações de solicitação em e desserializar informações de resposta em uma carga de objeto retornada pelo ServiceClient.
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
PipelineOptions	Define as opções usadas para configurar o pipeline HTTP para um cliente do SDK.
PolymorphicDiscriminator	Usado para desambiguar uniões de tipos discriminados. Por exemplo, se a resposta puder ter muitas formas, mas também incluir um campo "tipo" (ou semelhante), esse campo poderá ser usado para determinar como desserializar a resposta ao tipo correto.
ProxySettings	Opções para configurar um proxy para solicitações de saída (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 todas as operações.
RequestPolicy	A estrutura subjacente de uma política de solicitação.
RequestPolicyOptionsLike	Propriedades opcionais que podem ser usadas ao criar uma RequestPolicy.
RequestPrepareOptions	Opções para preparar uma solicitação HTTP de saída.
RestResponse	A resposta nivelada para uma chamada REST. Contém o HttpOperationResponse subjacente, bem como as propriedades mescladas do parsedBody, parsedHeadersetc.
RetryOptions	Opções que controlam como repetir solicitações com falha.
SequenceMapper	Um mapeador que descreve matrizes.
SequenceMapperType	Ajuda a criar um mapeador que descreve como analisar uma sequência de valores mapeados.
SerializerOptions	Opções para controlar o comportamento do analisador xml e do construtor.
ServiceCallback
ServiceClientCredentials	Representa um objeto ou classe com um signRequest método que assinará solicitações de saída (por exemplo, definindo o Authorization cabeçalho).
ServiceClientOptions	Opções a serem fornecidas durante a criação do cliente.
SimpleMapperType	O tipo de um mapeador simples.
TokenCredential	Representa uma credencial capaz de fornecer um token de autenticação.
TracingPolicyOptions	Opções para personalizar a política de rastreamento.
UrlParameterValue	Uma interface que representa um valor de parâmetro de URL.
UserAgentOptions	Opções para adicionar detalhes do agente de usuário a solicitações de saída.
WebResourceLike	Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

Aliases de tipo

Authenticator	Uma função que recebe um desafio e resolve uma promessa com um token de cadeia de caracteres.
CommonRequestInfo	URLs de cadeia de caracteres usadas ao chamar para fetch().
CommonRequestInit	Um objeto que contém informações sobre a solicitação HTTP de saída.
CommonResponse	Um objeto que contém informações sobre a resposta HTTP de entrada.
HttpMethods	Lista de métodos HTTP com suporte.
HttpRequestBody	Possíveis tipos de corpo de solicitação HTTP
Mapper	Mapeados são definições dos modelos de dados usados na biblioteca. Esses modelos de dados fazem parte das definições de Operação ou Cliente nas respostas ou parâmetros.
MapperType	Tipo do mapeador. Inclui mapeados conhecidos.
ParameterPath	Um caminho que descreve como acessar uma propriedade específica em uma determinada fonte de dados de objeto. Pode ser um único nome de propriedade, uma matriz que denota nomes de propriedade aninhados ou um conjunto de várias propriedades nomeadas com caminhos no caso de valores de objeto complexos.
ProxyOptions	Um alias de ProxySettings para uso futuro.
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	Informações de telemetria. Pares chave/valor a serem incluídos dentro da cadeia de caracteres User-Agent.
TransferProgressEvent	Acionada 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.
RetryMode	Descreve o tipo modo de repetição. Atualmente, há suporte apenas para Exponencial.

Funções

applyMixins(unknown, any[])	Aplica as propriedades no protótipo de sourceCtors ao protótipo do targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	Cria uma nova fábrica para um RequestPolicy que aplica um token de portador aos cabeçalhos das Authorization solicitações.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Cria um pipeline HTTP com base nas opções fornecidas.
delay(number, DelayOptions)	Um wrapper para setTimeout que resolve uma promessa após milissegundos timeInMs.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Crie uma nova solicitação de serializaçãoPolicyCreator que serializará corpos de solicitação HTTP à medida que passarem pelo pipeline HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Dado um determinado conjunto de tipos de conteúdo a serem analisados como JSON ou XML, consome a resposta HTTP para produzir o objeto de resultado definido pelo OperationSpec da solicitação.
disableResponseDecompressionPolicy()	Retorna um alocador de política de solicitação que pode ser usado para criar uma instância do <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Codifica um URI.
executePromisesSequentially(any[], unknown)	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)	Política que tenta novamente a solicitação quantas vezes estiver configurada, desde que o intervalo de tempo máximo de repetição especificado, cada uma tente aguardar mais tempo para começar do que da última vez.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	Analisa um HttpOperationResponse em um objeto de resposta HTTP normalizado (RestResponse).
generateClientRequestIdPolicy(string)	Cria uma política que atribui uma ID de solicitação exclusiva a solicitações de saída.
generateUuid()	UUID gerado
getDefaultProxySettings(string)	Converte uma determinada URL de um servidor proxy em ProxySettings ou tenta recuperar ProxySettings do ambiente atual se uma não for passada.
getDefaultUserAgentValue()	A abordagem padrão para gerar agentes de usuário. Usa informações estáticas desse pacote, além de informações do sistema disponíveis no runtime.
isDuration(string)	Indica se a cadeia de caracteres fornecida está no formato ISO 8601.
isTokenCredential(unknown)	Testa um objeto para determinar se ele implementa TokenCredential.
isValidUuid(string)	Valida o uuid especificado como uma cadeia de caracteres
keepAlivePolicy(KeepAliveOptions)	Cria uma política que controla se as conexões HTTP são mantidas em solicitações futuras.
logPolicy(LogPolicyOptions)	Cria uma política que registra informações sobre a solicitação de saída e as respostas de entrada.
operationOptionsToRequestOptionsBase<T>(T)	Converte um OperationOptions em um RequestOptionsBase
parseXML(string, SerializerOptions)	Converte a cadeia de caracteres XML fornecida em JSON
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, { customNoProxyList?: string[] })	Uma política que permite aplicar configurações de proxy a todas as solicitações. Se não forem passadas configurações estáticas, elas serão recuperadas das variáveis de ambiente HTTPS_PROXY ou HTTP_PROXY.
redirectPolicy(number)	Cria uma política de redirecionamento, que envia uma solicitação repetida para um novo destino se uma resposta chegar com um cabeçalho "local" e um código de status entre 300 e 307.
serializeObject(unknown)	Função de utilitário que serializa um objeto que pode conter informações binárias em um objeto simples, uma matriz ou uma cadeia de caracteres.
signingPolicy(ServiceClientCredentials)	Cria uma política que assina solicitações de saída chamando para o método fornecidoauthenticationProvidersignRequest.
stringifyXML(unknown, SerializerOptions)	Converte determinado objeto JSON em cadeia de caracteres XML
stripRequest(WebResourceLike)	Retorna uma versão despojada da Solicitação Http que não contém o cabeçalho Authorization.
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)	Uma política que tenta novamente quando há um erro do sistema, identificado pelos códigos "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" ou "ENOENT".
throttlingRetryPolicy()	Cria uma política que envia novamente a solicitação se a resposta indicar que a solicitação falhou devido a motivos de limitação. Por exemplo, se a resposta contiver um Retry-After cabeçalho, ela tentará enviar novamente a solicitação com base no valor desse cabeçalho. Para saber mais, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits e https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Cria uma política que encapsula solicitações de saída com um intervalo de rastreamento.
userAgentPolicy(TelemetryInfo)	Retorna uma política que adiciona o cabeçalho do agente de usuário a solicitações de saída com base no TelemetryInfo especificado.

Detalhes da função

applyMixins(unknown, any[])

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

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Parâmetros

targetCtorParam

unknown

sourceCtors

any[]

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Cria uma nova fábrica para um RequestPolicy que aplica um token de portador aos cabeçalhos das Authorization solicitações.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Parâmetros

credential

TokenCredential

A implementação de TokenCredential que pode fornecer o token de portador.

scopes

string | string[]

Os escopos para os quais o token de portador se aplica.

Retornos

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Cria um pipeline HTTP com base nas opções fornecidas.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Parâmetros

pipelineOptions

InternalPipelineOptions

Define as opções usadas para configurar políticas no pipeline HTTP para um cliente do SDK.

authPolicyFactory

RequestPolicyFactory

Uma fábrica de políticas de autenticação opcional a ser usada para solicitações de assinatura.

Retornos

ServiceClientOptions

Um conjunto de opções que podem ser passadas para criar um novo ServiceClient.

delay(number, DelayOptions)

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

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Parâmetros

timeInMs

number

O número de milissegundos a serem atrasados.

options

DelayOptions

As opções de atraso – opções de anulação no momento

Retornos

Promise<void>

Promessa que é resolvida após timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Crie uma nova solicitação de serializaçãoPolicyCreator que serializará corpos de solicitação HTTP à medida que passarem pelo pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parâmetros

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

Retornos

RequestPolicyFactory

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

Dado um determinado conjunto de tipos de conteúdo a serem analisados como JSON ou XML, consome a resposta HTTP para produzir o objeto de resultado definido pelo OperationSpec da solicitação.

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

Parâmetros

jsonContentTypes

string[]

Tipos de conteúdo de resposta para analisar o corpo como JSON.

xmlContentTypes

string[]

Tipos de conteúdo de resposta para analisar o corpo como XML.

response

HttpOperationResponse

Resposta HTTP do pipeline.

options

SerializerOptions

Opções para o serializador, principalmente para configurar o analisador XML, se necessário.

Retornos

Promise<HttpOperationResponse>

Um objeto HttpOperationResponse analisado que pode ser retornado pelo ServiceClient.

disableResponseDecompressionPolicy()

Retorna um alocador de política de solicitação que pode ser usado para criar uma instância do <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Retornos

RequestPolicyFactory

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[], unknown)

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: unknown): Promise<any>

Parâmetros

promiseFactories

any[]

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

kickstart

unknown

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)

Política que tenta novamente a solicitação quantas vezes estiver configurada, desde que o intervalo de tempo máximo de repetição especificado, cada uma tente aguardar mais tempo para começar do que da última vez.

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

Parâmetros

retryCount

number

Número máximo de tentativas.

retryInterval

number

Tempo base entre novas tentativas.

maxRetryInterval

number

Tempo máximo de espera entre novas tentativas.

Retornos

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analisa um HttpOperationResponse em um objeto de resposta HTTP normalizado (RestResponse).

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

Parâmetros

_response

HttpOperationResponse

Objeto wrapper para resposta http.

responseSpec

undefined | OperationResponse

Mapeadores para saber como analisar as propriedades de resposta.

Retornos

RestResponse

• Um objeto de resposta normalizado.

generateClientRequestIdPolicy(string)

Cria uma política que atribui uma ID de solicitação exclusiva a solicitações de saída.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parâmetros

requestIdHeaderName

string

O nome do cabeçalho a ser usado ao atribuir a ID exclusiva à solicitação.

Retornos

RequestPolicyFactory

generateUuid()

UUID gerado

function generateUuid(): string

Retornos

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Converte uma determinada URL de um servidor proxy em ProxySettings ou tenta recuperar ProxySettings do ambiente atual se uma não for passada.

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

Parâmetros

proxyUrl

string

URL do proxy

Retornos

ProxySettings | undefined

As configurações de proxy padrão ou indefinidas.

getDefaultUserAgentValue()

A abordagem padrão para gerar agentes de usuário. Usa informações estáticas desse pacote, além de informações do sistema disponíveis no runtime.

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.

isTokenCredential(unknown)

Testa um objeto para determinar se ele implementa TokenCredential.

function isTokenCredential(credential: unknown): credential

Parâmetros

credential

unknown

O TokenCredential assumido a ser testado.

Retornos

credential

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.

keepAlivePolicy(KeepAliveOptions)

Cria uma política que controla se as conexões HTTP são mantidas em solicitações futuras.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parâmetros

keepAliveOptions

KeepAliveOptions

Mantenha as opções ativas. Por padrão, as conexões HTTP são mantidas para solicitações futuras.

Retornos

RequestPolicyFactory

Uma instância do <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Cria uma política que registra informações sobre a solicitação de saída e as respostas de entrada.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parâmetros

loggingOptions

LogPolicyOptions

Opções de registro em log.

Retornos

RequestPolicyFactory

Uma instância do <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Converte um OperationOptions em um RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Parâmetros

opts

T

Objeto OperationOptions a ser convertido em RequestOptionsBase

Retornos

RequestOptionsBase

parseXML(string, SerializerOptions)

Converte a cadeia de caracteres XML fornecida em JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Parâmetros

str

string

Cadeia de caracteres que contém o conteúdo XML a ser analisado em JSON

opts

SerializerOptions

Opções que regem a análise de determinada cadeia de caracteres xml

Retornos

Promise<any>

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>): (cb: Function) => void

Parâmetros

promise

Promise<any>

A Promessa a ser convertida em um retorno de chamada

Retornos

(cb: Function) => void

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>): (cb: ServiceCallback<T>) => void

Parâmetros

promise

Promise<HttpOperationResponse>

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

Retornos

(cb: ServiceCallback<T>) => void

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

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Uma política que permite aplicar configurações de proxy a todas as solicitações. Se não forem passadas configurações estáticas, elas serão recuperadas das variáveis de ambiente HTTPS_PROXY ou HTTP_PROXY.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): RequestPolicyFactory

Parâmetros

proxySettings

ProxySettings

ProxySettings a serem usados em cada solicitação.

options

{ customNoProxyList?: string[] }

configurações adicionais, por exemplo, padrões de NO_PROXY personalizados

Retornos

RequestPolicyFactory

redirectPolicy(number)

Cria uma política de redirecionamento, que envia uma solicitação repetida para um novo destino se uma resposta chegar com um cabeçalho "local" e um código de status entre 300 e 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parâmetros

maximumRetries

number

Número máximo de redirecionamentos a seguir.

Retornos

RequestPolicyFactory

Uma instância do <xref:RedirectPolicy>

serializeObject(unknown)

Função de utilitário que serializa um objeto que pode conter informações binárias em um objeto simples, uma matriz ou uma cadeia de caracteres.

function serializeObject(toSerialize: unknown): any

Parâmetros

toSerialize

unknown

Retornos

any

signingPolicy(ServiceClientCredentials)

Cria uma política que assina solicitações de saída chamando para o método fornecidoauthenticationProvidersignRequest.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parâmetros

authenticationProvider

ServiceClientCredentials

O provedor de autenticação.

Retornos

RequestPolicyFactory

Uma instância do <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Converte determinado objeto JSON em cadeia de caracteres XML

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Parâmetros

obj

unknown

Objeto JSON a ser convertido em cadeia de caracteres XML

opts

SerializerOptions

Opções que regem a análise de determinado objeto JSON

Retornos

string

stripRequest(WebResourceLike)

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

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 da Resposta Http.

systemErrorRetryPolicy(number, number, number, number)

Uma política que tenta novamente quando há um erro do sistema, identificado pelos códigos "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" ou "ENOENT".

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

Parâmetros

retryCount

number

Número máximo de tentativas.

retryInterval

number

O intervalo de repetição do cliente, em milissegundos.

minRetryInterval

number

O intervalo mínimo de repetição, em milissegundos.

maxRetryInterval

number

O intervalo máximo de repetição, em milissegundos.

Retornos

RequestPolicyFactory

Uma instância do <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Cria uma política que envia novamente a solicitação se a resposta indicar que a solicitação falhou devido a motivos de limitação. Por exemplo, se a resposta contiver um Retry-After cabeçalho, ela tentará enviar novamente a solicitação com base no valor desse cabeçalho.

Para saber mais, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits e https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Retornos

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Cria uma política que encapsula solicitações de saída com um intervalo de rastreamento.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parâmetros

tracingOptions

TracingPolicyOptions

Opções de rastreamento.

Retornos

RequestPolicyFactory

Uma instância da classe <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Retorna uma política que adiciona o cabeçalho do agente de usuário a solicitações de saída com base no TelemetryInfo especificado.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parâmetros

userAgentData

TelemetryInfo

Informações de telemetria.

Retornos

RequestPolicyFactory

Um novo <xref:UserAgentPolicy>.