TokenApiClientOptions interface
- Extends
-
ServiceClientOptions
Propriétés
base |
Propriétés héritées
agent |
Agents HTTP et HTTPS qui seront utilisés pour chaque requête HTTP (Node.js uniquement). |
client |
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. |
deserialization |
Types de contenu qui seront associés à la sérialisation JSON ou XML. |
generate |
Indique s’il faut ou non générer un en-tête d’ID de demande client pour chaque requête HTTP. |
http |
HttpClient qui sera utilisé pour envoyer des requêtes HTTP. |
http |
HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP. |
no |
Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut. |
proxy |
Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement). |
redirect |
Options de gestion des réponses de redirection. |
request |
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. |
rp |
Obtient ou définit le délai d’expiration de nouvelle tentative en secondes pour AutomaticRPRegistration. La valeur par défaut est 30. |
user |
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. |
user |
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. |
with |
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é
baseUri
baseUri?: string
Valeur de propriété
string
Détails de la propriété héritée
agentSettings
Agents HTTP et HTTPS qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
agentSettings?: AgentSettings
Valeur de propriété
AgentSettings
héritée de ServiceClientOptions.agentSettings
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
héritée de ServiceClientOptions.clientRequestIdHeaderName
deserializationContentTypes
Types de contenu qui seront associés à la sérialisation JSON ou XML.
deserializationContentTypes?: DeserializationContentTypes
Valeur de propriété
DeserializationContentTypes
héritée de ServiceClientOptions.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
héritée de ServiceClientOptions.generateClientRequestIdHeader
httpClient
HttpClient qui sera utilisé pour envoyer des requêtes HTTP.
httpClient?: HttpClient
Valeur de propriété
HttpClient
héritée de ServiceClientOptions.httpClient
httpPipelineLogger
HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.
httpPipelineLogger?: HttpPipelineLogger
Valeur de propriété
HttpPipelineLogger
héritée de ServiceClientOptions.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
héritée de ServiceClientOptions.noRetryPolicy
proxySettings
Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
proxySettings?: ProxySettings
Valeur de propriété
ProxySettings
héritée de ServiceClientOptions.proxySettings
redirectOptions
Options de gestion des réponses de redirection.
redirectOptions?: RedirectOptions
Valeur de propriété
RedirectOptions
héritée de ServiceClientOptions.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[]
héritée de ServiceClientOptions.requestPolicyFactories
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
héritée de ServiceClientOptions.rpRegistrationRetryTimeout
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
héritée de ServiceClientOptions.userAgent
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
héritée de ServiceClientOptions.userAgentHeaderName
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
héritée de ServiceClientOptions.withCredentials