PipelineRequestOptions interface

Paket:

@azure/core-rest-pipeline

Einstellungen zum Initialisieren einer Anforderung. Fast gleichbedeutend mit Partielle, url ist jedoch obligatorisch.

Eigenschaften

abortSignal	Wird verwendet, um die Anforderung später abzubrechen.
agent	NUR NODEJS Eine Option "Nur Knoten" zum Bereitstellen eines benutzerdefinierten http.Agent/https.Agent. HINWEIS: In der Regel sollte dies eine Instanz sein, die von mehreren Anforderungen gemeinsam verwendet wird, damit die zugrunde liegende Verbindung mit dem Dienst wiederverwendet werden kann. Führt nichts aus, wenn er im Browser ausgeführt wird.
allowInsecureConnection	Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird
body	Der HTTP-Textkörperinhalt (sofern vorhanden)
disableKeepAlive	Wenn die Verbindung nicht wiederverwendet werden soll.
enableBrowserStreams	NUR BROWSER Eine Nur-Browser-Option, um die Verwendung der Streams-API zu aktivieren. Wenn diese Option festgelegt ist und Streaming verwendet wird (siehe streamResponseStatusCodes), verfügt die Antwort über eine Eigenschaft browserStream anstelle von blobBody, die nicht definiert ist. Standardwert ist "false".
formData	So simulieren Sie einen Browserformularbeitrag
headers	Die HTTP-Header, die beim Erstellen der Anforderung verwendet werden sollen.
method	Die HTTP-Methode, die beim Erstellen der Anforderung verwendet werden soll.
multipartBody	Textkörper für eine mehrteilige Anforderung.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadfortschritt ausgelöst wird.
proxySettings	Proxykonfiguration.
requestId	Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.
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.
tlsSettings	Einstellungen für die Konfiguration der TLS-Authentifizierung
tracingOptions	Optionen zum Erstellen einer Spanne, wenn die Ablaufverfolgung aktiviert ist.
url	Die URL, an die die Anforderung gestellt werden soll.
withCredentials	Wenn Anmeldeinformationen (Cookies) während eines XHR gesendet werden sollen. Standardwert ist "false".

Details zur Eigenschaft

abortSignal

Wird verwendet, um die Anforderung später abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

agent

NUR NODEJS

Eine Option "Nur Knoten" zum Bereitstellen eines benutzerdefinierten http.Agent/https.Agent. HINWEIS: In der Regel sollte dies eine Instanz sein, die von mehreren Anforderungen gemeinsam verwendet wird, damit die zugrunde liegende Verbindung mit dem Dienst wiederverwendet werden kann. Führt nichts aus, wenn er im Browser ausgeführt wird.

agent?: Agent

Eigenschaftswert

Agent

allowInsecureConnection

Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird

allowInsecureConnection?: boolean

Eigenschaftswert

boolean

body

Der HTTP-Textkörperinhalt (sofern vorhanden)

body?: RequestBodyType

Eigenschaftswert

RequestBodyType

disableKeepAlive

Wenn die Verbindung nicht wiederverwendet werden soll.

disableKeepAlive?: boolean

Eigenschaftswert

boolean

enableBrowserStreams

NUR BROWSER

Eine Nur-Browser-Option, um die Verwendung der Streams-API zu aktivieren. Wenn diese Option festgelegt ist und Streaming verwendet wird (siehe streamResponseStatusCodes), verfügt die Antwort über eine Eigenschaft browserStream anstelle von blobBody, die nicht definiert ist.

Standardwert ist "false".

enableBrowserStreams?: boolean

Eigenschaftswert

boolean

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

method

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

method?: HttpMethods

Eigenschaftswert

HttpMethods

multipartBody

Textkörper für eine mehrteilige Anforderung.

multipartBody?: MultipartRequestBody

Eigenschaftswert

MultipartRequestBody

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

Proxykonfiguration.

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

requestId

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

requestId?: string

Eigenschaftswert

string

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

tlsSettings

Einstellungen für die Konfiguration der TLS-Authentifizierung

tlsSettings?: TlsSettings

Eigenschaftswert

TlsSettings

tracingOptions

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

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

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. Standardwert ist "false".

withCredentials?: boolean

Eigenschaftswert

boolean