Partager via

ServiceClientOptions interface

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

Si spécifié :

  • Cette baseUri devient l’URI de base sur lequel les requêtes seront effectuées pour ce ServiceClient.
  • Si le baseUri correspond à un point de terminaison Resource Manager connu et si un TokenCredential a été passé par le constructeur, cette baseUri définit l’étendue getToken à ${options.baseUri}/.default. Sinon, l’étendue est définie par défaut sur «https://management.azure.com/.default".

S’il n’est pas spécifié :

  • 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 spécifié, un GenerateRequestIdPolicy est ajouté 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 demande 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 qui sont appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le câble, ou une fonction qui prend dans defaultRequestPolicyFactories et retourne les requestPolicyFactories qui seront utilisées.
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 requête ou d’une fonction qui prend la chaîne de l’agent utilisateur par défaut et retourne la chaîne de l’agent utilisateur 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 requête. S’il 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 requêtes CORS dans le navigateur. Pour plus d’informations, consultez https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

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

Si spécifié :

  • Cette baseUri devient l’URI de base sur lequel les requêtes seront effectuées pour ce ServiceClient.
  • Si le baseUri correspond à un point de terminaison Resource Manager connu et si un TokenCredential a été passé par le constructeur, cette baseUri définit l’étendue getToken à ${options.baseUri}/.default. Sinon, l’étendue est définie par défaut sur «https://management.azure.com/.default".

S’il n’est pas spécifié :

  • 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 spécifié, un GenerateRequestIdPolicy est ajouté 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 demande 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 qui sont appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le câble, ou une fonction qui prend dans 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 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 requête ou d’une fonction qui prend la chaîne de l’agent utilisateur par défaut et retourne la chaîne de l’agent utilisateur 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 requête. S’il 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 requêtes CORS dans le navigateur. Pour plus d’informations, consultez https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Valeur de propriété

boolean