Partilhar via


@azure/core-http package

Classes

AccessTokenRefresher

Ajuda as políticas de autenticação de tokens core-http a pedir um novo token se não estivermos atualmente à espera de um novo token.

ApiKeyCredentials

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

BaseRequestPolicy

A classe base a partir da qual todas as políticas de pedido derivam.

BasicAuthenticationCredentials

Um simples <xref:ServiceClientCredential> que se autentica com um nome de utilizador e uma palavra-passe.

DefaultHttpClient

Um cliente HTTP que utiliza node-fetch.

ExpiringAccessTokenCache

Fornece uma implementação do AccessTokenCache que limpa os AccessTokens em cache após a passagem de expiresOnTimestamp.

HttpHeaders

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

RequestPolicyOptions

Propriedades opcionais que podem ser utilizadas ao criar uma RequestPolicy.

RestError

Um erro resultante de um pedido HTTP para um ponto final de serviço.

Serializer

Utilizado para mapear objetos de resposta não processados 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 predefinidos.

ServiceClient

ServiceClient envia pedidos de serviço e recebe respostas.

TopicCredentials

Um objeto TopicCredentials utilizado para Azure Event Grid.

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 sobre uma chamada REST ao 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 ao acionar o evento "abortar". Compatível com o browser abortSignal incorporado e polifills comuns.

AccessToken

Representa um token de acesso com um tempo de expiração.

AccessTokenCache

Fornece uma cache para um AccessToken que foi devolvido de um TokenCredential.

ApiKeyCredentialOptions

Descreve as opções a fornecer ao criar uma instância de ApiKeyCredentials

BaseMapper

A definição base de um mapeador. Pode ser utilizado para objetos XML e JavaScript simples.

CompositeMapper

Um mapeador composto por outros mapeadores.

CompositeMapperType

Ajuda a criar um mapeador que descreve como mapear um conjunto de propriedades de um objeto com base noutros mapeadores.

Só deve estar presente uma das seguintes propriedades: classNamee modelPropertiesadditionalProperties.

DeserializationContentTypes

Os tipos de conteúdo que indicam que uma resposta de operação deve ser desserializada de uma forma específica.

DeserializationOptions

Opções para configurar a desserialização da resposta da API.

DictionaryMapper

Um mapeador que descreve objetos JavaScript simples utilizados 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 numa coleção httpHeaders.

HttpHeadersLike

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

HttpOperationResponse

Objeto wrapper para pedido http e resposta. O objeto serializado é 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.

InternalPipelineOptions

Define as opções que são utilizadas para configurar opções internas do pipeline HTTP para um cliente SDK.

KeepAliveOptions

Opções para manter as ligações HTTP para futuros pedidos.

LogPolicyOptions

Opções para passar para logPolicy. Por predefinição, apenas é registada uma lista definida de cabeçalhos, embora esta opção possa ser configurada. Os corpos de pedidos e respostas nunca são registados.

MapperConstraints

Descrição de várias restrições de valores, como intervalos de números inteiros e regex de cadeias.

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 da Operação expandem.

OperationQueryParameter

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

OperationRequestOptions

Opções que permitem configurar o processamento de pedidos HTTP feitos por uma operação do SDK.

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 como executar uma determinada operação de serviço através de HTTP, incluindo como serializar corretamente as informações do pedido para e anular a serialização das informações de resposta num payload de objeto devolvido pelo ServiceClient.

OperationURLParameter

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

ParameterValue

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

PipelineOptions

Define as opções que são utilizadas para configurar o pipeline HTTP para um cliente SDK.

PolymorphicDiscriminator

Usado para desambiguar uniões de tipo discriminado. Por exemplo, se a resposta puder ter muitas formas, mas também incluir um campo "kind" (ou semelhante), esse campo pode ser utilizado para determinar como anular a serialização da resposta ao tipo correto.

ProxySettings

