@azure/core-rest-pipeline package

Classes

RestError

Um tipo de erro personalizado para pedidos de pipeline falhados.

Interfaces

AddPipelineOptions	Opções ao adicionar uma política ao pipeline. Utilizado para expressar dependências noutras políticas.
Agent	Uma interface compatível com o nodeJS.http.Agent Queremos evitar exportar publicamente a interface real, uma vez que pode variar entre versões de runtime.
AuthorizeRequestOnChallengeOptions	Opções enviadas para a chamada de retorno authorizeRequestOnChallenge
AuthorizeRequestOptions	Opções enviadas para a chamada de retorno authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Opções para configurar o auxiliarAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Opções para configurar o bearerTokenAuthenticationPolicy
ChallengeCallbacks	Opções para substituir o processamento de desafios da Avaliação de Acesso Contínuo .
DefaultRetryPolicyOptions	Opções que controlam como repetir pedidos falhados.
ExponentialRetryPolicyOptions	Opções que controlam como repetir pedidos falhados.
HttpClient	A interface necessária para um cliente que faz pedidos HTTP em nome de um pipeline.
HttpHeaders	Representa um conjunto de cabeçalhos HTTP num pedido/resposta. Os nomes dos cabeçalhos são tratados como não sensíveis a maiúsculas e minúsculas.
InternalPipelineOptions	Define opções que são utilizadas para configurar opções internas do pipeline HTTP para um cliente SDK.
KeyObject	Uma interface compatível com o nodeJS.tls.KeyObject Queremos evitar exportar publicamente a interface real, uma vez que pode variar entre versões de runtime.
LogPolicyOptions	Opções para configurar o logPolicy.
Pipeline	Representa um pipeline para fazer um pedido HTTP para um URL. Os pipelines podem ter várias políticas para gerir a manipulação de cada pedido antes e depois de ser efetuada no servidor.
PipelineOptions	Define as opções que são utilizadas para configurar o pipeline HTTP para um cliente SDK.
PipelinePolicy	Uma política de pipeline manipula um pedido à medida que percorre o pipeline. É conceptualmente um middleware que é autorizado a modificar o pedido antes de ser feito, bem como a resposta quando é recebido.
PipelineRequest	Metadados sobre um pedido que está a ser feito pelo pipeline.
PipelineRequestOptions	Definições para inicializar um pedido. Quase equivalente a Parcial, mas o URL é obrigatório.
PipelineResponse	Metadados sobre uma resposta recebida pelo pipeline.
PipelineRetryOptions	Opções que controlam como repetir pedidos falhados.
ProxySettings	Opções para configurar um proxy para pedidos de saída (apenas Node.js).
PxfObject	Uma interface compatível com o nodeJS.tls.PxfObject Queremos evitar exportar publicamente a interface real, uma vez que pode variar entre versões de runtime.
RedirectPolicyOptions	Opções para a forma como as respostas de redirecionamento são processadas.
RestErrorOptions	As opções suportadas pelo RestError.
RetryInformation	Informações fornecidas à estratégia de repetição sobre o progresso atual da política de repetição.
RetryModifiers	Propriedades que podem modificar o comportamento da política de repetição.
RetryPolicyOptions	Opções para retryPolicy
RetryStrategy	Uma estratégia de repetição destina-se a definir se pretende repetir ou não e como tentar novamente.
SystemErrorRetryPolicyOptions	Opções que controlam como repetir pedidos falhados.
TelemetryOptions	Define opções que são utilizadas para configurar informações comuns de telemetria e rastreio
ThrottlingRetryPolicyOptions	Opções que controlam como repetir pedidos falhados.
TlsSettings	Representa um certificado para autenticação TLS.
TracingPolicyOptions	Opções para configurar a política de rastreio.
UserAgentPolicyOptions	Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

Aliases de Tipo

FormDataMap	Um objeto simples que fornece dados de formulário, como se fosse de um formulário do browser.
FormDataValue	Cada entrada de dados de formulário pode ser uma cadeia ou (no browser) um Blob.
HttpMethods	Métodos HTTP suportados para utilizar ao fazer pedidos.
PipelinePhase	As políticas são executadas por fases. A ordem de execução é: Serializar Fase As políticas não estão numa fase Desserializar Fase Fase de Repetição Fase de Sinal
RawHttpHeaders	Uma coleção HttpHeaders representada como um objeto JSON simples.
RawHttpHeadersInput	Uma coleção httpHeaders para entrada, representada como um objeto JSON simples.
RequestBodyType	Tipos de corpos suportados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é apenas Node. Blob, ReadableStream e () => ReadableStream são apenas browser.
SendRequest	Uma interface simples para fazer um pedido de pipeline e receber uma resposta.
TransferProgressEvent	Acionado em resposta ao progresso do carregamento ou transferência.

