PipelineRequestOptions interface

Paket:

@azure/core-https

Einstellungen zum Initialisieren einer Anforderung. Fast äquivalent zu Partial<PipelineRequest>, aber die URL ist obligatorisch.

Eigenschaften

abortSignal	Wird verwendet, um die Anforderung später abzubrechen.
body	Der HTTP-Textkörperinhalt (sofern vorhanden)
formData	So simulieren Sie einen Browserformularbeitrag
headers	Die HTTP-Header, die beim Erstellen der Anforderung verwendet werden sollen.
keepAlive	Wenn die Verbindung wiederverwendet werden soll. Die Standardeinstellung ist „true“.
method	Die HTTP-Methode, die beim Erstellen der Anforderung verwendet werden soll.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadfortschritt ausgelöst wird.
proxySettings	Proxy-Konfiguration.
requestId	Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.
spanOptions	Optionen zum Erstellen einer Spanne, wenn die Ablaufverfolgung aktiviert ist.
streamResponseStatusCodes	Eine Liste der Antwortstatuscodes, deren zugehöriger PipelineResponse-Text als Datenstrom behandelt werden soll.
timeout	Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst. Der Standardwert ist 0, wodurch das Timeout deaktiviert wird.
url	Die URL, an die die Anforderung gestellt werden soll.
withCredentials	Wenn Anmeldeinformationen (Cookies) während eines XHR gesendet werden sollen. Der Standardwert ist „false“.

Details zur Eigenschaft

abortSignal

Wird verwendet, um die Anforderung später abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

body

Der HTTP-Textkörperinhalt (sofern vorhanden)

body?: RequestBodyType

Eigenschaftswert

RequestBodyType

formData

So simulieren Sie einen Browserformularbeitrag

formData?: FormDataMap

Eigenschaftswert

FormDataMap

headers

Die HTTP-Header, die beim Erstellen der Anforderung verwendet werden sollen.

headers?: HttpHeaders

Eigenschaftswert

HttpHeaders

keepAlive

Wenn die Verbindung wiederverwendet werden soll. Die Standardeinstellung ist „true“.

keepAlive?: boolean

Eigenschaftswert

boolean

method

Die HTTP-Methode, die beim Erstellen der Anforderung verwendet werden soll.

method?: HttpMethods

Eigenschaftswert

HttpMethods

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

onUploadProgress

Rückruf, der beim Uploadfortschritt ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

proxySettings

Proxy-Konfiguration.

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

requestId

Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.

requestId?: string

Eigenschaftswert

string

spanOptions

Optionen zum Erstellen einer Spanne, wenn die Ablaufverfolgung aktiviert ist.

spanOptions?: SpanOptions

Eigenschaftswert

@azure/core-tracing.SpanOptions

streamResponseStatusCodes

Eine Liste der Antwortstatuscodes, deren zugehöriger PipelineResponse-Text als Datenstrom behandelt werden soll.

streamResponseStatusCodes?: Set<number>

Eigenschaftswert

Set<number>

timeout

Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird ein AbortError ausgelöst. Der Standardwert ist 0, wodurch das Timeout deaktiviert wird.

timeout?: number

Eigenschaftswert

number

url

Die URL, an die die Anforderung gestellt werden soll.

url: string

Eigenschaftswert

string

withCredentials

Wenn Anmeldeinformationen (Cookies) während eines XHR gesendet werden sollen. Der Standardwert ist „false“.

withCredentials?: boolean

Eigenschaftswert

boolean