Opções para configurar um proxy para pedidos de saída (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

A estrutura subjacente de uma política de pedido.

RequestPolicyOptionsLike

Propriedades opcionais que podem ser utilizadas ao criar uma RequestPolicy.

RequestPrepareOptions

Opções para preparar um pedido HTTP de saída.

RestResponse

A resposta simplificada a uma chamada REST. Contém o HttpOperationResponse subjacente, bem como as propriedades intercaladas do parsedBody, , parsedHeadersetc.

RetryOptions

Opções que controlam como repetir pedidos falhados.

SequenceMapper

Um mapeador que descreve as matrizes.

SequenceMapperType

Ajuda a criar um mapeador que descreve como analisar uma sequência de valores mapeados.

SerializerOptions

Opções para governar o comportamento do analisador xml e do construtor.

ServiceCallback
ServiceClientCredentials

Representa um objeto ou classe com um signRequest método que irá assinar pedidos de saída (por exemplo, ao definir o Authorization cabeçalho).

ServiceClientOptions

Opções a fornecer ao criar o 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 rastreio.

UrlParameterValue

Uma interface que representa um valor de parâmetro de URL.

UserAgentOptions

Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

WebResourceLike

Uma descrição de um pedido HTTP a ser efetuada a um servidor remoto.

Aliases de Tipo

Authenticator

Uma função que recebe um desafio e resolve uma promessa com um token de cadeia.

CommonRequestInfo

URLs de cadeia utilizados ao chamar para fetch().

CommonRequestInit

Um objeto que contém informações sobre o pedido HTTP de saída.

CommonResponse

Um objeto que contém informações sobre a resposta HTTP recebida.

HttpMethods

Lista de métodos HTTP suportados.

HttpRequestBody

Possíveis tipos de corpo de pedido HTTP

Mapper

Os mapeadores são definições dos modelos de dados utilizados na biblioteca. Estes modelos de dados fazem parte das definições de Operação ou Cliente nas respostas ou parâmetros.

MapperType

Tipo do mapeador. Inclui mapeadores conhecidos.

ParameterPath

Um caminho que descreve como aceder a uma determinada propriedade numa determinada origem de dados de objeto. Pode ser um nome de propriedade individual, uma matriz que denota nomes de propriedade aninhadas ou um conjunto de várias propriedades nomeadas com caminhos no caso de valores de objeto complexos.

ProxyOptions

Um alias de ProxySettings para utilização futura.

RawHttpHeaders

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

RequestPolicyFactory

Cria um novo RequestPolicy por pedido que utiliza a nextPolicy fornecida.

TelemetryInfo

Informações de telemetria. Pares chave/valor a incluir dentro da cadeia de User-Agent.

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.

RetryMode

Descreve o tipo Modo de Repetição. Atualmente suporta apenas Exponencial.

Funções

applyMixins(unknown, any[])

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Cria uma nova fábrica para uma RequestPolicy que aplica um token de portador aos cabeçalhos dos Authorization pedidos.

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

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

delay(number, DelayOptions)

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

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Crie um novo RequestPolicyCreator de serialização que serialize os corpos de pedidos HTTP à medida que passam pelo pipeline HTTP.

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

Dado um determinado conjunto de tipos de conteúdo a analisar como JSON ou XML, consome a resposta HTTP para produzir o objeto de resultado definido pelo OperationSpec do pedido.

disableResponseDecompressionPolicy()

Devolve uma fábrica de políticas de pedidos que pode ser utilizada para criar uma instância de <xref:DisableResponseDecompressionPolicy>.

encodeUri(string)

Codifica um URI.

executePromisesSequentially(any[], unknown)

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)

Política que repita o pedido tantas vezes quanto configurado, desde que o intervalo de tempo de repetição máximo especificado, cada repetição espere mais tempo para começar do que a última vez.

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

generateClientRequestIdPolicy(string)

Cria uma política que atribui um ID de pedido exclusivo a pedidos enviados.

generateUuid()

UUID gerado

getDefaultProxySettings(string)

Converte um determinado URL de um servidor proxy em ProxySettings ou tenta obter ProxySettings a partir do ambiente atual se um não for transmitido.

getDefaultUserAgentValue()

A abordagem predefinida para gerar agentes de utilizador. Utiliza informações estáticas deste pacote, além das informações do sistema disponíveis no runtime.

isDuration(string)

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

isTokenCredential(unknown)