Funções

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Uma política para tokens externos a x-ms-authorization-auxiliary cabeçalho. Este cabeçalho será utilizado ao criar uma aplicação entre inquilinos, talvez seja necessário processar pedidos de autenticação para recursos que estejam em inquilinos diferentes. Pode ver os documentos do ARM para obter um resumo de como esta funcionalidade funciona
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Uma política que pode pedir um token a partir de uma implementação TokenCredential e, em seguida, aplicá-lo ao cabeçalho Autorização de um pedido como token de Portador.
createDefaultHttpClient()	Crie o HttpClient correto para o ambiente atual.
createEmptyPipeline()	Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.
createHttpHeaders(RawHttpHeadersInput)	Cria um objeto que satisfaz a HttpHeaders interface.
createPipelineFromOptions(InternalPipelineOptions)	Crie um novo pipeline com um conjunto predefinido de políticas personalizáveis.
createPipelineRequest(PipelineRequestOptions)	Cria um novo pedido de pipeline com as opções especificadas. Este método é permitir a definição fácil de valores predefinidos e não necessário.
decompressResponsePolicy()	Uma política para ativar a descompressão de resposta de acordo com Accept-Encoding cabeçalho https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Uma política que se repita de acordo com três estratégias: Quando o servidor envia uma resposta 429 com um cabeçalho Retry-After. Quando existem erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS). Caso contrário, se o pedido de saída falhar, tentará novamente com um atraso exponencialmente crescente.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Uma política que tenta repetir pedidos ao introduzir um atraso exponencialmente crescente.
formDataPolicy()	Uma política que codifica FormData no pedido para o corpo.
getDefaultProxySettings(string)	Este método converte um url de proxy em ProxySettings para utilização com ProxyPolicy. Se não for apresentado nenhum argumento, tenta analisar um URL de proxy das variáveis HTTPS_PROXY de ambiente ou HTTP_PROXY.
isRestError(unknown)	Typeguard para RestError
logPolicy(LogPolicyOptions)	Uma política que regista todos os pedidos e respostas.
ndJsonPolicy()	ndJsonPolicy é uma política utilizada para controlar as definições de manter vivas para cada pedido.
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(RedirectPolicyOptions)	Uma política para seguir os cabeçalhos de Localização do servidor para suportar o redirecionamento do lado do servidor. No browser, esta política não é utilizada.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy é uma política genérica para ativar a repetição de pedidos quando determinadas condições são cumpridas
setClientRequestIdPolicy(string)	Cada PipelineRequest obtém um ID exclusivo após a criação. Esta política transmite esse ID exclusivo através de um cabeçalho HTTP para permitir uma melhor telemetria e rastreio.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Uma política de repetição que procura especificamente lidar com erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS) em vez de repetir códigos de erro do próprio servidor.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Uma política que tenta novamente quando o servidor envia uma resposta 429 com um cabeçalho Retry-After. 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
tlsPolicy(TlsSettings)	Obtém uma política de pipeline que adiciona o certificado de cliente ao agente HttpClient para autenticação.
tracingPolicy(TracingPolicyOptions)	Uma política simples para criar o OpenTelemetry Spans para cada pedido feito pelo pipeline que tem SpanOptions com um elemento principal. Os pedidos feitos sem um Span principal não serão registados.
userAgentPolicy(UserAgentPolicyOptions)	Uma política que define o cabeçalho de User-Agent (ou equivalente) para refletir a versão da biblioteca.

Detalhes de Função

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Uma política para tokens externos a x-ms-authorization-auxiliary cabeçalho. Este cabeçalho será utilizado ao criar uma aplicação entre inquilinos, talvez seja necessário processar pedidos de autenticação para recursos que estejam em inquilinos diferentes. Pode ver os documentos do ARM para obter um resumo de como esta funcionalidade funciona

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parâmetros

options

AuxiliaryAuthenticationHeaderPolicyOptions

Devoluções

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Uma política que pode pedir um token a partir de uma implementação TokenCredential e, em seguida, aplicá-lo ao cabeçalho Autorização de um pedido como token de Portador.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parâmetros

options

BearerTokenAuthenticationPolicyOptions

Devoluções

PipelinePolicy

createDefaultHttpClient()

Crie o HttpClient correto para o ambiente atual.

function createDefaultHttpClient(): HttpClient

Devoluções

HttpClient

createEmptyPipeline()

Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.

