WebResourceLike interface

Paket:

@azure/core-http

Eine Beschreibung einer HTTP-Anforderung, die an einen Remoteserver gestellt werden soll.

Eigenschaften

abortSignal	Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.
body	Der HTTP-Textinhalt der Anforderung.
decompressResponse	Gibt an, ob die Antwort gemäß Accept-Encoding Header dekomprimiert werden soll (nur node-fetch)
formData	Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.
headers	Die HTTP-Header, die bei der Anforderung verwendet werden sollen.
keepAlive	Wenn die Verbindung wiederverwendet werden soll.
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 Uploadvorgang ausgelöst wird.
operationResponseGetter	Eine Funktion, die die richtige OperationResponse für die angegebene Kombination aus OperationSpec und HttpOperationResponse zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.
operationSpec	Wird verwendet, um die Antwort zu analysieren.
proxySettings	Proxykonfiguration.
query	Eine Abfragezeichenfolge, die als Objekt dargestellt wird.
requestId	Ein eindeutiger Bezeichner für die Anforderung. Wird für die Protokollierung und Ablaufverfolgung verwendet.
shouldDeserialize	Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.
streamResponseBody	Gibt an, ob der Text der HttpOperationResponse als Stream behandelt werden soll.
streamResponseStatusCodes	Eine Liste von Antwortstatuscodes, deren entsprechender HttpOperationResponse-Text als Stream behandelt werden soll.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird eine AbortError ausgelöst.
tracingContext	Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.
url	Die URL, auf die von der Anforderung zugegriffen wird.
withCredentials	Wenn Anmeldeinformationen (Cookies) während einer XHR gesendet werden sollen.

Methoden

clone()	Klonen Sie dieses Anforderungsobjekt.
prepare(RequestPrepareOptions)	Legt Optionen für die Anforderung fest.
validateRequestProperties()	Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Es wird ein Fehler ausgelöst, wenn eine der oben genannten Eigenschaften nicht definiert ist.

Details zur Eigenschaft

abortSignal

Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

body

Der HTTP-Textinhalt der Anforderung.

body?: any

Eigenschaftswert

any

decompressResponse

Gibt an, ob die Antwort gemäß Accept-Encoding Header dekomprimiert werden soll (nur node-fetch)

decompressResponse?: boolean

Eigenschaftswert

boolean

formData

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.

formData?: any

Eigenschaftswert

any

headers

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

headers: HttpHeadersLike

Eigenschaftswert

HttpHeadersLike

keepAlive

Wenn die Verbindung wiederverwendet werden soll.

keepAlive?: boolean

Eigenschaftswert

boolean

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 Uploadvorgang ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

operationResponseGetter

Eine Funktion, die die richtige OperationResponse für die angegebene Kombination aus OperationSpec und HttpOperationResponse zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Eigenschaftswert

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Wird verwendet, um die Antwort zu analysieren.

operationSpec?: OperationSpec

Eigenschaftswert

OperationSpec

proxySettings

Proxykonfiguration.

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

query

Eine Abfragezeichenfolge, die als Objekt dargestellt wird.

query?: {[key: string]: any}

Eigenschaftswert

{[key: string]: any}

requestId

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

requestId: string

Eigenschaftswert

string

shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Warnung

Diese API ist nun veraltet.

Use streamResponseStatusCodes property instead.

Gibt an, ob der Text der HttpOperationResponse als Stream behandelt werden soll.

streamResponseBody?: boolean

Eigenschaftswert

boolean

streamResponseStatusCodes

Eine Liste von Antwortstatuscodes, deren entsprechender HttpOperationResponse-Text als Stream behandelt werden soll.

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 eine AbortError ausgelöst.

timeout: number

Eigenschaftswert

number

tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.

tracingContext?: Context

Eigenschaftswert

@azure/core-tracing.Context

url

Die URL, auf die von der Anforderung zugegriffen wird.

url: string

Eigenschaftswert

string

withCredentials

Wenn Anmeldeinformationen (Cookies) während einer XHR gesendet werden sollen.

withCredentials: boolean

Eigenschaftswert

boolean

Details zur Methode

clone()

Klonen Sie dieses Anforderungsobjekt.

function clone(): WebResourceLike

Gibt zurück

WebResourceLike

prepare(RequestPrepareOptions)

Legt Optionen für die Anforderung fest.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parameter

options

RequestPrepareOptions

Gibt zurück

WebResourceLike

validateRequestProperties()

Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Es wird ein Fehler ausgelöst, wenn eine der oben genannten Eigenschaften nicht definiert ist.

function validateRequestProperties()