WebResourceLike interface

Pacchetto:

@azure/core-http

Descrizione di una richiesta HTTP da effettuare a un server remoto.

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	Contenuto del corpo HTTP della richiesta.
decompressResponse	Indica se decomprimere la risposta in base all'intestazione Accept-Encoding (solo di recupero del nodo)
formData	Dati del modulo usati per compilare il corpo della richiesta.
headers	Intestazioni HTTP da usare durante l'esecuzione della richiesta.
keepAlive	Se la connessione deve essere riutilizzata.
method	Metodo HTTP da usare quando si effettua la richiesta.
onDownloadProgress	Callback che viene attivato al download dello stato di avanzamento.
onUploadProgress	Callback che viene attivato al caricamento dello stato di avanzamento.
operationResponseGetter	Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse appropriata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.
operationSpec	Usato per analizzare la risposta.
proxySettings	Configurazione proxy.
query	Stringa di query rappresentata come oggetto .
requestId	Identificatore univoco per la richiesta. Usato per la registrazione e la traccia.
shouldDeserialize	Indipendentemente dal fatto che httpOperationResponse debba essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.
streamResponseBody	Se il corpo di HttpOperationResponse deve essere considerato come flusso.
streamResponseStatusCodes	Elenco dei codici di stato della risposta i cui corpi HttpOperationResponse corrispondenti devono essere considerati come flusso.
timeout	Il numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata un'eccezione AbortError .
tracingContext	Traccia: contesto usato durante la creazione di intervalli.
url	URL a cui si accede dalla richiesta.
withCredentials	Se le credenziali (cookie) devono essere inviate durante una XHR.

Metodi

clone()	Clonare questo oggetto request.
prepare(RequestPrepareOptions)	Imposta le opzioni sulla richiesta.
validateRequestProperties()	Verifica che le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], le intestazioni["accept-language"] siano definite. Genererà un errore se una delle proprietà indicate in precedenza non è definita.

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

Contenuto del corpo HTTP della richiesta.

body?: any

Valore della proprietà

any

decompressResponse

Indica se decomprimere la risposta in base all'intestazione Accept-Encoding (solo di 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 da usare durante l'esecuzione della richiesta.

headers: HttpHeadersLike

Valore della proprietà

HttpHeadersLike

keepAlive

Se la connessione deve essere riutilizzata.

keepAlive?: boolean

Valore della proprietà

boolean

method

Metodo HTTP da usare quando si effettua la richiesta.

method: HttpMethods

Valore della proprietà

HttpMethods

onDownloadProgress

Callback che viene attivato al download dello stato di avanzamento.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Callback che viene attivato al caricamento dello stato di avanzamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

operationResponseGetter

Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse appropriata. 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

Usato per analizzare la risposta.

operationSpec?: OperationSpec

Valore della proprietà

OperationSpec

proxySettings

Configurazione proxy.

proxySettings?: ProxySettings

Valore della proprietà

ProxySettings

query

Stringa di query rappresentata come oggetto .

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

Valore della proprietà

{[key: string]: any}

requestId

Identificatore univoco per la richiesta. Usato per la registrazione e la traccia.

requestId: string

Valore della proprietà

string

shouldDeserialize

Indipendentemente dal fatto che httpOperationResponse debba essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.

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

Valore della proprietà

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Avviso

Questa API è ora deprecata.

Use streamResponseStatusCodes property instead.

Se il corpo di HttpOperationResponse deve essere considerato come flusso.

streamResponseBody?: boolean

Valore della proprietà

boolean

streamResponseStatusCodes

Elenco dei codici di stato della risposta i cui corpi HttpOperationResponse corrispondenti devono essere considerati come flusso.

streamResponseStatusCodes?: Set<number>

Valore della proprietà

Set<number>

timeout

Il numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata un'eccezione AbortError .

timeout: number

Valore della proprietà

number

tracingContext

Traccia: contesto usato durante la creazione di intervalli.

tracingContext?: Context

Valore della proprietà

@azure/core-tracing.Context

url

URL a cui si accede dalla richiesta.

url: string

Valore della proprietà

string

withCredentials

Se le credenziali (cookie) devono essere inviate durante una XHR.

withCredentials: boolean

Valore della proprietà

boolean

Dettagli metodo

clone()

Clonare questo oggetto request.

function clone(): WebResourceLike

Restituisce

WebResourceLike

prepare(RequestPrepareOptions)

Imposta le opzioni sulla richiesta.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametri

options

RequestPrepareOptions

Restituisce

WebResourceLike

validateRequestProperties()

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

function validateRequestProperties()