PipelineRequestOptions interface

Pacote:

@azure/core-rest-pipeline

Configurações para inicializar uma solicitação. Quase equivalente a Parcial, mas a URL é obrigatória.

Propriedades

abortSignal	Usado para anular a solicitação posteriormente.
allowInsecureConnection	Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
body	O conteúdo do corpo HTTP (se houver)
disableKeepAlive	Se a conexão não deve ser reutilizado.
enableBrowserStreams	SOMENTE NAVEGADOR Uma opção somente do navegador para habilitar o uso da API streams. Se essa opção for definida e o streaming for usado (consulte streamResponseStatusCodes), a resposta terá uma propriedade browserStream em vez da blobBody qual será indefinida. O valor padrão é false
formData	Para simular uma postagem de formulário do navegador
headers	Os cabeçalhos HTTP a serem usados ao fazer a solicitação.
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.
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, um AbortError será gerado. O padrão é 0, o que desabilita o tempo limite.
tracingOptions	Opções usadas para criar um intervalo quando o rastreamento está habilitado.
url	A URL para qual será feita 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

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor da propriedade

boolean

body

O conteúdo do corpo HTTP (se houver)

body?: RequestBodyType

Valor da propriedade

RequestBodyType

disableKeepAlive

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

disableKeepAlive?: boolean

Valor da propriedade

boolean

enableBrowserStreams

SOMENTE NAVEGADOR

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

O valor padrão é false

enableBrowserStreams?: boolean

Valor da propriedade

boolean

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

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

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

url

A URL para qual será feita 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