PipelineRequestOptions interface

Pacchetto:

@azure/core-rest-pipeline

Impostazioni per inizializzare una richiesta. Quasi equivalente a Parziale, ma l'URL è obbligatorio.

Proprietà

abortSignal	Usato per interrompere la richiesta in un secondo momento.
allowInsecureConnection	Impostare su true se la richiesta viene inviata tramite HTTP anziché HTTPS
body	Contenuto del corpo HTTP (se presente)
disableKeepAlive	Se la connessione non deve essere riutilizzata.
enableBrowserStreams	SOLO BROWSER Un'opzione del browser solo per abilitare l'uso dell'API Stream. Se questa opzione è impostata e viene utilizzata la streaming (vedere streamResponseStatusCodes), la risposta avrà una proprietà browserStream anziché blobBody non definita. Il valore predefinito è False
formData	Per simulare un post del modulo del browser
headers	Intestazioni HTTP da usare durante l'esecuzione della richiesta.
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.
proxySettings	Configurazione proxy.
requestId	Identificatore univoco per la richiesta. Usato per la registrazione e la traccia.
streamResponseStatusCodes	Elenco dei codici di stato della risposta il cui corpo pipelineResponse corrispondente deve essere considerato 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 . Impostazione predefinita su 0, che disabilita il timeout.
tracingOptions	Opzioni usate per creare un intervallo quando la traccia è abilitata.
url	URL a cui inviare la richiesta.
withCredentials	Se le credenziali (cookie) devono essere inviate durante una XHR. Il valore predefinito è false.

Dettagli proprietà

abortSignal

Usato per interrompere la richiesta in un secondo momento.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP anziché HTTPS

allowInsecureConnection?: boolean

Valore della proprietà

boolean

body

Contenuto del corpo HTTP (se presente)

body?: RequestBodyType

Valore della proprietà

RequestBodyType

disableKeepAlive

Se la connessione non deve essere riutilizzata.

disableKeepAlive?: boolean

Valore della proprietà

boolean

enableBrowserStreams

SOLO BROWSER

Un'opzione del browser solo per abilitare l'uso dell'API Stream. Se questa opzione è impostata e viene utilizzata la streaming (vedere streamResponseStatusCodes), la risposta avrà una proprietà browserStream anziché blobBody non definita.

Il valore predefinito è False

enableBrowserStreams?: boolean

Valore della proprietà

boolean

formData

Per simulare un post del modulo del browser

formData?: FormDataMap

Valore della proprietà

FormDataMap

headers

Intestazioni HTTP da usare durante l'esecuzione della richiesta.

headers?: HttpHeaders

Valore della proprietà

HttpHeaders

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

proxySettings

Configurazione proxy.

proxySettings?: ProxySettings

Valore della proprietà

ProxySettings

requestId

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

requestId?: string

Valore della proprietà

string

streamResponseStatusCodes

Elenco dei codici di stato della risposta il cui corpo pipelineResponse corrispondente deve essere considerato 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 . Impostazione predefinita su 0, che disabilita il timeout.

timeout?: number

Valore della proprietà

number

tracingOptions

Opzioni usate per creare un intervallo quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

url

URL a cui inviare la richiesta.

url: string

Valore della proprietà

string

withCredentials

Se le credenziali (cookie) devono essere inviate durante una XHR. Il valore predefinito è false.

withCredentials?: boolean

Valore della proprietà

boolean