Freigeben über

WebResource class

  • Referenz
Paket:
@azure/core-http

Erstellt ein neues WebResource-Objekt.

Diese Klasse bietet eine Abstraktion für einen REST-Aufruf, indem sie bibliotheksunabhängig ist und die erforderlichen Eigenschaften umgibt, um eine Anforderung zu initiieren.

Konstruktoren

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

Eigenschaften

abortSignal

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

Anforderungstext.
decompressResponse

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

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.
headers

HTTP-Header.
keepAlive

Gibt an, ob die HTTP-Verbindungen während der Anforderungen am Laufenden gehalten werden sollen.
method

Zu verwendende HTTP-Methode.
onDownloadProgress

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

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.
operationResponseGetter

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

Spezifikation der HTTP-Anforderung.
proxySettings

Welcher Proxy verwendet werden soll, falls erforderlich.
query

Abfrage zur URL hinzugefügt.
requestId

Eindeutiger Bezeichner der ausgehenden Anforderung.
shouldDeserialize

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

Ablaufverfolgung: Optionen, die zum Erstellen einer Spanne verwendet werden, wenn die Ablaufverfolgung aktiviert ist.
streamResponseBody

Gibt an, ob der Textkörper von HttpOperationResponse als Stream behandelt werden soll oder nicht.
streamResponseStatusCodes

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

Wie lange in Millisekunden gewartet werden soll, bevor die Anforderung abgebrochen wird?
tracingContext

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

URL der ausgehenden Anforderung.
withCredentials

Gibt an, ob Anmeldeinformationen (über Cookies, Autorisierungsheader oder TLS-Clientzertifikate) gesendet werden sollen, wenn eine Anforderung im Browser an ein standortübergreifendes Ziel gesendet werden soll.

Methoden

clone()

Klonen Sie dieses WebResource-HTTP-Anforderungsobjekt.
prepare(RequestPrepareOptions)

Bereitet die Anforderung vor.
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 zum Konstruktor

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>) 

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parameter

url

string

method
HttpMethods
body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal
AbortSignalLike
timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings
ProxySettings
keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

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

Anforderungstext.

body?: any

Eigenschaftswert

any

decompressResponse

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

decompressResponse?: boolean

Eigenschaftswert

boolean

formData

Formulardaten, die zum Erstellen des Anforderungstexts verwendet werden.

formData?: any

Eigenschaftswert

any

headers

HTTP-Header.

headers: HttpHeadersLike

Eigenschaftswert

HttpHeadersLike

keepAlive

Gibt an, ob die HTTP-Verbindungen während der Anforderungen am Laufenden gehalten werden sollen.

keepAlive?: boolean

Eigenschaftswert

boolean

method

Zu verwendende HTTP-Methode.

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

operationResponseGetter

Eine Funktion, die die richtige OperationResponse für die angegebene Kombination von 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

Spezifikation der HTTP-Anforderung.

operationSpec?: OperationSpec

Eigenschaftswert

OperationSpec

proxySettings

Welcher Proxy verwendet werden soll, falls erforderlich.

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

query

Abfrage zur URL hinzugefügt.

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

Eigenschaftswert

{[key: string]: any}

requestId

Eindeutiger Bezeichner der ausgehenden Anforderung.

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

spanOptions

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

spanOptions?: SpanOptions

Eigenschaftswert

@azure/core-tracing.SpanOptions

streamResponseBody

Warnung

Diese API ist nun veraltet.

Use streamResponseStatusCodes property instead.

Gibt an, ob der Textkörper von HttpOperationResponse als Stream behandelt werden soll oder nicht.

streamResponseBody?: boolean

Eigenschaftswert

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

Eigenschaftswert

Set<number>

timeout

Wie lange in Millisekunden gewartet werden soll, bevor die Anforderung abgebrochen wird?

timeout: number

Eigenschaftswert

number

tracingContext

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

tracingContext?: Context

Eigenschaftswert

@azure/core-tracing.Context

url

URL der ausgehenden Anforderung.

url: string

Eigenschaftswert

string

withCredentials

Gibt an, ob Anmeldeinformationen (über Cookies, Autorisierungsheader oder TLS-Clientzertifikate) gesendet werden sollen, wenn eine Anforderung im Browser an ein standortübergreifendes Ziel gesendet werden soll.

withCredentials: boolean

Eigenschaftswert

boolean

Details zur Methode

clone()

Klonen Sie dieses WebResource-HTTP-Anforderungsobjekt.

function clone(): WebResource

Gibt zurück

WebResource

Der Klon dieses WebResource-HTTP-Anforderungsobjekts.

prepare(RequestPrepareOptions)

Bereitet die Anforderung vor.

function prepare(options: RequestPrepareOptions): WebResource

Parameter

options
RequestPrepareOptions

Optionen, die für die Vorbereitung der Anforderung bereitgestellt werden sollen.

Gibt zurück

WebResource

Gibt das vorbereitete WebResource-Objekt (HTTP Request) zurück, das an die Anforderungspipeline übergeben werden muss.

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()