PipelineRequest interface

Paket:

@azure/core-rest-pipeline

Metadaten zu einer Anforderung, die von der Pipeline gestellt wird.

Eigenschaften

abortSignal	Wird verwendet, um die Anforderung später abzubrechen.
agent	NUR NODEJS Eine option nur für knoten zum bereitstellen eines benutzerdefinierten http.Agent/https.Agent. Macht nichts, wenn im Browser ausgeführt wird.
allowInsecureConnection	Legen Sie auf true fest, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird.
body	Der HTTP-Textinhalt (falls vorhanden)
disableKeepAlive	Wenn die Verbindung nicht wiederverwendet werden soll.
enableBrowserStreams	NUR BROWSER Nur eine Browseroption zum Aktivieren von Browserstreams. Wenn diese Option festgelegt ist und eine Antwort ein Stream ist, verfügt die Antwort über eine Eigenschaft browserStream , die blobBody nicht definiert wird. Der Standardwert ist „false“.
formData	So simulieren Sie einen Browserformularbeitrag
headers	Die HTTP-Header, die beim Stellen der Anforderung verwendet werden sollen.
method	Die HTTP-Methode, die beim Stellen der Anforderung verwendet werden soll.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.
proxySettings	Proxykonfiguration.
requestId	Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.
streamResponseStatusCodes	Eine Liste von Antwortstatuscodes, deren zugehörigen PipelineResponse-Text als Stream behandelt werden soll. Wenn streamResponseStatusCodes den Wert enthält, Number.POSITIVE_INFINITY jeder Status als Stream behandelt wird.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern 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 zum Konfigurieren der TLS-Authentifizierung
tracingOptions	Ablaufverfolgungsoptionen, die für alle erstellten Spans verwendet werden sollen.
url	Die URL, für die die Anforderung erfolgen soll.
withCredentials	Gibt an, ob der Benutzer-Agent cookies von der anderen Domäne bei ursprungsübergreifenden Anforderungen senden soll. Der 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 für knoten zum bereitstellen eines benutzerdefinierten http.Agent/https.Agent. Macht nichts, wenn im Browser ausgeführt wird.

agent?: Agent

Eigenschaftswert

Agent

allowInsecureConnection

Legen Sie auf true fest, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird.

allowInsecureConnection?: boolean

Eigenschaftswert

boolean

body

Der HTTP-Textinhalt (falls vorhanden)

body?: RequestBodyType

Eigenschaftswert

RequestBodyType

disableKeepAlive

Wenn die Verbindung nicht wiederverwendet werden soll.

disableKeepAlive?: boolean

Eigenschaftswert

boolean

enableBrowserStreams

NUR BROWSER

Nur eine Browseroption zum Aktivieren von Browserstreams. Wenn diese Option festgelegt ist und eine Antwort ein Stream ist, verfügt die Antwort über eine Eigenschaft browserStream , die blobBody nicht definiert wird.

Der Standardwert ist „false“.

enableBrowserStreams?: boolean

Eigenschaftswert

boolean

formData

So simulieren Sie einen Browserformularbeitrag

formData?: FormDataMap

Eigenschaftswert

FormDataMap

headers

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

headers: HttpHeaders

Eigenschaftswert

HttpHeaders

method

Die HTTP-Methode, die beim Stellen 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 Hochladen des Fortschritts 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 von Antwortstatuscodes, deren zugehörigen PipelineResponse-Text als Stream behandelt werden soll. Wenn streamResponseStatusCodes den Wert enthält, Number.POSITIVE_INFINITY jeder Status als Stream behandelt wird.

streamResponseStatusCodes?: Set<number>

Eigenschaftswert

Set<number>

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern 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 zum Konfigurieren der TLS-Authentifizierung

tlsSettings?: TlsSettings

Eigenschaftswert

TlsSettings

tracingOptions

Ablaufverfolgungsoptionen, die für alle erstellten Spans verwendet werden sollen.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

url

Die URL, für die die Anforderung erfolgen soll.

url: string

Eigenschaftswert

string

withCredentials

Gibt an, ob der Benutzer-Agent cookies von der anderen Domäne bei ursprungsübergreifenden Anforderungen senden soll. Der Standardwert ist „false“.

withCredentials: boolean

Eigenschaftswert

boolean