PipelineRequest interface

  • Referência
Pacote:
@azure/core-rest-pipeline

Metadados sobre um pedido que está a ser feito pelo pipeline.

Propriedades

abortSignal

Utilizado para abortar o pedido mais tarde.
agent

APENAS NODEJS

Uma opção apenas no nó para fornecer um http.Agent/https.Agent. Não faz nada ao executar no browser.
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 os Streams do browser. Se esta opção estiver definida e uma resposta for um fluxo, 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. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer estado seria 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.
tlsSettings

Definições para configurar a autenticação TLS
tracingOptions

Opções de rastreio a utilizar para quaisquer Spans criados.
url

O URL para o que fazer o pedido.
withCredentials

Indica se o agente de utilizador deve enviar cookies do outro domínio no caso de pedidos de origem cruzada. O valor predefinido é falso.

Detalhes de Propriedade

abortSignal

Utilizado para abortar o pedido mais tarde.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

agent

APENAS NODEJS

Uma opção apenas no nó para fornecer um http.Agent/https.Agent. Não faz nada ao executar no browser.

agent?: Agent

Valor de Propriedade

Agent

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 os Streams do browser. Se esta opção estiver definida e uma resposta for um fluxo, 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. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer estado seria 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

tlsSettings

Definições para configurar a autenticação TLS

tlsSettings?: TlsSettings

Valor de Propriedade

TlsSettings

tracingOptions

Opções de rastreio a utilizar para quaisquer Spans criados.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

url

O URL para o que fazer o pedido.

url: string

Valor de Propriedade

string

withCredentials

Indica se o agente de utilizador deve enviar cookies do outro domínio no caso de pedidos de origem cruzada. O valor predefinido é falso.

withCredentials: boolean

Valor de Propriedade

boolean