@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 http.Agentdo NodeJS. Queremos evitar exportar publicamente a interface real, pois ela pode variar entre versões de runtime.
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 o auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Opções para configurar o bearerTokenAuthenticationPolicy
BodyPart	Uma parte do corpo da solicitação em uma solicitação de várias partes.
ChallengeCallbacks	Opções para substituir o processamento de desafios de Avaliação de Acesso Contínuo.
CreateFileFromStreamOptions	Opções extras para createFile quando um fluxo está sendo passado.
CreateFileOptions	Opções passadas para createFile especificando metadados sobre o arquivo.
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 SDK.
KeyObject	Uma interface compatível com o tls.KeyObjectdo NodeJS. Queremos evitar exportar publicamente a interface real, pois ela pode variar entre versões de runtime.
LogPolicyOptions	Opções para configurar o logPolicy.
MultipartRequestBody	Um corpo da solicitação que consiste em várias partes.
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 de ela ser feita no servidor.
PipelineOptions	Define as opções usadas para configurar o pipeline HTTP para um cliente 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 (somenteNode.js).
PxfObject	Uma interface compatível com o tls.PxfObjectdo NodeJS. Queremos evitar exportar publicamente a interface real, pois ela pode variar entre versões de runtime.
RedirectPolicyOptions	Opções de como as respostas de redirecionamento são tratadas.
RestErrorOptions	As opções compatíveis com RestError.
RetryInformation	Informações fornecidas para a 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 o 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 de navegador.
FormDataValue	Cada entrada de dados de formulário pode ser uma cadeia de caracteres, blob ou um arquivo. Se você quiser passar um arquivo com um nome, mas não tiver acesso à classe Arquivo, poderá usar o auxiliar createFile para criar um.
HttpMethods	Métodos HTTP com suporte para usar ao fazer solicitações.
PipelinePhase	As políticas são executadas em fases. A ordem de execução é: Fase serializar Políticas não em uma 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 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 de upload ou download.

Funções

agentPolicy(Agent)	Obtém uma política de pipeline que define http.agent
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Uma política para tokens externos 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 documentos do ARM para obter um resumo de como esse recurso funciona
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.
createDefaultHttpClient()	Crie o HttpClient correto para o ambiente atual.
createEmptyPipeline()	Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.
createFile(Uint8Array, string, CreateFileOptions)	Crie um objeto que implemente a interface File. Esse objeto deve ser passado para RequestBodyType.formData e não é garantido que funcione conforme o esperado em outras situações. Use essa função para criar um objeto File para uso em RequestBodyType.formData em ambientes em que o objeto Arquivo global não está disponível.
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)	Crie um objeto que implemente a interface File. Esse objeto deve ser passado para RequestBodyType.formData e não é garantido que funcione conforme o esperado em outras situações. Use esta função para: Crie um objeto File para uso em RequestBodyType.formData em ambientes em que o objeto Arquivo global não está disponível. Crie um objeto semelhante a um arquivo de um fluxo legível sem ler o fluxo na memória.
createHttpHeaders(RawHttpHeadersInput)	Cria um objeto que satisfaz a interface HttpHeaders.
createPipelineFromOptions(InternalPipelineOptions)	Crie um pipeline com um conjunto padrão de políticas personalizáveis.
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.
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
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.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Uma política que tenta repetir solicitações ao introduzir um atraso exponencialmente crescente.
formDataPolicy()	Uma política que codifica o FormData na solicitação no corpo.
getDefaultProxySettings(string)	Esse método converte uma URL de proxy em ProxySettings para uso com o ProxyPolicy. Se nenhum argumento for fornecido, ele tentará analisar uma URL de proxy das variáveis de ambiente HTTPS_PROXY ou HTTP_PROXY.
isRestError(unknown)	Typeguard para RestError
logPolicy(LogPolicyOptions)	Uma política que registra todas as solicitações e respostas.
multipartPolicy()	Política de pipeline para solicitações de várias partes
ndJsonPolicy()	ndJsonPolicy é uma política usada para controlar as configurações de manter ativas para cada solicitaçã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(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.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy é uma política genérica para habilitar solicitações de repetição quando determinadas condições são atendidas
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.
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 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://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits e https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Obtém uma política de pipeline que adiciona o certificado do cliente ao agente HttpClient para autenticação.
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.
userAgentPolicy(UserAgentPolicyOptions)	Uma política que define o cabeçalho User-Agent (ou equivalente) para refletir a versão da biblioteca.

Detalhes da função

agentPolicy(Agent)

Obtém uma política de pipeline que define http.agent

function agentPolicy(agent?: Agent): PipelinePolicy

Parâmetros

agent

Agent

Retornos

PipelinePolicy

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Uma política para tokens externos 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 documentos do ARM para obter um resumo de como esse recurso funciona

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parâmetros

options

AuxiliaryAuthenticationHeaderPolicyOptions

Retornos

PipelinePolicy

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

options

BearerTokenAuthenticationPolicyOptions

Retornos

PipelinePolicy

createDefaultHttpClient()

Crie o HttpClient correto para o ambiente atual.

function createDefaultHttpClient(): HttpClient

Retornos

HttpClient

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Retornos

Pipeline

createFile(Uint8Array, string, CreateFileOptions)

Crie um objeto que implemente a interface File. Esse objeto deve ser passado para RequestBodyType.formData e não é garantido que funcione conforme o esperado em outras situações.

Use essa função para criar um objeto File para uso em RequestBodyType.formData em ambientes em que o objeto Arquivo global não está disponível.

function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File

Parâmetros

content

Uint8Array

o conteúdo do arquivo como um Uint8Array na memória.

name

string

o nome do arquivo.

options

CreateFileOptions

metadados opcionais sobre o arquivo, por exemplo, nome do arquivo, tamanho do arquivo, tipo MIME.

Retornos

File

createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)

