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 abortar a solicitação mais tarde.
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 reutilizada. O valor padrão é verdadeiro.
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 carregamento.
proxySettings

Configuração de proxy.
requestId

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

Opções usadas para criar uma extensão 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 levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, uma AbortError será lançada. O padrão é 0, o que desativa o tempo limite.
url

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

Se as credenciais (cookies) devem ser enviadas durante um XHR. É definido para false por padrão.

Detalhes de Propriedade

abortSignal

Usado para abortar a solicitação mais tarde.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

body

O conteúdo do corpo HTTP (se houver)

body?: RequestBodyType

Valor de Propriedade

RequestBodyType

formData

Para simular uma postagem de formulário do navegador

formData?: FormDataMap

Valor de Propriedade

FormDataMap

headers

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

headers?: HttpHeaders

Valor de Propriedade

HttpHeaders

keepAlive

Se a conexão deve ser reutilizada. O valor padrão é verdadeiro.

keepAlive?: boolean

Valor de Propriedade

boolean

method

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

method?: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

requestId

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

requestId?: string

Valor de Propriedade

string

spanOptions

Opções usadas para criar uma extensão quando o rastreamento está habilitado.

spanOptions?: SpanOptions

Valor de 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 de Propriedade

Set<number>

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, uma AbortError será lançada. O padrão é 0, o que desativa o tempo limite.

timeout?: number

Valor de Propriedade

number

url

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

url: string

Valor de Propriedade

string

withCredentials

Se as credenciais (cookies) devem ser enviadas durante um XHR. É definido para false por padrão.

withCredentials?: boolean

Valor de Propriedade

boolean