PipelineRequestOptions interface

Pacote:

@azure/core-rest-pipeline

Definições para inicializar um pedido. Quase equivalente a Parcial, mas o URL é obrigatório.

Propriedades

abortSignal	Utilizado para abortar o pedido mais tarde.
allowInsecureConnection	Defina como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS
body	O conteúdo do corpo http (se houver)
disableKeepAlive	Se a ligação não deve ser reutilizada.
enableBrowserStreams	APENAS BROWSER Uma opção apenas de browser para ativar a utilização da API streams. Se esta opção estiver definida e a transmissão em fluxo for utilizada (veja streamResponseStatusCodes), a resposta terá uma propriedade browserStream em vez da blobBody qual será indefinida. O valor predefinido é falso
formData	Para simular uma mensagem de formulário do browser
headers	Os cabeçalhos HTTP a utilizar ao fazer o pedido.
method	O método HTTP a utilizar ao fazer o pedido.
onDownloadProgress	Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress	Chamada de retorno que é acionada após o progresso do carregamento.
proxySettings	Configuração do proxy.
requestId	Um identificador exclusivo para o pedido. Utilizado para registo e rastreio.
streamResponseStatusCodes	Uma lista de códigos de estado de resposta cujo corpo de PipelineResponse correspondente deve ser tratado como um fluxo.
timeout	O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente. Se o pedido for terminado, é emitido um AbortError . A predefinição é 0, o que desativa o tempo limite.
tracingOptions	Opções utilizadas para criar um intervalo quando o rastreio está ativado.
url	O URL para o que fazer o pedido.
withCredentials	Se as credenciais (cookies) forem enviadas durante um XHR. O valor predefinido é falso.

Detalhes de Propriedade

abortSignal

Utilizado para abortar o pedido mais tarde.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

allowInsecureConnection

Defina como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

body

O conteúdo do corpo http (se houver)

body?: RequestBodyType

Valor de Propriedade

RequestBodyType

disableKeepAlive

Se a ligação não deve ser reutilizada.

disableKeepAlive?: boolean

Valor de Propriedade

boolean

enableBrowserStreams

APENAS BROWSER

Uma opção apenas de browser para ativar a utilização da API streams. Se esta opção estiver definida e a transmissão em fluxo for utilizada (veja streamResponseStatusCodes), a resposta terá uma propriedade browserStream em vez da blobBody qual será indefinida.

O valor predefinido é falso

enableBrowserStreams?: boolean

Valor de Propriedade

boolean

formData

Para simular uma mensagem de formulário do browser

formData?: FormDataMap

Valor de Propriedade

FormDataMap

headers

Os cabeçalhos HTTP a utilizar ao fazer o pedido.

headers?: HttpHeaders

Valor de Propriedade

HttpHeaders

method

O método HTTP a utilizar ao fazer o pedido.

method?: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

proxySettings

Configuração do proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

requestId

Um identificador exclusivo para o pedido. Utilizado para registo e rastreio.

requestId?: string

Valor de Propriedade

string

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

Valor de Propriedade

Set<number>

timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente. Se o pedido for terminado, é emitido um AbortError . A predefinição é 0, o que desativa o tempo limite.

timeout?: number

Valor de Propriedade

number

tracingOptions

Opções utilizadas para criar um intervalo quando o rastreio está ativado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

url

O URL para o que fazer o pedido.

url: string

Valor de Propriedade

string

withCredentials

Se as credenciais (cookies) forem enviadas durante um XHR. O valor predefinido é falso.

withCredentials?: boolean

Valor de Propriedade

boolean