@azure/core-https package
Classes
| DefaultHttpsClient |
Uma implementação HttpsClient que usa o módulo "https" do Node para enviar solicitações HTTPS. |
| 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. |
| BearerTokenAuthenticationPolicyOptions |
Opções para configurar o bearerTokenAuthenticationPolicy |
| ExponentialRetryPolicyOptions |
Opções que controlam como repetir solicitações com falha. |
| 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. |
| HttpsClient |
A interface necessária para um cliente que faz solicitações HTTPS em nome de um pipeline. |
| InternalPipelineOptions |
Define as opções usadas para configurar opções internas do pipeline HTTP para um cliente SDK. |
| LogPolicyOptions |
Opções para configurar o logPolicy. |
| Pipeline |
Representa um pipeline para fazer uma solicitação HTTPS 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 Partial<PipelineRequest>, mas url é obrigatório. |
| PipelineResponse |
Metadados sobre uma resposta recebida pelo pipeline. |
| ProxySettings |
Opções para configurar um proxy para solicitações de saída (somenteNode.js). |
| RedirectPolicyOptions |
Opções de como as respostas de redirecionamento são tratadas. |
| RestErrorOptions |
As opções compatíveis com RestError. |
| SystemErrorRetryPolicyOptions |
Opções que controlam como repetir solicitações com falha. |
| 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 ou (no navegador) um Blob. |
| 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 é:
|
| RawHttpHeaders |
Uma coleção HttpHeaders representada como um objeto JSON simples. |
| RequestBodyType |
Tipos de corpos com suporte na solicitação. NodeJS.ReadableStream é apenas Node. O blob é apenas o 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
| 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 |
Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado. |
| create |
Cria um objeto que satisfaz a interface |
| 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 |
| exponential |
Uma política que tenta repetir solicitações ao introduzir um atraso exponencialmente crescente. |
| form |
Uma política que codifica o FormData na solicitação no corpo. |
| get |
Esse método converte uma URL de proxy em |
| log |
Uma política que registra todas as solicitações e respostas. |
| nd |
ndJsonPolicy é uma política usada para controlar as configurações de manter ativas 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. |
| 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 repetir códigos de erro 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 |
| 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. |
Variáveis
| bearer |
O identificador programático da BearerTokenAuthenticationPolicy. |
| decompress |
O identificador programático da política decompressResponsePolicy. |
| expontential |
O identificador programático da RetryPolicy exponencial. |
| form |
O identificador programático do formDataPolicy. |
| log |
O identificador programático do logPolicy. |
| nd |
O identificador programático do ndJsonPolicy. |
| proxy |
O identificador programático do proxy Policy. |
| redirect |
O identificador programático do redirectPolicy. |
| set |
O identificador programático da política setClientRequestIdPolicy. |
| system |
O identificador programático da sistemaErrorRetryPolicy. |
| throttling |
O identificador programático do throttlingRetryPolicy. |
| tracing |
O identificador programático da TraçingPolicy. |
| user |
O identificador programático da userAgentPolicy. |
Detalhes da função
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
createEmptyPipeline()
Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.
function createEmptyPipeline(): Pipeline
Retornos
createHttpHeaders(RawHttpHeaders)
Cria um objeto que satisfaz a interface HttpHeaders.
function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders
Parâmetros
- rawHeaders
- RawHttpHeaders
Um objeto simples que representa 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
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 o 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 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
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
ndJsonPolicy()
ndJsonPolicy é uma política usada para controlar as configurações de manter ativas para cada solicitação.
function ndJsonPolicy(): PipelinePolicy
Retornos
proxyPolicy(ProxySettings)
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): PipelinePolicy
Parâmetros
- proxySettings
- ProxySettings
ProxySettings a serem usados em cada solicitação.
Retornos
redirectPolicy(RedirectPolicyOptions)
Uma política para seguir cabeçalhos de localização do servidor para dar suporte ao redirecionamento do lado do servidor.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
Parâmetros
- options
- RedirectPolicyOptions
Opções para controlar o comportamento da política.
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 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
throttlingRetryPolicy()
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(): PipelinePolicy
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.
Retornos
Variable Details
bearerTokenAuthenticationPolicyName
O identificador programático da BearerTokenAuthenticationPolicy.
bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"
Tipo
"bearerTokenAuthenticationPolicy"
decompressResponsePolicyName
O identificador programático da política decompressResponsePolicy.
decompressResponsePolicyName: "decompressResponsePolicy"
Tipo
"decompressResponsePolicy"
expontentialRetryPolicyName
O identificador programático da RetryPolicy exponencial.
expontentialRetryPolicyName: "exponentialRetryPolicy"
Tipo
"exponentialRetryPolicy"
formDataPolicyName
O identificador programático do formDataPolicy.
formDataPolicyName: "formDataPolicy"
Tipo
"formDataPolicy"
logPolicyName
O identificador programático do logPolicy.
logPolicyName: "logPolicy"
Tipo
"logPolicy"
ndJsonPolicyName
O identificador programático do ndJsonPolicy.
ndJsonPolicyName: "ndJsonPolicy"
Tipo
"ndJsonPolicy"
proxyPolicyName
O identificador programático do proxy Policy.
proxyPolicyName: "proxyPolicy"
Tipo
"proxyPolicy"
redirectPolicyName
O identificador programático do redirectPolicy.
redirectPolicyName: "redirectPolicy"
Tipo
"redirectPolicy"
setClientRequestIdPolicyName
O identificador programático da política setClientRequestIdPolicy.
setClientRequestIdPolicyName: "setClientRequestIdPolicy"
Tipo
"setClientRequestIdPolicy"
systemErrorRetryPolicyName
O identificador programático da sistemaErrorRetryPolicy.
systemErrorRetryPolicyName: "systemErrorRetryPolicy"
Tipo
"systemErrorRetryPolicy"
throttlingRetryPolicyName
O identificador programático do throttlingRetryPolicy.
throttlingRetryPolicyName: "throttlingRetryPolicy"
Tipo
"throttlingRetryPolicy"
tracingPolicyName
O identificador programático da TraçingPolicy.
tracingPolicyName: "tracingPolicy"
Tipo
"tracingPolicy"
userAgentPolicyName
O identificador programático da userAgentPolicy.
userAgentPolicyName: "userAgentPolicy"
Tipo
"userAgentPolicy"