PipelineRequest interface

Pacote:

@azure/core-rest-pipeline

Metadados sobre uma solicitação que está sendo feita pelo pipeline.

Propriedades

abortSignal	Usado para anular a solicitação posteriormente.
agent	SOMENTE NODEJS Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. Não faz nada ao executar no navegador.
allowInsecureConnection	Definir 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 fluxos do navegador. Se essa opção estiver definida e uma resposta for um fluxo, a resposta terá uma propriedade browserStream em vez de blobBody que será indefinida. O valor padrão é falso
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.
multipartBody	Corpo para uma solicitação de várias partes.
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.
requestOverrides	Opções adicionais a serem definidas na solicitação. Isso fornece uma maneira de substituir os existentes ou fornecer propriedades de solicitação que não são declaradas. Para possíveis propriedades válidas, consulte Opções de https.request do NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback RequestInit do navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit AVISO: As opções especificadas aqui substituirão todas as propriedades com os mesmos nomes quando a solicitação for enviada por HttpClient.
streamResponseStatusCodes	Uma lista de códigos de status de resposta cujo corpo pipelineResponse correspondente deve ser tratado como um fluxo. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer status seria 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.
tlsSettings	Configurações para configurar a autenticação do TLS
tracingOptions	Opções de rastreamento a serem usadas para todos os Intervalos criados.
url	A URL para a qual fazer a solicitação.
withCredentials	Indica se o agente de usuário deve enviar cookies do outro domínio no caso de solicitações entre origens. O padrão é false.

Detalhes da propriedade

abortSignal

Usado para anular a solicitação posteriormente.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

agent

SOMENTE NODEJS

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

agent?: Agent

Valor da propriedade

Agent

allowInsecureConnection

Definir 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 fluxos do navegador. Se essa opção estiver definida e uma resposta for um fluxo, a resposta terá uma propriedade browserStream em vez de blobBody que será indefinida.

O valor padrão é falso

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

multipartBody

Corpo para uma solicitação de várias partes.

multipartBody?: MultipartRequestBody

Valor da propriedade

MultipartRequestBody

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

requestOverrides

Opções adicionais a serem definidas na solicitação. Isso fornece uma maneira de substituir os existentes ou fornecer propriedades de solicitação que não são declaradas.

Para possíveis propriedades válidas, consulte

• Opções de https.request do NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
• RequestInit do navegador: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

AVISO: As opções especificadas aqui substituirão todas as propriedades com os mesmos nomes quando a solicitação for enviada por HttpClient.

requestOverrides?: Record<string, unknown>

Valor da propriedade

Record<string, unknown>

streamResponseStatusCodes

Uma lista de códigos de status de resposta cujo corpo pipelineResponse correspondente deve ser tratado como um fluxo. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer status seria 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

tlsSettings

Configurações para configurar a autenticação do TLS

tlsSettings?: TlsSettings

Valor da propriedade

TlsSettings

tracingOptions

Opções de rastreamento a serem usadas para todos os Intervalos criados.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

url

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

url: string

Valor da propriedade

string

withCredentials

Indica se o agente de usuário deve enviar cookies do outro domínio no caso de solicitações entre origens. O padrão é false.

withCredentials: boolean

Valor da propriedade

boolean