Testa um objeto para determinar se implementa o TokenCredential.

isValidUuid(string)

Valida o uuid especificado como uma cadeia

keepAlivePolicy(KeepAliveOptions)

Cria uma política que controla se as ligações HTTP são mantidas em pedidos futuros.

logPolicy(LogPolicyOptions)

Cria uma política que regista informações sobre o pedido de envio e as respostas recebidas.

operationOptionsToRequestOptionsBase<T>(T)

Converte uma OperationOptions num RequestOptionsBase

parseXML(string, SerializerOptions)

Converte uma cadeia XML em JSON

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, { customNoProxyList?: string[] })

Uma política que permite aplicar definições de proxy a todos os pedidos. Se não forem transmitidas definições estáticas, estas serão obtidas a partir das variáveis de ambiente HTTPS_PROXY ou HTTP_PROXY.

redirectPolicy(number)

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

serializeObject(unknown)

Função utilitária que serializa um objeto que pode conter informações binárias num objeto simples, matriz ou cadeia.

signingPolicy(ServiceClientCredentials)

Cria uma política que assina pedidos de saída ao chamar para o authenticationProvidermétodo fornecido signRequest .

stringifyXML(unknown, SerializerOptions)

Converte determinado objeto JSON numa cadeia XML

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)

Uma política que tenta novamente quando existe um erro de sistema, identificada pelos códigos "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" ou "ENOENT".

throttlingRetryPolicy()

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

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

tracingPolicy(TracingPolicyOptions)

Cria uma política que encapsula pedidos de saída com um intervalo de rastreio.

userAgentPolicy(TelemetryInfo)

Devolve uma política que adiciona o cabeçalho do agente de utilizador aos pedidos enviados com base no TelemetryInfo especificado.

Detalhes de Função

applyMixins(unknown, any[])

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

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

Parâmetros

targetCtorParam

unknown

sourceCtors

any[]

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

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Cria uma nova fábrica para uma RequestPolicy que aplica um token de portador aos cabeçalhos dos Authorization pedidos.

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

Parâmetros

credential
TokenCredential

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

scopes

string | string[]

Os âmbitos para os quais o token de portador se aplica.

Devoluções

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

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

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

Parâmetros

pipelineOptions
InternalPipelineOptions

Define as opções que são utilizadas para configurar políticas no pipeline HTTP para um cliente SDK.

authPolicyFactory
RequestPolicyFactory

Uma fábrica de políticas de autenticação opcional a utilizar para pedidos de assinatura.

Devoluções

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

delay(number, DelayOptions)

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

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

Parâmetros

timeInMs

number

O número de milissegundos a atrasar.

options
DelayOptions

As opções de atraso – opções de abortar atualmente

Devoluções

Promise<void>

Promessa que é resolvida após timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Crie um novo RequestPolicyCreator de serialização que serialize os corpos de pedidos HTTP à medida que passam pelo pipeline HTTP.

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

Parâmetros

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Devoluções

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

Dado um determinado conjunto de tipos de conteúdo a analisar como JSON ou XML, consome a resposta HTTP para produzir o objeto de resultado definido pelo OperationSpec do pedido.

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.

Devoluções

Um objeto HttpOperationResponse analisado que pode ser devolvido pelo ServiceClient.

disableResponseDecompressionPolicy()

Devolve uma fábrica de políticas de pedidos que pode ser utilizada para criar uma instância de <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Devoluções

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

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

Parâmetros

promiseFactories

any[]

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

kickstart

unknown

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)

Política que repita o pedido tantas vezes quanto configurado, desde que o intervalo de tempo de repetição máximo especificado, cada repetição espere mais tempo para começar do que a ú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 repetições.

maxRetryInterval

number

Tempo máximo para aguardar entre repetições.

Devoluções

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Analisa um HttpOperationResponse num 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.

Devoluções

  • Um objeto de resposta normalizado.

generateClientRequestIdPolicy(string)

Cria uma política que atribui um ID de pedido exclusivo a pedidos enviados.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parâmetros

requestIdHeaderName

string

O nome do cabeçalho a utilizar ao atribuir o ID exclusivo ao pedido.

Devoluções

