ServiceClientOptions interface

  • Référence
Paquet:
@azure/core-client

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

Extends
CommonClientOptions

Propriétés

baseUri

S’il est spécifié, il s’agit de l’URI de base sur lequel les demandes seront effectuées pour ce ServiceClient. Si elle n’est pas spécifiée, toutes les OperationSpecs doivent contenir une propriété baseUrl.
credential

Informations d’identification utilisées pour authentifier la demande.
credentialScopes

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

S’il est spécifié, il s’agit du point de terminaison sur lequel les demandes seront effectuées pour ce ServiceClient. Si elle n’est pas spécifiée, toutes les OperationSpecs doivent contenir une propriété baseUrl. pour encourager le client à utiliser le point de terminaison, nous marquons le baseUri comme déprécié.
pipeline

Un pipeline personnalisé à utiliser, sinon un pipeline par défaut est créé.
requestContentType

Type de contenu de demande par défaut pour le service. Utilisé si aucun requestContentType n’est présent sur un OperationSpec.

Propriétés héritées

additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.
allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS
httpClient

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

Options permettant de configurer un proxy pour les requêtes sortantes.
redirectOptions

Options de gestion des réponses de redirection.
retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.
telemetryOptions

Options permettant de définir les données de télémétrie et de suivi courantes sur les requêtes sortantes.
tlsOptions

Options de configuration de l’authentification TLS
userAgentOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

Détails de la propriété

baseUri

Avertissement

Cette API est à présent déconseillée.

This property is deprecated and will be removed soon, please use endpoint instead

S’il est spécifié, il s’agit de l’URI de base sur lequel les demandes seront effectuées pour ce ServiceClient. Si elle n’est pas spécifiée, toutes les OperationSpecs doivent contenir une propriété baseUrl.

baseUri?: string

Valeur de propriété

string

credential

Informations d’identification utilisées pour authentifier la demande.

credential?: TokenCredential

Valeur de propriété

TokenCredential

credentialScopes

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

credentialScopes?: string | string[]

Valeur de propriété

string | string[]

endpoint

S’il est spécifié, il s’agit du point de terminaison sur lequel les demandes seront effectuées pour ce ServiceClient. Si elle n’est pas spécifiée, toutes les OperationSpecs doivent contenir une propriété baseUrl. pour encourager le client à utiliser le point de terminaison, nous marquons le baseUri comme déprécié.

endpoint?: string

Valeur de propriété

string

pipeline

Un pipeline personnalisé à utiliser, sinon un pipeline par défaut est créé.

pipeline?: Pipeline

Valeur de propriété

Pipeline

requestContentType

Type de contenu de demande par défaut pour le service. Utilisé si aucun requestContentType n’est présent sur un OperationSpec.

requestContentType?: string

Valeur de propriété

string

Détails de la propriété héritée

additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

AdditionalPolicyConfig[]

Hérité deCommonClientOptions.additionalPolicies

allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS

allowInsecureConnection?: boolean

Valeur de propriété

boolean

Hérité deCommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Valeur de propriété

HttpClient

Hérité deCommonClientOptions.httpClient

proxyOptions

Options permettant de configurer un proxy pour les requêtes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

Hérité deCommonClientOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

Hérité deCommonClientOptions.redirectOptions

retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.

retryOptions?: PipelineRetryOptions

Valeur de propriété

PipelineRetryOptions

Hérité deCommonClientOptions.retryOptions

telemetryOptions

Options permettant de définir les données de télémétrie et de suivi courantes sur les requêtes sortantes.

telemetryOptions?: TelemetryOptions

Valeur de propriété

TelemetryOptions

Hérité deCommonClientOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

Hérité deCommonClientOptions.tlsOptions

userAgentOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

Hérité deCommonClientOptions.userAgentOptions