function createEmptyPipeline(): Pipeline

Devoluções

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Cria um objeto que satisfaz a HttpHeaders interface.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parâmetros

rawHeaders

RawHttpHeadersInput

Um objeto simples que representa os cabeçalhos iniciais

Devoluções

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Crie um novo pipeline com um conjunto predefinido de políticas personalizáveis.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parâmetros

options

InternalPipelineOptions

Opções para configurar um pipeline personalizado.

Devoluções

Pipeline

createPipelineRequest(PipelineRequestOptions)

Cria um novo pedido de pipeline com as opções especificadas. Este método é permitir a definição fácil de valores predefinidos e não necessário.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parâmetros

options

PipelineRequestOptions

As opções para criar o pedido com.

Devoluções

PipelineRequest

decompressResponsePolicy()

Uma política para ativar a descompressão de resposta de acordo com Accept-Encoding cabeçalho https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Devoluções

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Uma política que se repita de acordo com três estratégias:

• Quando o servidor envia uma resposta 429 com um cabeçalho Retry-After.
• Quando existem erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS).
• Caso contrário, se o pedido de saída falhar, tentará novamente com um atraso exponencialmente crescente.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parâmetros

options

DefaultRetryPolicyOptions

Devoluções

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Uma política que tenta repetir pedidos ao introduzir um atraso exponencialmente crescente.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parâmetros

options

ExponentialRetryPolicyOptions

Opções que configuram a lógica de repetição.

Devoluções

PipelinePolicy

formDataPolicy()

Uma política que codifica FormData no pedido para o corpo.

function formDataPolicy(): PipelinePolicy

Devoluções

PipelinePolicy

getDefaultProxySettings(string)

Este método converte um url de proxy em ProxySettings para utilização com ProxyPolicy. Se não for apresentado nenhum argumento, tenta analisar um URL de proxy das variáveis HTTPS_PROXY de ambiente ou HTTP_PROXY.

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

Parâmetros

proxyUrl

string

O URL do proxy a utilizar. Pode conter informações de autenticação.

Devoluções

ProxySettings | undefined

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula catch.

Devoluções

e

logPolicy(LogPolicyOptions)

Uma política que regista todos os pedidos e respostas.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parâmetros

options

LogPolicyOptions

Opções para configurar logPolicy.

Devoluções

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy é uma política utilizada para controlar as definições de manter vivas para cada pedido.

function ndJsonPolicy(): PipelinePolicy

Devoluções

PipelinePolicy

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[] }): PipelinePolicy

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

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Uma política para seguir os cabeçalhos de Localização do servidor para suportar o redirecionamento do lado do servidor. No browser, esta política não é utilizada.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parâmetros

options

RedirectPolicyOptions

Opções para controlar o comportamento da política.

Devoluções

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy é uma política genérica para ativar a repetição de pedidos quando determinadas condições são cumpridas

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Parâmetros

strategies

RetryStrategy[]

options

RetryPolicyOptions

Devoluções

PipelinePolicy

setClientRequestIdPolicy(string)

Cada PipelineRequest obtém um ID exclusivo após a criação. Esta política transmite esse ID exclusivo através de um cabeçalho HTTP para permitir uma melhor telemetria e rastreio.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parâmetros

requestIdHeaderName

string

O nome do cabeçalho para o que transmitir o ID do pedido.

Devoluções

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Uma política de repetição que procura especificamente lidar com erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS) em vez de repetir códigos de erro do próprio servidor.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parâmetros

options

SystemErrorRetryPolicyOptions

Opções que personalizam a política.

Devoluções

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Uma política que tenta novamente quando o servidor envia uma resposta 429 com um cabeçalho Retry-After.

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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parâmetros

options

ThrottlingRetryPolicyOptions

Opções que configuram a lógica de repetição.

Devoluções

PipelinePolicy

tlsPolicy(TlsSettings)

Obtém uma política de pipeline que adiciona o certificado de cliente ao agente HttpClient para autenticação.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parâmetros

tlsSettings

TlsSettings

Devoluções

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Uma política simples para criar o OpenTelemetry Spans para cada pedido feito pelo pipeline que tem SpanOptions com um elemento principal. Os pedidos feitos sem um Span principal não serão registados.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parâmetros

options

TracingPolicyOptions

Opções para configurar a telemetria registada pela política de rastreio.

Devoluções

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Uma política que define o cabeçalho de User-Agent (ou equivalente) para refletir a versão da biblioteca.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parâmetros

options

UserAgentPolicyOptions

Opções para personalizar o valor do agente de utilizador.

Devoluções

PipelinePolicy