Condividi tramite

PipelineRequestOptions interface

  • Riferimento
Pacchetto:
@azure/core-rest-pipeline

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

Proprietà

abortSignal

Usato per interrompere la richiesta in un secondo momento.
agent

SOLO NODEJS

Opzione Solo nodo per fornire un http.Agent/https.Agentpersonalizzato. NOTA: in genere questa deve essere un'istanza condivisa da più richieste in modo che la connessione sottostante al servizio possa essere riutilizzata. Non esegue alcuna operazione durante l'esecuzione nel browser.
allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP invece di HTTPS
body

Contenuto del corpo HTTP (se presente)
disableKeepAlive

Se la connessione non deve essere riutilizzata.
enableBrowserStreams

SOLO BROWSER

Opzione solo browser per abilitare l'uso dell'API Streams. Se questa opzione è impostata e viene usata la trasmissione (vedere streamResponseStatusCodes), la risposta avrà una proprietà browserStream anziché blobBody che non sarà 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.
multipartBody

Corpo di una richiesta multipart.
onDownloadProgress

Callback che viene attivato all'avanzamento del download.
onUploadProgress

Callback che viene attivato al momento dell'avanzamento del caricamento.
proxySettings

Configurazione del proxy.
requestId

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

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

Numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata una AbortError. Il valore predefinito è 0, che disabilita il timeout.
tlsSettings

Impostazioni per la configurazione dell'autenticazione TLS
tracingOptions

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

URL a cui effettuare 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

agent

SOLO NODEJS

Opzione Solo nodo per fornire un http.Agent/https.Agentpersonalizzato. NOTA: in genere questa deve essere un'istanza condivisa da più richieste in modo che la connessione sottostante al servizio possa essere riutilizzata. Non esegue alcuna operazione durante l'esecuzione nel browser.

agent?: Agent

Valore della proprietà

Agent

allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP invece di 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

Opzione solo browser per abilitare l'uso dell'API Streams. Se questa opzione è impostata e viene usata la trasmissione (vedere streamResponseStatusCodes), la risposta avrà una proprietà browserStream anziché blobBody che non sarà 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

multipartBody

Corpo di una richiesta multipart.

multipartBody?: MultipartRequestBody

Valore della proprietà

MultipartRequestBody

onDownloadProgress

Callback che viene attivato all'avanzamento del download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Callback che viene attivato al momento dell'avanzamento del caricamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

proxySettings

Configurazione del 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 di codici di stato della risposta il cui corpo PipelineResponse corrispondente deve essere considerato come un flusso.

streamResponseStatusCodes?: Set<number>

Valore della proprietà

Set<number>

timeout

Numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata una AbortError. Il valore predefinito è 0, che disabilita il timeout.

timeout?: number

Valore della proprietà

number

tlsSettings

Impostazioni per la configurazione dell'autenticazione TLS

tlsSettings?: TlsSettings

Valore della proprietà

TlsSettings

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

url

URL a cui effettuare 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