PipelineRequestOptions interface

Usado para anular a solicitação posteriormente.

abortSignal?: AbortSignalLike

Valor da propriedade

SOMENTE NODEJS

Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. OBSERVAÇÃO: geralmente essa deve ser uma instância compartilhada por várias solicitações para que a conexão subjacente com o serviço possa ser reutilizado. Não faz nada ao executar no navegador.

agent?: Agent

Valor da propriedade

Definir como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor da propriedade

O conteúdo do corpo HTTP (se houver)

body?: RequestBodyType

Valor da propriedade

Se a conexão não deve ser reutilizado.

disableKeepAlive?: boolean

Valor da propriedade

SOMENTE NAVEGADOR

Uma opção somente do navegador para habilitar o uso da API do Streams. Se essa opção for definida e o streaming for usado (consulte streamResponseStatusCodes), a resposta terá uma propriedade browserStream em vez de blobBody que será indefinida.

O valor padrão é falso

enableBrowserStreams?: boolean

Valor da propriedade

Para simular uma postagem de formulário do navegador

formData?: FormDataMap

Valor da propriedade

Os cabeçalhos HTTP a serem usados ao fazer a solicitação.

headers?: HttpHeaders

Valor da propriedade

O método HTTP a ser usado ao fazer a solicitação.

method?: HttpMethods

Valor da propriedade

Corpo para uma solicitação de várias partes.

multipartBody?: MultipartRequestBody

Valor da propriedade

Retorno de chamada que é acionado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

Retorno de chamada que é acionado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

Configuração de proxy.

proxySettings?: ProxySettings

Valor da propriedade

Um identificador exclusivo para a solicitação. Usado para registro em log e rastreamento.

requestId?: string

Valor da propriedade

Opções adicionais a serem definidas na solicitação. Isso fornece uma maneira de substituir os existentes ou fornecer propriedades de solicitação que não são declaradas.

Para possíveis propriedades válidas, consulte

• Opções de https.request do NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
• RequestInit do navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

AVISO: As opções especificadas aqui substituirão todas as propriedades com os mesmos nomes quando a solicitação for enviada por HttpClient.

requestOverrides?: Record<string, unknown>

Valor da propriedade

Uma lista de códigos de status de resposta cujo corpo pipelineResponse correspondente deve ser tratado como um fluxo.

streamResponseStatusCodes?: Set<number>

Valor da propriedade

O número de milissegundos que uma solicitação pode fazer antes de ser encerrada automaticamente. Se a solicitação for encerrada, um AbortError será gerado. O padrão é 0, o que desabilita o tempo limite.

timeout?: number

Valor da propriedade

Configurações para configurar a autenticação do TLS

tlsSettings?: TlsSettings

Valor da propriedade

Opções usadas para criar um intervalo quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

A URL para a qual fazer a solicitação.

url: string

Valor da propriedade

Se as credenciais (cookies) devem ser enviadas durante um XHR. O padrão é false.

withCredentials?: boolean

Valor da propriedade