RequestPrepareOptions interface

Paquet:

@azure/core-http

Options pour préparer une requête HTTP sortante.

Propriétés

abortSignal	Signal d’un contrôleur d’abandon. Peut être utilisé pour abandonner l’envoi d’une requête réseau et l’attente d’une réponse.
baseUrl	URL de base de la demande. La valeur par défaut est : « https://management.azure.com". Cela s’applique uniquement avec pathTemplate. Si vous fournissez options.url, vous devez fournir l’URL complète.
body	Corps de la demande. Il peut être de n’importe quel type. Cette valeur sera sérialisée s’il ne s’agit pas d’un flux.
bodyIsStream	Indique si le corps de la requête est un flux (utile pour les scénarios de chargement de fichiers).
deserializationMapper	Fournit des informations sur la désérialisation du corps de la réponse.
disableClientRequestId	Lorsque la valeur est true, indique au client de ne pas définir l’en-tête « x-ms-client-request-id » sur un nouveau GUID().
disableJsonStringifyOnBody	Indique si cette méthode doit JSON.stringify() le corps de la requête. Valeur par défaut : false.
formData	Données de formulaire, utilisées pour générer le corps de la requête.
headers	Dictionnaire d’en-têtes de requête qui doivent être appliqués à la demande. Ici, la clé est « header-name » et la valeur est « header-value ». La valeur d’en-tête DOIT être de type chaîne. ContentType doit être fourni avec le nom de clé « Content-Type ». Valeur par défaut « application/json ; charset=utf-8 ». « Transfer-Encoding » est défini sur « segmented » par défaut si « options.bodyIsStream » a la valeur true. « Content-Type » est défini sur « application/octet-stream » par défaut si « options.bodyIsStream » a la valeur true. « accept-language » par défaut est défini sur « en-US » « x-ms-client-request-id » par défaut est défini sur un nouveau GUID. Pour ne pas générer de guid pour la demande, définissez options.disableClientRequestId sur true
mappers	Dictionnaire des mappeurs qui peuvent être utilisés lors de la [dé]sérialisation.
method	Méthode de requête HTTP. Les valeurs valides sont « GET », « PUT », « HEAD », « DELETE », « OPTIONS », « POST » ou « PATCH ».
onDownloadProgress	Permet de suivre la progression du téléchargement de la réponse entrante.
onUploadProgress	Permet de suivre la progression du chargement de la demande sortante.
pathParameters	Dictionnaire des paramètres de chemin d’accès qui doivent être remplacés par des valeurs réelles dans le pathTemplate. Ici, la clé est « path-parameter-name » et la valeur est « path-parameter-value ». Le « path-parameter-value » peut être de type « string » ou il peut être de type « object ». Le format « objet » doit être utilisé lorsque vous souhaitez ignorer l’encodage d’URL. Lors de l’utilisation du format d’objet, l’objet doit avoir une propriété nommée value qui fournit la valeur « path-parameter-value ». Exemple : path-parameter-value au format « objet » : { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } } path-parameter-value au format « string » : { "path-parameter-name": "path-parameter-value" }.
pathTemplate	Modèle de chemin d’accès de l’URL de requête. Fournissez l’url ou fournissez le « pathTemplate » dans l’objet options. Les deux options s’excluent mutuellement. Exemple : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters	Dictionnaire de paramètres de requête à ajouter à l’URL, où « key » est « query-parameter-name » et « value » est « query-parameter-value ». La valeur « query-parameter-value » peut être de type « string » ou de type « object ». Le format « objet » doit être utilisé lorsque vous souhaitez ignorer l’encodage d’URL. Lors de l’utilisation du format d’objet, l’objet doit avoir une propriété nommée value qui fournit la valeur « query-parameter-value ». Exemple : query-parameter-value au format « objet » : { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } } query-parameter-value au format « string » : { "query-parameter-name": "query-parameter-value"}. Remarque : « Si options.url a déjà des paramètres de requête, la valeur fournie dans options.queryParameters est ajoutée à l’URL.
serializationMapper	Fournit des informations sur la sérialisation du corps de la demande.
spanOptions	Suivi : options utilisées pour créer une étendue lorsque le suivi est activé.
tracingContext	Suivi : contexte utilisé lors de la création d’étendues.
url	URL de la demande. Il peut contenir ou non des paramètres de requête. Fournissez l’url ou fournissez le « pathTemplate » dans l’objet options. Les deux options s’excluent mutuellement.

Détails de la propriété

abortSignal

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

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

baseUrl

URL de base de la demande. La valeur par défaut est : « https://management.azure.com". Cela s’applique uniquement avec pathTemplate. Si vous fournissez options.url, vous devez fournir l’URL complète.

baseUrl?: string

Valeur de propriété

string

body

Corps de la demande. Il peut être de n’importe quel type. Cette valeur sera sérialisée s’il ne s’agit pas d’un flux.

body?: any

Valeur de propriété

