WebResourceLike interface

Pacote:

@azure/core-http

Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

Propriedades

abortSignal	Sinal de um controlador de anulação. Pode ser usado para anular o envio de uma solicitação de rede e aguardar uma resposta.
body	O conteúdo do corpo HTTP da solicitação.
decompressResponse	Se a resposta deve ser descompactada de acordo com Accept-Encoding cabeçalho (somente node-fetch)
formData	Dados de formulário, usados para criar o corpo da solicitação.
headers	Os cabeçalhos HTTP a serem usados ao fazer a solicitação.
keepAlive	Se a conexão deve ser reutilizado.
method	O método HTTP a ser usado ao fazer a solicitação.
onDownloadProgress	Retorno de chamada que é disparado após o progresso do download.
onUploadProgress	Retorno de chamada que é disparado após o progresso do upload.
operationResponseGetter	Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse fornecida. Se isso for indefinido, uma pesquisa de código de status simples será usada.
operationSpec	Usado para analisar a resposta.
proxySettings	Configuração de proxy.
query	Uma cadeia de caracteres de consulta representada como um objeto .
requestId	Um identificador exclusivo para a solicitação. Usado para registro em log e rastreamento.
shouldDeserialize	Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deverá ser desserializado.
streamResponseBody	Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.
streamResponseStatusCodes	Uma lista de códigos de status de resposta cujo corpo HttpOperationResponse 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.
tracingContext	Rastreamento: contexto usado ao criar intervalos.
url	A URL que está sendo acessada pela solicitação.
withCredentials	Se as credenciais (cookies) devem ser enviadas durante um XHR.

Métodos

clone()	Clone esse objeto de solicitação.
prepare(RequestPrepareOptions)	Define opções na solicitação.
validateRequestProperties()	Valida se as propriedades necessárias, como método, url, cabeçalhos["Content-Type"], cabeçalhos["accept-language"] são definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida.

Detalhes da propriedade

abortSignal

Sinal de um controlador de anulação. Pode ser usado para anular o envio de uma solicitação de rede e aguardar uma resposta.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

body

O conteúdo do corpo HTTP da solicitação.

body?: any

Valor da propriedade

any

decompressResponse

Se a resposta deve ser descompactada de acordo com Accept-Encoding cabeçalho (somente node-fetch)

decompressResponse?: boolean

Valor da propriedade

boolean

formData

Dados de formulário, usados para criar o corpo da solicitação.

formData?: any

Valor da propriedade

any

headers

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

headers: HttpHeadersLike

Valor da propriedade

HttpHeadersLike

keepAlive

Se a conexão deve ser reutilizado.

keepAlive?: boolean

Valor da propriedade

boolean

method

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

method: HttpMethods

Valor da propriedade

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse fornecida. Se isso for indefinido, uma pesquisa de código de status simples será usada.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Valor da propriedade

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Usado para analisar a resposta.

operationSpec?: OperationSpec

Valor da propriedade

OperationSpec

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

query

Uma cadeia de caracteres de consulta representada como um objeto .

query?: {[key: string]: any}

Valor da propriedade

{[key: string]: any}

requestId

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

requestId: string

Valor da propriedade

string

shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deverá ser desserializado.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Valor da propriedade

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Aviso

Essa API foi preterida.

Use streamResponseStatusCodes property instead.

Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.

streamResponseBody?: boolean

Valor da propriedade

boolean

streamResponseStatusCodes

Uma lista de códigos de status de resposta cujo corpo HttpOperationResponse 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.

timeout: number

Valor da propriedade

number

tracingContext

Rastreamento: contexto usado ao criar intervalos.

tracingContext?: Context

Valor da propriedade

@azure/core-tracing.Context

url

A URL que está sendo acessada pela solicitação.

url: string

Valor da propriedade

string

withCredentials

Se as credenciais (cookies) devem ser enviadas durante um XHR.

withCredentials: boolean

Valor da propriedade

boolean

Detalhes do método

clone()

Clone esse objeto de solicitação.

function clone(): WebResourceLike

Retornos

WebResourceLike

prepare(RequestPrepareOptions)

Define opções na solicitação.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parâmetros

options

RequestPrepareOptions

Retornos

WebResourceLike

validateRequestProperties()

Valida se as propriedades necessárias, como método, url, cabeçalhos["Content-Type"], cabeçalhos["accept-language"] são definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida.

function validateRequestProperties()