StorageClientOptionalParams interface

Paquet:

@azure/storage-blob

Paramètres facultatifs.

Extends

ServiceClientOptions

Propriétés

clientRequestIdHeaderName	S’il est spécifié, un GenerateRequestIdPolicy sera ajouté au pipeline HTTP qui ajoutera un en-tête à toutes les requêtes sortantes avec ce nom d’en-tête et un UUID aléatoire comme ID de requête.
credentialScopes	S’il est spécifié, sera utilisé pour générer bearerTokenAuthenticationPolicy.
deserializationContentTypes	Types de contenu qui seront associés à la sérialisation JSON ou XML.
endpoint	Remplace le point de terminaison client.
generateClientRequestIdHeader	Indique s’il faut ou non générer un en-tête d’ID de requête client pour chaque requête HTTP.
httpClient	HttpClient qui sera utilisé pour envoyer des requêtes HTTP.
httpPipelineLogger	HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.
noRetryPolicy	Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut.
proxySettings	Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
requestPolicyFactories	Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le câble, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne les requestPolicyFactories qui seront utilisées.
rpRegistrationRetryTimeout	Obtient ou définit le délai d’expiration des nouvelles tentatives en secondes pour AutomaticRPRegistration. La valeur par défaut est 30.
userAgent	Chaîne à définir sur l’en-tête de télémétrie lors de l’envoi de la requête, ou une fonction qui accepte la chaîne d’agent utilisateur par défaut et retourne la chaîne user-agent qui sera utilisée.
userAgentHeaderName	Nom d’en-tête à utiliser pour l’en-tête de télémétrie lors de l’envoi de la demande. Si ce n’est pas spécifié, « User-Agent » sera utilisé lors de l’exécution sur Node.js et « x-ms-useragent » sera utilisé lors de l’exécution dans un navigateur.
version	Spécifie la version de l'opération à utiliser pour cette demande.
withCredentials	Indique s’il faut inclure des informations d’identification dans les demandes CORS dans le navigateur. Consultez la rubrique https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials (éventuellement en anglais) pour plus d'informations.

Détails de la propriété

clientRequestIdHeaderName

S’il est spécifié, un GenerateRequestIdPolicy sera ajouté au pipeline HTTP qui ajoutera un en-tête à toutes les requêtes sortantes avec ce nom d’en-tête et un UUID aléatoire comme ID de requête.

clientRequestIdHeaderName?: string

Valeur de propriété

string

credentialScopes

S’il est spécifié, sera utilisé pour générer bearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Valeur de propriété

string | string[]

deserializationContentTypes

Types de contenu qui seront associés à la sérialisation JSON ou XML.

deserializationContentTypes?: DeserializationContentTypes

Valeur de propriété

DeserializationContentTypes

endpoint

Remplace le point de terminaison client.

endpoint?: string

Valeur de propriété

string

generateClientRequestIdHeader

Indique s’il faut ou non générer un en-tête d’ID de requête client pour chaque requête HTTP.

generateClientRequestIdHeader?: boolean

Valeur de propriété

boolean

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

httpClient?: HttpClient

Valeur de propriété

HttpClient

httpPipelineLogger

HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valeur de propriété

HttpPipelineLogger

noRetryPolicy

Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut.

noRetryPolicy?: boolean

Valeur de propriété

boolean

proxySettings

Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

requestPolicyFactories

Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le câble, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne les requestPolicyFactories qui seront utilisées.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Valeur de propriété

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

rpRegistrationRetryTimeout

Obtient ou définit le délai d’expiration des nouvelles tentatives en secondes pour AutomaticRPRegistration. La valeur par défaut est 30.

rpRegistrationRetryTimeout?: number

Valeur de propriété

number

userAgent

Chaîne à définir sur l’en-tête de télémétrie lors de l’envoi de la requête, ou une fonction qui accepte la chaîne d’agent utilisateur par défaut et retourne la chaîne user-agent qui sera utilisée.

userAgent?: string | (defaultUserAgent: string) => string

Valeur de propriété

string | (defaultUserAgent: string) => string

userAgentHeaderName

Nom d’en-tête à utiliser pour l’en-tête de télémétrie lors de l’envoi de la demande. Si ce n’est pas spécifié, « User-Agent » sera utilisé lors de l’exécution sur Node.js et « x-ms-useragent » sera utilisé lors de l’exécution dans un navigateur.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

Valeur de propriété

string | (defaultUserAgentHeaderName: string) => string

version

Spécifie la version de l'opération à utiliser pour cette demande.

version?: string

Valeur de propriété

string

withCredentials

Indique s’il faut inclure des informations d’identification dans les demandes CORS dans le navigateur. Consultez la rubrique https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials (éventuellement en anglais) pour plus d'informations.

withCredentials?: boolean

Valeur de propriété

boolean