Partager via

PipelineRequestOptions interface

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

Paramètres permettant d’initialiser une demande. Presque équivalent à Partial, mais url est obligatoire.

Propriétés

abortSignal

Utilisé pour abandonner la demande ultérieurement.
allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS
body

Contenu du corps HTTP (le cas échéant)
disableKeepAlive

Si la connexion ne doit pas être réutilisée.
enableBrowserStreams

NAVIGATEUR UNIQUEMENT

Option de navigateur uniquement pour activer l’utilisation de l’API Streams. Si cette option est définie et que la diffusion en continu est utilisée (voir streamResponseStatusCodes), la réponse aura une propriété browserStream au lieu de blobBody laquelle n’est pas définie.

La valeur par défaut est false
formData

Pour simuler un billet de formulaire de navigateur
headers

En-têtes HTTP à utiliser lors de la requête.
method

Méthode HTTP à utiliser lors de la requête.
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.
proxySettings

Configuration du proxy.
requestId

Identificateur unique de la requête. Utilisé pour la journalisation et le suivi.
streamResponseStatusCodes

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

Nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement. Si la demande est terminée, une AbortError est levée. La valeur par défaut est 0, ce qui désactive le délai d’expiration.
tracingOptions

Options utilisées pour créer une étendue lorsque le suivi est activé.
url

URL de requête.
withCredentials

Si des informations d’identification (cookies) doivent être envoyées pendant un XHR. La valeur par défaut est false.

Détails de la propriété

abortSignal

Utilisé pour abandonner la demande ultérieurement.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS

allowInsecureConnection?: boolean

Valeur de propriété

boolean

body

Contenu du corps HTTP (le cas échéant)

body?: RequestBodyType

Valeur de propriété

RequestBodyType

disableKeepAlive

Si la connexion ne doit pas être réutilisée.

disableKeepAlive?: boolean

Valeur de propriété

boolean

enableBrowserStreams

NAVIGATEUR UNIQUEMENT

Option de navigateur uniquement pour activer l’utilisation de l’API Streams. Si cette option est définie et que la diffusion en continu est utilisée (voir streamResponseStatusCodes), la réponse aura une propriété browserStream au lieu de blobBody laquelle n’est pas définie.

La valeur par défaut est false

enableBrowserStreams?: boolean

Valeur de propriété

boolean

formData

Pour simuler un billet de formulaire de navigateur

formData?: FormDataMap

Valeur de propriété

FormDataMap

headers

En-têtes HTTP à utiliser lors de la requête.

headers?: HttpHeaders

Valeur de propriété

HttpHeaders

method

Méthode HTTP à utiliser lors de la requête.

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

proxySettings

Configuration du proxy.

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

requestId

Identificateur unique de la requête. Utilisé pour la journalisation et le suivi.

requestId?: string

Valeur de propriété

string

streamResponseStatusCodes

Liste des codes d’état de réponse dont le corps PipelineResponse correspondant doit être traité comme un flux.

streamResponseStatusCodes?: Set<number>

Valeur de propriété

Set<number>

timeout

Nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement. Si la demande est terminée, une AbortError est levée. La valeur par défaut est 0, ce qui désactive le délai d’expiration.

timeout?: number

Valeur de propriété

number

tracingOptions

Options utilisées pour créer une étendue lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

url

URL de requête.

url: string

Valeur de propriété

string

withCredentials

Si des informations d’identification (cookies) doivent être envoyées pendant un XHR. La valeur par défaut est false.

withCredentials?: boolean

Valeur de propriété

boolean