generateUuid()

UUID gerado

function generateUuid(): string

Devoluções

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Converte um determinado URL de um servidor proxy em ProxySettings ou tenta obter ProxySettings a partir do ambiente atual se um não for transmitido.

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

Parâmetros

proxyUrl

string

URL do proxy

Devoluções

ProxySettings | undefined

As predefinições de proxy ou não definidas.

getDefaultUserAgentValue()

A abordagem predefinida para gerar agentes de utilizador. Utiliza informações estáticas deste pacote, além das informações do sistema disponíveis no runtime.

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.

isTokenCredential(unknown)

Testa um objeto para determinar se implementa o TokenCredential.

function isTokenCredential(credential: unknown): credential

Parâmetros

credential

unknown

O TokenCredential assumido a ser testado.

Devoluções

credential

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.

keepAlivePolicy(KeepAliveOptions)

Cria uma política que controla se as ligações HTTP são mantidas em pedidos futuros.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parâmetros

keepAliveOptions
KeepAliveOptions

Manter as opções vivas. Por predefinição, as ligações HTTP são mantidas para pedidos futuros.

Devoluções

Uma instância do <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Cria uma política que regista informações sobre o pedido de envio e as respostas recebidas.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parâmetros

loggingOptions
LogPolicyOptions

Opções de registo.

Devoluções

Uma instância do <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Converte uma OperationOptions num RequestOptionsBase

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

Parâmetros

opts

T

Objeto OperationOptions para converter em RequestOptionsBase

Devoluções

parseXML(string, SerializerOptions)

Converte uma cadeia XML em JSON

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

Parâmetros

str

string

Cadeia que contém o conteúdo XML a analisar em JSON

opts
SerializerOptions

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

Devoluções

Promise<any>

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

Parâmetros

promise

Promise<any>

A Promessa de ser convertida numa chamada de retorno

Devoluções

(cb: Function) => void

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converte uma Promessa numa chamada de retorno 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 numa chamada de retorno de serviço

Devoluções

(cb: ServiceCallback<T>) => void

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

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

Uma política que permite aplicar definições de proxy a todos os pedidos. Se não forem transmitidas definições estáticas, estas serão obtidas a partir das variáveis de ambiente HTTPS_PROXY ou HTTP_PROXY.

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

Parâmetros

proxySettings
ProxySettings

ProxySettings a utilizar em cada pedido.

options

{ customNoProxyList?: string[] }

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

Devoluções

redirectPolicy(number)

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

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parâmetros

maximumRetries

number

Número máximo de redirecionamentos a seguir.

Devoluções

Uma instância do <xref:RedirectPolicy>

serializeObject(unknown)

Função utilitária que serializa um objeto que pode conter informações binárias num objeto simples, matriz ou cadeia.

function serializeObject(toSerialize: unknown): any

Parâmetros

toSerialize

unknown

Devoluções

any

signingPolicy(ServiceClientCredentials)

Cria uma política que assina pedidos de saída ao chamar para o authenticationProvidermétodo fornecido signRequest .

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parâmetros

authenticationProvider
ServiceClientCredentials

O fornecedor de autenticação.

Devoluções

Uma instância do <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Converte determinado objeto JSON numa cadeia XML

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

Parâmetros

obj

unknown

Objeto JSON a ser convertido numa cadeia XML

opts
SerializerOptions

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

Devoluções

string

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

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)

Uma política que tenta novamente quando existe um erro de sistema, identificada 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.

Devoluções

Uma instância do <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

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

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

function throttlingRetryPolicy(): RequestPolicyFactory

Devoluções

tracingPolicy(TracingPolicyOptions)

Cria uma política que encapsula pedidos de saída com um intervalo de rastreio.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parâmetros

tracingOptions
TracingPolicyOptions

Opções de rastreio.

Devoluções

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

userAgentPolicy(TelemetryInfo)

Devolve uma política que adiciona o cabeçalho do agente de utilizador aos pedidos enviados com base no TelemetryInfo especificado.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parâmetros

userAgentData
TelemetryInfo

Informações de telemetria.

Devoluções

Um novo <xref:UserAgentPolicy>.