PipelineRequestOptions interface

Pacote:
@azure/core-https

Configurações para inicializar uma solicitação. Quase equivalente a Partial<PipelineRequest>, mas url é obrigatório.

Propriedades

abortSignal

Usado para anular a solicitação posteriormente.
body

O conteúdo do corpo HTTP (se houver)
formData

Para simular uma postagem de formulário do navegador
headers

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

Se a conexão deve ser reutilizado. O padrão é true.
method

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

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

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

Configuração de proxy.
requestId

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

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

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

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

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

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

Detalhes da propriedade

abortSignal

Usado para anular a solicitação posteriormente.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

body

O conteúdo do corpo HTTP (se houver)

body?: RequestBodyType

Valor da propriedade

RequestBodyType

formData

Para simular uma postagem de formulário do navegador

formData?: FormDataMap

Valor da propriedade

FormDataMap

headers

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

headers?: HttpHeaders

Valor da propriedade

HttpHeaders

keepAlive

Se a conexão deve ser reutilizado. O padrão é true.

keepAlive?: boolean

Valor da propriedade

boolean

method

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

method?: HttpMethods

Valor da propriedade

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

requestId

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

requestId?: string

Valor da propriedade

string

spanOptions

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

spanOptions?: SpanOptions

Valor da propriedade

@azure/core-tracing.SpanOptions

streamResponseStatusCodes

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

Set<number>

timeout

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

number

url

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

url: string

Valor da propriedade

string

withCredentials

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

withCredentials?: boolean

Valor da propriedade

boolean