Condividi tramite

WebResource class

  • Riferimento
Pacchetto:
@azure/core-http

Crea un nuovo oggetto WebResource.

Questa classe fornisce un'astrazione su una chiamata REST essendo indipendente dalla libreria/implementazione e eseguendo il wrapping delle proprietà necessarie per avviare una richiesta.

Costruttori

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>)

Proprietà

abortSignal

Segnale di un controller di interruzione. Può essere usato per interrompere l'invio di una richiesta di rete e l'attesa di una risposta.
body

Corpo della richiesta.
decompressResponse

Indica se decomprimere o meno la risposta in base all'intestazione Accept-Encoding (solo recupero del nodo)
formData

Dati del modulo, usati per compilare il corpo della richiesta.
headers

Intestazioni HTTP.
keepAlive

Indica se mantenere attive le connessioni HTTP in tutte le richieste.
method

Metodo HTTP da usare.
onDownloadProgress

Callback attivato al momento dell'avanzamento del download.
onUploadProgress

Callback attivato al momento del caricamento.
operationResponseGetter

Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse specificata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.
operationSpec

Specifica della richiesta HTTP.
proxySettings

Quale proxy usare, se necessario.
query

Query aggiunta all'URL.
requestId

Identificatore univoco della richiesta in uscita.
shouldDeserialize

Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.
spanOptions

Traccia: opzioni usate per creare un intervallo quando la traccia è abilitata.
streamResponseBody

Indica se il corpo di HttpOperationResponse deve essere considerato come un flusso.
streamResponseStatusCodes

Elenco di codici di stato il cui corpo HttpOperationResponse corrispondente deve essere considerato come un flusso.
timeout

Tempo di attesa in millisecondi prima dell'interruzione della richiesta.
tracingContext

Traccia: contesto usato durante la creazione di span.
url

URL della richiesta in uscita.
withCredentials

Se inviare le credenziali (tramite cookie, intestazioni di autorizzazione o certificati client TLS) quando si effettua una richiesta nel browser a una destinazione tra siti.

Metodi

clone()

Clonare questo oggetto richiesta HTTP WebResource.
prepare(RequestPrepareOptions)

Prepara la richiesta.
validateRequestProperties()

Verifica che siano definite le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], intestazioni["accept-language"]. Verrà generato un errore se una delle proprietà indicate in precedenza non è definita.

Dettagli costruttore

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>)

Parametri

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>

Dettagli proprietà

abortSignal

Segnale di un controller di interruzione. Può essere usato per interrompere l'invio di una richiesta di rete e l'attesa di una risposta.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

body

Corpo della richiesta.

body?: any

Valore della proprietà

any

decompressResponse

Indica se decomprimere o meno la risposta in base all'intestazione Accept-Encoding (solo recupero del nodo)

decompressResponse?: boolean

Valore della proprietà

boolean

formData

Dati del modulo, usati per compilare il corpo della richiesta.

formData?: any

Valore della proprietà

any

headers

Intestazioni HTTP.

headers: HttpHeadersLike

Valore della proprietà

HttpHeadersLike

keepAlive

Indica se mantenere attive le connessioni HTTP in tutte le richieste.

keepAlive?: boolean

Valore della proprietà

boolean

method

Metodo HTTP da usare.

method: HttpMethods

Valore della proprietà

HttpMethods

onDownloadProgress

Callback attivato al momento dell'avanzamento del download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Callback attivato al momento del caricamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

operationResponseGetter

Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse specificata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.

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

Valore della proprietà

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

operationSpec

Specifica della richiesta HTTP.

operationSpec?: OperationSpec

Valore della proprietà

OperationSpec

proxySettings

Quale proxy usare, se necessario.

proxySettings?: ProxySettings

Valore della proprietà

ProxySettings

query

Query aggiunta all'URL.

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

Valore della proprietà

{[key: string]: any}

requestId

Identificatore univoco della richiesta in uscita.

requestId: string

Valore della proprietà

string

shouldDeserialize

Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.

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

Valore della proprietà

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Traccia: opzioni usate per creare un intervallo quando la traccia è abilitata.

spanOptions?: SpanOptions

Valore della proprietà

@azure/core-tracing.SpanOptions

streamResponseBody

Avviso

Questa API è ora deprecata.

Use streamResponseStatusCodes property instead.

Indica se il corpo di HttpOperationResponse deve essere considerato come un flusso.

streamResponseBody?: boolean

Valore della proprietà

boolean

streamResponseStatusCodes

Elenco di codici di stato il cui corpo HttpOperationResponse corrispondente deve essere considerato come un flusso.

streamResponseStatusCodes?: Set<number>

Valore della proprietà

Set<number>

timeout

Tempo di attesa in millisecondi prima dell'interruzione della richiesta.

timeout: number

Valore della proprietà

number

tracingContext

Traccia: contesto usato durante la creazione di span.

tracingContext?: Context

Valore della proprietà

@azure/core-tracing.Context

url

URL della richiesta in uscita.

url: string

Valore della proprietà

string

withCredentials

Se inviare le credenziali (tramite cookie, intestazioni di autorizzazione o certificati client TLS) quando si effettua una richiesta nel browser a una destinazione tra siti.

withCredentials: boolean

Valore della proprietà

boolean

Dettagli metodo

clone()

Clonare questo oggetto richiesta HTTP WebResource.

function clone(): WebResource

Restituisce

WebResource

Clone di questo oggetto richiesta HTTP WebResource.

prepare(RequestPrepareOptions)

Prepara la richiesta.

function prepare(options: RequestPrepareOptions): WebResource

Parametri

options
RequestPrepareOptions

Opzioni da specificare per la preparazione della richiesta.

Restituisce

WebResource

Restituisce l'oggetto WebResource (richiesta HTTP) preparato che deve essere assegnato alla pipeline di richiesta.

validateRequestProperties()

Verifica che siano definite le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], intestazioni["accept-language"]. Verrà generato un errore se una delle proprietà indicate in precedenza non è definita.

function validateRequestProperties()