RequestPrepareOptions interface

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é

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

baseUrl?: string

Valeur de propriété

Corps de la requête. Il peut s’agir de n’importe quel type. Cette valeur est sérialisée si ce n’est pas un flux.

body?: any

Valeur de propriété

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

bodyIsStream?: boolean

Valeur de propriété

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

deserializationMapper?: Record<string, unknown>

Valeur de propriété

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é

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é

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

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

Valeur de propriété

Dictionnaire d’en-têtes de requête qui doivent être appliqués à la requête. 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 « segmenté » 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»
• Par défaut, « x-ms-client-request-id » est défini sur un nouveau GUID. Pour ne pas générer de guid pour la requête, définissez options.disableClientRequestId sur true

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

Valeur de propriété

Dictionnaire de mappeurs qui peuvent être utilisés pendant la sérialisation [de]sérialisation.

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

Valeur de propriété

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

method: HttpMethods

Valeur de propriété

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

Permet de suivre la progression du chargement de la requête sortante.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

Dictionnaire des paramètres de chemin 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 ». La « path-parameter-value » peut être de type « string » ou elle 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 valeur nommée propriété qui fournit la « 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é

Modèle de chemin d’accès de l’URL de requête. Fournissez l’url ou indiquez « 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é

Dictionnaire des paramètres de requête à ajouter à l’URL, où « key » est le « query-parameter-name » et « value » est la valeur « query-parameter-value ». La « valeur-paramètre-requête » peut être de type « string » ou elle 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 valeur nommée propriété 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 possède déjà certains 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é

Fournit des informations sur la sérialisation du corps de la requête.

serializationMapper?: Mapper

Valeur de propriété

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

spanOptions?: SpanOptions

Valeur de propriété

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

tracingContext?: Context

Valeur de propriété

URL de la demande. Il peut ou non avoir des paramètres de requête dans celui-ci. Fournissez l’url ou indiquez « pathTemplate » dans l’objet options. Les deux options s’excluent mutuellement.

url?: string

Valeur de propriété