Partilhar via

WebResource class

  • Referência
Pacote:
@azure/core-http

Cria um novo objeto WebResource.

Esta classe fornece uma abstração sobre uma chamada REST sendo independente de biblioteca/implementação e encapsulando as propriedades necessárias para iniciar uma solicitação.

Construtores

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

Propriedades

abortSignal

Sinal de um controlador abortado. Pode ser usado para anular o envio de uma solicitação de rede e a espera por uma resposta.
body

Corpo do pedido.
decompressResponse

Descompactar ou não a resposta de acordo com Accept-Encoding cabeçalho (somente busca de nó)
formData

Dados do formulário, usados para construir o corpo da solicitação.
headers

Cabeçalhos HTTP.
keepAlive

Se as conexões HTTP devem ser mantidas vivas em todas as solicitações.
method

Método HTTP a ser usado.
onDownloadProgress

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

Retorno de chamada que é acionado após o progresso do carregamento.
operationResponseGetter

Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse dada. Se isso não estiver definido, uma pesquisa simples de código de status será usada.
operationSpec

Especificação da solicitação HTTP.
proxySettings

Qual proxy usar, se necessário.
query

Consulta adicionada ao URL.
requestId

Identificador exclusivo da solicitação enviada.
shouldDeserialize

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

Rastreamento: opções usadas para criar uma extensão quando o rastreamento está habilitado.
streamResponseBody

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

Uma lista de códigos de status cujo corpo HttpOperationResponse correspondente deve ser tratado como um fluxo.
timeout

Quanto tempo esperar em milissegundos antes de abortar a solicitação.
tracingContext

Rastreamento: Contexto usado na criação de Spans.
url

URL da solicitação de saída.
withCredentials

Se deseja enviar credenciais (por meio de cookies, cabeçalhos de autorização ou certificados de cliente TLS) ao fazer uma solicitação no navegador para um destino entre sites.

Métodos

clone()

Clone este objeto de solicitação HTTP WebResource.
prepare(RequestPrepareOptions)

Prepara o pedido.
validateRequestProperties()

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

Detalhes do Construtor

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>) 

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parâmetros

url

string

method
HttpMethods
body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal
AbortSignalLike
timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings
ProxySettings
keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

Detalhes de Propriedade

abortSignal

Sinal de um controlador abortado. Pode ser usado para anular o envio de uma solicitação de rede e a espera por uma resposta.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

body

Corpo do pedido.

body?: any

Valor de Propriedade

any

decompressResponse

Descompactar ou não a resposta de acordo com Accept-Encoding cabeçalho (somente busca de nó)

decompressResponse?: boolean

Valor de Propriedade

boolean

formData

Dados do formulário, usados para construir o corpo da solicitação.

formData?: any

Valor de Propriedade

any

headers

Cabeçalhos HTTP.

headers: HttpHeadersLike

Valor de Propriedade

HttpHeadersLike

keepAlive

Se as conexões HTTP devem ser mantidas vivas em todas as solicitações.

keepAlive?: boolean

Valor de Propriedade

boolean

method

Método HTTP a ser usado.

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Retorno de chamada que é acionado após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

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

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

Valor de Propriedade

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

operationSpec

Especificação da solicitação HTTP.

operationSpec?: OperationSpec

Valor de Propriedade

OperationSpec

proxySettings

Qual proxy usar, se necessário.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query

Consulta adicionada ao URL.

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

Valor de Propriedade

{[key: string]: any}

requestId

Identificador exclusivo da solicitação enviada.

requestId: string

Valor de Propriedade

string

shouldDeserialize

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

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

Valor de Propriedade

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Rastreamento: opções usadas para criar uma extensão quando o rastreamento está habilitado.

spanOptions?: SpanOptions

Valor de Propriedade

@azure/core-tracing.SpanOptions

streamResponseBody

Aviso

Esta API foi preterida.

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Valor de Propriedade

boolean

streamResponseStatusCodes

Uma lista de códigos de status cujo corpo HttpOperationResponse correspondente deve ser tratado como um fluxo.

streamResponseStatusCodes?: Set<number>

Valor de Propriedade

Set<number>

timeout

Quanto tempo esperar em milissegundos antes de abortar a solicitação.

timeout: number

Valor de Propriedade

number

tracingContext

Rastreamento: Contexto usado na criação de Spans.

tracingContext?: Context

Valor de Propriedade

@azure/core-tracing.Context

url

URL da solicitação de saída.

url: string

Valor de Propriedade

string

withCredentials

Se deseja enviar credenciais (por meio de cookies, cabeçalhos de autorização ou certificados de cliente TLS) ao fazer uma solicitação no navegador para um destino entre sites.

withCredentials: boolean

Valor de Propriedade

boolean

Detalhes de Método

clone()

Clone este objeto de solicitação HTTP WebResource.

function clone(): WebResource

Devoluções

WebResource

O clone deste objeto de solicitação HTTP WebResource.

prepare(RequestPrepareOptions)

Prepara o pedido.

function prepare(options: RequestPrepareOptions): WebResource

Parâmetros

options
RequestPrepareOptions

Opções a fornecer para a preparação do pedido.

Devoluções

WebResource

Retorna o objeto WebResource (HTTP Request) preparado que precisa ser dado ao pipeline de solicitação.

validateRequestProperties()

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

function validateRequestProperties()