WebResourceLike interface

Pacote:

@azure/core-http

Uma descrição de um pedido HTTP a ser efetuada a um servidor remoto.

Propriedades

abortSignal	Sinal de um controlador de abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.
body	O conteúdo do corpo HTTP do pedido.
decompressResponse	Se pretende ou não descomprimir a resposta de acordo com Accept-Encoding cabeçalho (apenas obtenção de nó)
formData	Dados de formulário, utilizados para criar o corpo do pedido.
headers	Os cabeçalhos HTTP a utilizar ao fazer o pedido.
keepAlive	Se a ligação tiver de ser reutilizada.
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.
operationResponseGetter	Uma função que devolve o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse especificada. Se não estiver definido, será utilizada uma pesquisa de código de estado simples.
operationSpec	Utilizado para analisar a resposta.
proxySettings	Configuração do proxy.
query	Uma cadeia de consulta representada como um objeto.
requestId	Um identificador exclusivo para o pedido. Utilizado para registo e rastreio.
shouldDeserialize	Se o HttpOperationResponse deve ou não ser desserializado. Se isto não estiver definido, o HttpOperationResponse deve ser desserializado.
streamResponseBody	Se o corpo de HttpOperationResponse deve ou não ser tratado como um fluxo.
streamResponseStatusCodes	Uma lista de códigos de estado de resposta cujo corpo httpOperationResponse 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, é lançado um AbortError .
tracingContext	Rastreio: contexto utilizado ao criar intervalos.
url	O URL que está a ser acedido pelo pedido.
withCredentials	Se as credenciais (cookies) devem ser enviadas durante um XHR.

Métodos

clone()	Clone este objeto de pedido.
prepare(RequestPrepareOptions)	Define as opções no pedido.
validateRequestProperties()	Valida que as propriedades necessárias, como o método, url, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] estão definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida.

Detalhes de Propriedade

abortSignal

Sinal de um controlador de abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

body

O conteúdo do corpo HTTP do pedido.

body?: any

Valor de Propriedade

any

decompressResponse

Se pretende ou não descomprimir a resposta de acordo com Accept-Encoding cabeçalho (apenas obtenção de nó)

decompressResponse?: boolean

Valor de Propriedade

boolean

formData

Dados de formulário, utilizados para criar o corpo do pedido.

formData?: any

Valor de Propriedade

any

headers

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

headers: HttpHeadersLike

Valor de Propriedade

HttpHeadersLike

keepAlive

Se a ligação tiver de ser reutilizada.

keepAlive?: boolean

Valor de Propriedade

boolean

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

operationResponseGetter

Uma função que devolve o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse especificada. Se não estiver definido, será utilizada uma pesquisa de código de estado simples.

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

Valor de Propriedade

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

operationSpec

Utilizado para analisar a resposta.

operationSpec?: OperationSpec

Valor de Propriedade

OperationSpec

proxySettings

Configuração do proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query

Uma cadeia de consulta representada como um objeto.

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

Valor de Propriedade

{[key: string]: any}

requestId

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

requestId: string

Valor de Propriedade

string

shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isto não estiver definido, o HttpOperationResponse deve ser desserializado.

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

Valor de Propriedade

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Aviso

Esta API foi preterida.

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Valor de Propriedade

boolean

streamResponseStatusCodes

Uma lista de códigos de estado de resposta cujo corpo httpOperationResponse 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, é lançado um AbortError .

timeout: number

Valor de Propriedade

number

tracingContext

Rastreio: contexto utilizado ao criar intervalos.

tracingContext?: Context

Valor de Propriedade

@azure/core-tracing.Context

url

O URL que está a ser acedido pelo pedido.

url: string

Valor de Propriedade

string

withCredentials

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

withCredentials: boolean

Valor de Propriedade

boolean

Detalhes de Método

clone()

Clone este objeto de pedido.

function clone(): WebResourceLike

Devoluções

WebResourceLike

prepare(RequestPrepareOptions)

Define as opções no pedido.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parâmetros

options

RequestPrepareOptions

Devoluções

WebResourceLike

validateRequestProperties()

Valida que as propriedades necessárias, como o método, url, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] estão definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida.

function validateRequestProperties()