@azure/core-rest-pipeline package
Classes
RestError |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Interfaces
AddPipelineOptions |
Opções ao adicionar uma política ao pipeline. Usado para expressar dependências em outras políticas. |
Agent |
Uma interface compatível com o do |
AuthorizeRequestOnChallengeOptions |
Opções enviadas para o retorno de chamada authorizeRequestOnChallenge |
AuthorizeRequestOptions |
Opções enviadas para o retorno de chamada authorizeRequest |
AuxiliaryAuthenticationHeaderPolicyOptions |
Opções para configurar auxiliaryAuthenticationHeaderPolicy |
BearerTokenAuthenticationPolicyOptions |
Opções para configurar o bearerTokenAuthenticationPolicy |
ChallengeCallbacks |
Opções para substituir o processamento de desafios de Avaliação Contínua de Acesso . |
DefaultRetryPolicyOptions |
Opções que controlam como repetir solicitações com falha. |
ExponentialRetryPolicyOptions |
Opções que controlam como repetir solicitações com falha. |
HttpClient |
A interface necessária para um cliente que faz solicitações HTTP em nome de um pipeline. |
HttpHeaders |
Representa um conjunto de cabeçalhos HTTP em uma solicitação/resposta. Os nomes de cabeçalho são tratados como não diferenciam maiúsculas de minúsculas. |
InternalPipelineOptions |
Define as opções usadas para configurar opções internas do pipeline HTTP para um cliente do SDK. |
KeyObject |
Uma interface compatível com o do |
LogPolicyOptions |
Opções para configurar o logPolicy. |
Pipeline |
Representa um pipeline para fazer uma solicitação HTTP para uma URL. Os pipelines podem ter várias políticas para gerenciar a manipulação de cada solicitação antes e depois que ela é feita no servidor. |
PipelineOptions |
Define as opções usadas para configurar o pipeline HTTP para um cliente do SDK. |
PipelinePolicy |
Uma política de pipeline manipula uma solicitação à medida que percorre o pipeline. É conceitualmente um middleware que tem permissão para modificar a solicitação antes de ser feita, bem como a resposta quando ela é recebida. |
PipelineRequest |
Metadados sobre uma solicitação que está sendo feita pelo pipeline. |
PipelineRequestOptions |
Configurações para inicializar uma solicitação. Quase equivalente a Parcial, mas a URL é obrigatória. |
PipelineResponse |
Metadados sobre uma resposta recebida pelo pipeline. |
PipelineRetryOptions |
Opções que controlam como repetir solicitações com falha. |
ProxySettings |
Opções para configurar um proxy para solicitações de saída (somente Node.js). |
PxfObject |
Uma interface compatível com o do |
RedirectPolicyOptions |
Opções de como as respostas de redirecionamento são tratadas. |
RestErrorOptions |
As opções compatíveis com 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 deseja repetir ou não e como tentar novamente. |
SystemErrorRetryPolicyOptions |
Opções que controlam como repetir solicitações com falha. |
TelemetryOptions |
Define as opções usadas para configurar informações comuns de telemetria e rastreamento |
ThrottlingRetryPolicyOptions |
Opções que controlam como repetir solicitações com falha. |
TlsSettings |
Representa um certificado para autenticação TLS. |
TracingPolicyOptions |
Opções para configurar a política de rastreamento. |
UserAgentPolicyOptions |
Opções para adicionar detalhes do agente de usuário a solicitações de saída. |
Aliases de tipo
FormDataMap |
Um objeto simples que fornece dados de formulário, como se fosse de um formulário do navegador. |
FormDataValue |
Cada entrada de dados de formulário pode ser uma cadeia de caracteres ou (no navegador) um Blob. |
HttpMethods |
Métodos HTTP com suporte a serem usados ao fazer solicitações. |
PipelinePhase |
As políticas são executadas em fases. A ordem de execução é:
|
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 com suporte na solicitação. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream e () => ReadableStream são somente navegador. |
SendRequest |
Uma interface simples para fazer uma solicitação de pipeline e receber uma resposta. |
TransferProgressEvent |
Acionado em resposta ao progresso do upload ou do download. |
Funções
auxiliary |
Uma política para tokens externos para |
bearer |
Uma política que pode solicitar um token de uma implementação TokenCredential e, em seguida, aplicá-lo ao cabeçalho de autorização de uma solicitação como um token de portador. |
create |
Crie o HttpClient correto para o ambiente atual. |
create |
Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado. |
create |
Cria um objeto que satisfaz a |
create |
Crie um pipeline com um conjunto padrão de políticas personalizáveis. |
create |
Cria uma nova solicitação de pipeline com as opções fornecidas. Esse método é para permitir a configuração fácil de valores padrão e não é necessário. |
decompress |
Uma política para habilitar a descompactação de resposta de acordo com Accept-Encoding cabeçalho https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
default |
Uma política que tenta novamente de acordo com três estratégias:
|
exponential |
Uma política que tenta repetir solicitações ao introduzir um atraso exponencialmente crescente. |
form |
Uma política que codifica FormData na solicitação no corpo. |
get |
Esse método converte uma URL de proxy em |
is |
Typeguard para RestError |
log |
Uma política que registra todas as solicitações e respostas. |
nd |
ndJsonPolicy é uma política usada para controlar as configurações de keep alive para cada solicitação. |
proxy |
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. |
redirect |
Uma política para seguir cabeçalhos de localização do servidor para dar suporte ao redirecionamento do lado do servidor. No navegador, essa política não é usada. |
retry |
retryPolicy é uma política genérica para habilitar solicitações de repetição quando determinadas condições são atendidas |
set |
Cada PipelineRequest obtém uma ID exclusiva após a criação. Essa política passa essa ID exclusiva por meio de um cabeçalho HTTP para habilitar melhor telemetria e rastreamento. |
system |
Uma política de repetição que busca especificamente lidar com erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS) em vez de códigos de erro repetíveis do próprio servidor. |
throttling |
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-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 |
tls |
Obtém uma política de pipeline que adiciona o certificado do cliente ao agente HttpClient para autenticação. |
tracing |
Uma política simples para criar Intervalos OpenTelemetry para cada solicitação feita pelo pipeline que tem SpanOptions com um pai. As solicitações feitas sem um Span pai não serão registradas. |
user |
Uma política que define o cabeçalho User-Agent (ou equivalente) para refletir a versão da biblioteca. |
Detalhes da função
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
Uma política para tokens externos para x-ms-authorization-auxiliary
cabeçalho.
Esse cabeçalho será usado ao criar um aplicativo entre locatários, talvez seja necessário lidar com solicitações de autenticação para recursos que estão em locatários diferentes.
Você pode ver os documentos do ARM para obter um resumo de como esse recurso funciona
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
Parâmetros
Retornos
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
Uma política que pode solicitar um token de uma implementação TokenCredential e, em seguida, aplicá-lo ao cabeçalho de autorização de uma solicitação como um token de portador.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
Parâmetros
Retornos
createDefaultHttpClient()
Crie o HttpClient correto para o ambiente atual.
function createDefaultHttpClient(): HttpClient
Retornos
createEmptyPipeline()
Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.
function createEmptyPipeline(): Pipeline
Retornos
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
Retornos
createPipelineFromOptions(InternalPipelineOptions)
Crie um pipeline com um conjunto padrão de políticas personalizáveis.
function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline
Parâmetros
- options
- InternalPipelineOptions
Opções para configurar um pipeline personalizado.
Retornos
createPipelineRequest(PipelineRequestOptions)
Cria uma nova solicitação de pipeline com as opções fornecidas. Esse método é para permitir a configuração fácil de valores padrão e não é necessário.
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest
Parâmetros
- options
- PipelineRequestOptions
As opções para criar a solicitação.
Retornos
decompressResponsePolicy()
Uma política para habilitar a descompactaçã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
Retornos
defaultRetryPolicy(DefaultRetryPolicyOptions)
Uma política que tenta novamente de acordo com três estratégias:
- Quando o servidor envia uma resposta 429 com um cabeçalho Retry-After.
- Quando há erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS).
- Caso contrário, se a solicitação de saída falhar, ela tentará novamente com um atraso exponencialmente crescente.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy
Parâmetros
- options
- DefaultRetryPolicyOptions
Retornos
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
Uma política que tenta repetir solicitações 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.
Retornos
formDataPolicy()
Uma política que codifica FormData na solicitação no corpo.
function formDataPolicy(): PipelinePolicy
Retornos
getDefaultProxySettings(string)
Esse método converte uma URL de proxy em ProxySettings
para uso com ProxyPolicy.
Se nenhum argumento for fornecido, ele tentará analisar uma URL de proxy das variáveis HTTPS_PROXY
de ambiente ou HTTP_PROXY
.
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined
Parâmetros
- proxyUrl
-
string
A URL do proxy a ser usado. Pode conter informações de autenticação.
Retornos
ProxySettings | undefined
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo capturado por uma cláusula catch.
Retornos
e
logPolicy(LogPolicyOptions)
Uma política que registra todas as solicitações e respostas.
function logPolicy(options?: LogPolicyOptions): PipelinePolicy
Parâmetros
- options
- LogPolicyOptions
Opções para configurar logPolicy.
Retornos
ndJsonPolicy()
ndJsonPolicy é uma política usada para controlar as configurações de keep alive para cada solicitação.
function ndJsonPolicy(): PipelinePolicy
Retornos
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[] }): PipelinePolicy
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
redirectPolicy(RedirectPolicyOptions)
Uma política para seguir cabeçalhos de localização do servidor para dar suporte ao redirecionamento do lado do servidor. No navegador, essa política não é usada.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
Parâmetros
- options
- RedirectPolicyOptions
Opções para controlar o comportamento da política.
Retornos
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy é uma política genérica para habilitar solicitações de repetição quando determinadas condições são atendidas
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy
Parâmetros
- strategies
- options
- RetryPolicyOptions
Retornos
setClientRequestIdPolicy(string)
Cada PipelineRequest obtém uma ID exclusiva após a criação. Essa política passa essa ID exclusiva por meio de um cabeçalho HTTP para habilitar melhor telemetria e rastreamento.
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy
Parâmetros
- requestIdHeaderName
-
string
O nome do cabeçalho para o qual passar a ID da solicitação.
Retornos
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
Uma política de repetição que busca especificamente lidar com erros na camada de transporte subjacente (por exemplo, falhas de pesquisa de DNS) em vez de códigos de erro repetíveis do próprio servidor.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy
Parâmetros
- options
- SystemErrorRetryPolicyOptions
Opções que personalizam a política.
Retornos
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-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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy
Parâmetros
- options
- ThrottlingRetryPolicyOptions
Opções que configuram a lógica de repetição.
Retornos
tlsPolicy(TlsSettings)
Obtém uma política de pipeline que adiciona o certificado do cliente ao agente HttpClient para autenticação.
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy
Parâmetros
- tlsSettings
- TlsSettings
Retornos
tracingPolicy(TracingPolicyOptions)
Uma política simples para criar Intervalos OpenTelemetry para cada solicitação feita pelo pipeline que tem SpanOptions com um pai. As solicitações feitas sem um Span pai não serão registradas.
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy
Parâmetros
- options
- TracingPolicyOptions
Opções para configurar a telemetria registrada pela política de rastreamento.
Retornos
userAgentPolicy(UserAgentPolicyOptions)
Uma política que define o cabeçalho 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 do usuário.