any

bodyIsStream

Indique si le corps de la requête est un flux (utile pour les scénarios de chargement de fichiers).

bodyIsStream?: boolean

Valeur de propriété

boolean

deserializationMapper

Fournit des informations sur la désérialisation du corps de la réponse.

deserializationMapper?: Record<string, unknown>

Valeur de propriété

Record<string, unknown>

disableClientRequestId

Lorsque la valeur est true, indique au client de ne pas définir l’en-tête « x-ms-client-request-id » sur un nouveau GUID().

disableClientRequestId?: boolean

Valeur de propriété

boolean

disableJsonStringifyOnBody

Indique si cette méthode doit JSON.stringify() le corps de la requête. Valeur par défaut : false.

disableJsonStringifyOnBody?: boolean

Valeur de propriété

boolean

formData

Données de formulaire, utilisées pour générer le corps de la requête.

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

Valeur de propriété

{[key: string]: any}

headers

Dictionnaire d’en-têtes de requête qui doivent être appliqués à la demande. Ici, la clé est « header-name » et la valeur est « header-value ». La valeur d’en-tête DOIT être de type chaîne.

• ContentType doit être fourni avec le nom de clé « Content-Type ». Valeur par défaut « application/json ; charset=utf-8 ».
• « Transfer-Encoding » est défini sur « segmented » par défaut si « options.bodyIsStream » a la valeur true.
• « Content-Type » est défini sur « application/octet-stream » par défaut si « options.bodyIsStream » a la valeur true.
• « accept-language » par défaut est défini sur « en-US »
• « x-ms-client-request-id » par défaut est défini sur un nouveau GUID. Pour ne pas générer de guid pour la demande, définissez options.disableClientRequestId sur true

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

Valeur de propriété

{[key: string]: any}

mappers

Dictionnaire des mappeurs qui peuvent être utilisés lors de la [dé]sérialisation.

mappers?: {[x: string]: any}

Valeur de propriété

{[x: string]: any}

method

Méthode de requête HTTP. Les valeurs valides sont « GET », « PUT », « HEAD », « DELETE », « OPTIONS », « POST » ou « PATCH ».

method: HttpMethods

Valeur de propriété

HttpMethods

onDownloadProgress

Permet de suivre la progression du téléchargement de la réponse entrante.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

onUploadProgress

Permet de suivre la progression du chargement de la demande sortante.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

pathParameters

Dictionnaire des paramètres de chemin d’accès qui doivent être remplacés par des valeurs réelles dans le pathTemplate. Ici, la clé est « path-parameter-name » et la valeur est « path-parameter-value ». Le « path-parameter-value » peut être de type « string » ou il peut être de type « object ». Le format « objet » doit être utilisé lorsque vous souhaitez ignorer l’encodage d’URL. Lors de l’utilisation du format d’objet, l’objet doit avoir une propriété nommée value qui fournit la valeur « path-parameter-value ». Exemple :

• path-parameter-value au format « objet » : { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
• path-parameter-value au format « string » : { "path-parameter-name": "path-parameter-value" }.

pathParameters?: {[key: string]: any | ParameterValue}

Valeur de propriété

{[key: string]: any | ParameterValue}

pathTemplate

Modèle de chemin d’accès de l’URL de requête. Fournissez l’url ou fournissez le « pathTemplate » dans l’objet options. Les deux options s’excluent mutuellement. Exemple : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

Valeur de propriété

string

queryParameters

Dictionnaire de paramètres de requête à ajouter à l’URL, où « key » est « query-parameter-name » et « value » est « query-parameter-value ». La valeur « query-parameter-value » peut être de type « string » ou de type « object ». Le format « objet » doit être utilisé lorsque vous souhaitez ignorer l’encodage d’URL. Lors de l’utilisation du format d’objet, l’objet doit avoir une propriété nommée value qui fournit la valeur « query-parameter-value ». Exemple :

• query-parameter-value au format « objet » : { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
• query-parameter-value au format « string » : { "query-parameter-name": "query-parameter-value"}. Remarque : « Si options.url a déjà des paramètres de requête, la valeur fournie dans options.queryParameters est ajoutée à l’URL.

queryParameters?: {[key: string]: any | ParameterValue}

Valeur de propriété

{[key: string]: any | ParameterValue}

serializationMapper

Fournit des informations sur la sérialisation du corps de la demande.

serializationMapper?: Mapper

Valeur de propriété

Mapper

spanOptions

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

spanOptions?: SpanOptions

Valeur de propriété

@azure/core-tracing.SpanOptions

tracingContext

Suivi : contexte utilisé lors de la création d’étendues.

tracingContext?: Context

Valeur de propriété

@azure/core-tracing.Context

url

URL de la demande. Il peut contenir ou non des paramètres de requête. Fournissez l’url ou fournissez le « pathTemplate » dans l’objet options. Les deux options s’excluent mutuellement.

url?: string

Valeur de propriété

string