Partager via

RequestPrepareOptions interface

  • Référence
Paquet:
@azure/ms-rest-js

Propriétés

abortSignal
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
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
onUploadProgress
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 « object » : { « 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 « object » : { « 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.
redirectLimit

Limitez le nombre de redirections suivies pour cette demande. Si la valeur est 0, les redirections ne sont pas suivies. S’il n’est pas défini, le comportement de redirection par défaut du node_fetch sous-jacent s’applique.
serializationMapper

Fournit des informations sur la sérialisation du corps de la demande.
streamResponseBody
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 

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?: object

Valeur de propriété

object

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 

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 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

onUploadProgress 

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 « object » : { « 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 « object » : { « 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}

redirectLimit

Limitez le nombre de redirections suivies pour cette demande. Si la valeur est 0, les redirections ne sont pas suivies. S’il n’est pas défini, le comportement de redirection par défaut du node_fetch sous-jacent s’applique.

redirectLimit?: number

Valeur de propriété

number

serializationMapper

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

serializationMapper?: Mapper

Valeur de propriété

Mapper

streamResponseBody 

streamResponseBody?: boolean

Valeur de propriété

boolean

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