Crie um objeto que implemente a interface File. Esse objeto deve ser passado para RequestBodyType.formData e não é garantido que funcione conforme o esperado em outras situações.

Use esta função para:

• Crie um objeto File para uso em RequestBodyType.formData em ambientes em que o objeto Arquivo global não está disponível.
• Crie um objeto semelhante a um arquivo de um fluxo legível sem ler o fluxo na memória.

function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File

Parâmetros

stream

() => ReadableStream<Uint8Array> | ReadableStream

o conteúdo do arquivo como um retorno de chamada retornando um fluxo. Quando um objeto File feito usando createFile é passado no mapa de dados de formulário de uma solicitação, o fluxo não será lido na memória e, em vez disso, será transmitido quando a solicitação for feita. No caso de uma repetição, o fluxo precisa ser lido novamente, portanto, esse retorno de chamada deve retornar um novo fluxo, se possível.

name

string

o nome do arquivo.

options

CreateFileFromStreamOptions

metadados opcionais sobre o arquivo, por exemplo, nome do arquivo, tamanho do arquivo, tipo MIME.

Retornos

File

createHttpHeaders(RawHttpHeadersInput)

Cria um objeto que satisfaz a interface HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parâmetros

rawHeaders

RawHttpHeadersInput

Um objeto simples que representa cabeçalhos iniciais

Retornos

HttpHeaders

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

Pipeline

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

PipelineRequest

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

PipelinePolicy

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

PipelinePolicy

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

PipelinePolicy

formDataPolicy()

Uma política que codifica o FormData na solicitação no corpo.

function formDataPolicy(): PipelinePolicy

Retornos

PipelinePolicy

getDefaultProxySettings(string)

Aviso

Essa API foi preterida.

• Internally this method is no longer necessary when setting proxy information.

Esse método converte uma URL de proxy em ProxySettings para uso com o ProxyPolicy. Se nenhum argumento for fornecido, ele tentará analisar uma URL de proxy das variáveis de ambiente HTTPS_PROXY 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 pego 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 o logPolicy.

Retornos

PipelinePolicy

multipartPolicy()

Política de pipeline para solicitações de várias partes

function multipartPolicy(): PipelinePolicy

Retornos

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy é uma política usada para controlar as configurações de manter ativas para cada solicitação.

function ndJsonPolicy(): PipelinePolicy

Retornos

PipelinePolicy

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

PipelinePolicy

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

PipelinePolicy

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

RetryStrategy[]

options

RetryPolicyOptions

Retornos

PipelinePolicy

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

PipelinePolicy

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 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.

Retornos

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://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits e https://learn.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

PipelinePolicy

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

PipelinePolicy

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

PipelinePolicy

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.

Retornos

PipelinePolicy