Partager via

ServiceClientOptions interface

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

Options à fournir lors de la création du client.

Propriétés

agentSettings

Agents HTTP et HTTPS qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
baseUri

S’il est spécifié :

  • Il s’agit baseUri de l’URI de base sur lequel les demandes seront effectuées pour ce ServiceClient.
  • Si correspond à baseUri un point de terminaison resource manager connu et si un TokenCredential a été passé par le constructeur, cela baseUri définit l’étendue getToken comme étant ${options.baseUri}/.default. Sinon, l’étendue est définie par défaut sur « https://management.azure.com/.default".

Si elle n’est pas spécifiée :

  • Toutes les OperationSpecs doivent contenir une propriété baseUrl.
  • Si un TokenCredential a été passé par le constructeur, l’étendue getToken est définie sur « https://management.azure.com/.default".
clientRequestIdHeaderName

Si elle est spécifiée, une instruction GenerateRequestIdPolicy est ajoutée au pipeline HTTP qui ajoute 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.
deserializationContentTypes

Types de contenu qui seront associés à la sérialisation JSON ou XML.
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).
redirectOptions

Options de gestion des réponses de redirection.
requestPolicyFactories

Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le réseau, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne le requestPolicyFactories qui sera utilisé.
rpRegistrationRetryTimeout

Obtient ou définit le délai d’expiration de nouvelle tentative 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 demande, ou une fonction qui accepte la chaîne user-agent 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 » est utilisé lors de l’exécution sur Node.js et « x-ms-command-name » est utilisé lors de l’exécution dans un navigateur.
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é

agentSettings

Agents HTTP et HTTPS qui seront utilisés pour chaque requête HTTP (Node.js uniquement).

agentSettings?: AgentSettings

Valeur de propriété

AgentSettings

baseUri

S’il est spécifié :

  • Il s’agit baseUri de l’URI de base sur lequel les demandes seront effectuées pour ce ServiceClient.
  • Si correspond à baseUri un point de terminaison resource manager connu et si un TokenCredential a été passé par le constructeur, cela baseUri définit l’étendue getToken comme étant ${options.baseUri}/.default. Sinon, l’étendue est définie par défaut sur « https://management.azure.com/.default".

Si elle n’est pas spécifiée :

  • Toutes les OperationSpecs doivent contenir une propriété baseUrl.
  • Si un TokenCredential a été passé par le constructeur, l’étendue getToken est définie sur « https://management.azure.com/.default".
baseUri?: string

Valeur de propriété

string

clientRequestIdHeaderName

Si elle est spécifiée, une instruction GenerateRequestIdPolicy est ajoutée au pipeline HTTP qui ajoute 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

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Valeur de propriété

DeserializationContentTypes

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

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectOptions

Valeur de propriété

RedirectOptions

requestPolicyFactories

Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le réseau, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne le requestPolicyFactories qui sera utilisé.

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 de nouvelle tentative 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 demande, ou une fonction qui accepte la chaîne user-agent 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 » est utilisé lors de l’exécution sur Node.js et « x-ms-command-name » est utilisé lors de l’exécution dans un navigateur.

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

Valeur de propriété

string | (defaultUserAgentHeaderName: string) => 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