Partager via

WebResource class

  • Référence
Paquet:
@azure/core-http

Crée un objet WebResource.

Cette classe fournit une abstraction sur un appel REST en étant indépendante de la bibliothèque/de l’implémentation et en encapsulant les propriétés nécessaires pour lancer une requête.

Constructeurs

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

Propriétés

abortSignal

Signal d’un contrôleur d’abandon. Peut être utilisé pour abandonner à la fois l’envoi d’une demande réseau et l’attente d’une réponse.
body

Corps de la demande.
decompressResponse

Indique s’il faut décompresser la réponse en fonction de Accept-Encoding en-tête (node-fetch uniquement)
formData

Données de formulaire, utilisées pour générer le corps de la demande.
headers

En-têtes HTTP.
keepAlive

Indique s’il faut maintenir les connexions HTTP actives tout au long des requêtes.
method

Méthode HTTP à utiliser.
onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.
onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.
operationResponseGetter

Fonction qui retourne l’OpérationResponse appropriée pour la combinaison OperationSpec et HttpOperationResponse donnée. Si ce n’est pas défini, une recherche de code d’état simple est utilisée.
operationSpec

Spécification de la requête HTTP.
proxySettings

Le proxy à utiliser, si nécessaire.
query

Requête ajoutée à l’URL.
requestId

Identificateur unique de la requête sortante.
shouldDeserialize

Indique si httpOperationResponse doit être désérialisé ou non. Si ce n’est pas défini, httpOperationResponse doit être désérialisé.
spanOptions

Suivi : options utilisées pour créer une étendue lorsque le traçage est activé.
streamResponseBody

Indique si le corps de l’objet HttpOperationResponse doit ou non être traité comme un flux.
streamResponseStatusCodes

Liste des codes d’état dont le corps HttpOperationResponse correspondant doit être traité comme un flux.
timeout

Délai d’attente en millisecondes avant l’abandon de la demande.
tracingContext

Traçage : contexte utilisé lors de la création d’étendues.
url

URL de la requête sortante.
withCredentials

Indique s’il faut envoyer des informations d’identification (via des cookies, des en-têtes d’autorisation ou des certificats clients TLS) lors de l’envoi d’une requête dans le navigateur à une destination intersites.

Méthodes

clone()

Clonez cet objet de requête HTTP WebResource.
prepare(RequestPrepareOptions)

Prépare la demande.
validateRequestProperties()

Vérifie que les propriétés requises telles que method, url, headers["Content-Type"], headers["accept-language"] sont définies. Une erreur est générée si l’une des propriétés mentionnées ci-dessus n’est pas définie.

Détails du constructeur

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

Paramètres

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>

Détails de la propriété

abortSignal

Signal d’un contrôleur d’abandon. Peut être utilisé pour abandonner à la fois l’envoi d’une demande réseau et l’attente d’une réponse.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

body

Corps de la demande.

body?: any

Valeur de propriété

any

decompressResponse

Indique s’il faut décompresser la réponse en fonction de Accept-Encoding en-tête (node-fetch uniquement)

decompressResponse?: boolean

Valeur de propriété

boolean

formData

Données de formulaire, utilisées pour générer le corps de la demande.

formData?: any

Valeur de propriété

any

headers

En-têtes HTTP.

headers: HttpHeadersLike

Valeur de propriété

HttpHeadersLike

keepAlive

Indique s’il faut maintenir les connexions HTTP actives tout au long des requêtes.

keepAlive?: boolean

Valeur de propriété

boolean

method

Méthode HTTP à utiliser.

method: HttpMethods

Valeur de propriété

HttpMethods

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

operationResponseGetter

Fonction qui retourne l’OpérationResponse appropriée pour la combinaison OperationSpec et HttpOperationResponse donnée. Si ce n’est pas défini, une recherche de code d’état simple est utilisée.

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

Valeur de propriété

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

operationSpec

Spécification de la requête HTTP.

operationSpec?: OperationSpec

Valeur de propriété

OperationSpec

proxySettings

Le proxy à utiliser, si nécessaire.

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

query

Requête ajoutée à l’URL.

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

Valeur de propriété

{[key: string]: any}

requestId

Identificateur unique de la requête sortante.

requestId: string

Valeur de propriété

string

shouldDeserialize

Indique si httpOperationResponse doit être désérialisé ou non. Si ce n’est pas défini, httpOperationResponse doit être désérialisé.

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

Valeur de propriété

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Suivi : options utilisées pour créer une étendue lorsque le traçage est activé.

spanOptions?: SpanOptions

Valeur de propriété

@azure/core-tracing.SpanOptions

streamResponseBody

Avertissement

Cette API est à présent déconseillée.

Use streamResponseStatusCodes property instead.

Indique si le corps de l’objet HttpOperationResponse doit ou non être traité comme un flux.

streamResponseBody?: boolean

Valeur de propriété

boolean

streamResponseStatusCodes

Liste des codes d’état dont le corps HttpOperationResponse correspondant doit être traité comme un flux.

streamResponseStatusCodes?: Set<number>

Valeur de propriété

Set<number>

timeout

Délai d’attente en millisecondes avant l’abandon de la demande.

timeout: number

Valeur de propriété

number

tracingContext

Traçage : contexte utilisé lors de la création d’étendues.

tracingContext?: Context

Valeur de propriété

@azure/core-tracing.Context

url

URL de la requête sortante.

url: string

Valeur de propriété

string

withCredentials

Indique s’il faut envoyer des informations d’identification (via des cookies, des en-têtes d’autorisation ou des certificats clients TLS) lors de l’envoi d’une requête dans le navigateur à une destination intersites.

withCredentials: boolean

Valeur de propriété

boolean

Détails de la méthode

clone()

Clonez cet objet de requête HTTP WebResource.

function clone(): WebResource

Retours

WebResource

Clone de cet objet de requête HTTP WebResource.

prepare(RequestPrepareOptions)

Prépare la demande.

function prepare(options: RequestPrepareOptions): WebResource

Paramètres

options
RequestPrepareOptions

Options à fournir pour la préparation de la demande.

Retours

WebResource

Retourne l’objet WebResource (requête HTTP) préparé qui doit être donné au pipeline de requête.

validateRequestProperties()

Vérifie que les propriétés requises telles que method, url, headers["Content-Type"], headers["accept-language"] sont définies. Une erreur est générée si l’une des propriétés mentionnées ci-dessus n’est pas définie.

function validateRequestProperties()