Partager via

ServiceClientOptions interface

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 requêtes seront effectuées pour ce ServiceClient. S’il n’est pas spécifié, 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é, sera utilisé pour générer bearerTokenAuthenticationPolicy.
endpoint

S’il est spécifié, il s’agit du point de terminaison sur lequel les requêtes seront effectuées pour ce ServiceClient. S’il n’est pas spécifié, toutes les operationSpecs doivent contenir une propriété baseUrl. pour encourager le client à utiliser le point de terminaison, nous marqueons le baseUri comme déconseillé.
pipeline

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

Type de contenu de requête 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.
agent

Options de configuration de l’instance de l’agent pour les demandes sortantes
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 de configuration d’un proxy pour les demandes 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 informations de télémétrie et de suivi courantes sur les requêtes sortantes.
tlsOptions

Options de configuration de l’authentification TLS
userAgentOptions

Options d’ajout de détails de l’agent utilisateur aux demandes 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 requêtes seront effectuées pour ce ServiceClient. S’il n’est pas spécifié, 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é, sera 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 requêtes seront effectuées pour ce ServiceClient. S’il n’est pas spécifié, toutes les operationSpecs doivent contenir une propriété baseUrl. pour encourager le client à utiliser le point de terminaison, nous marqueons le baseUri comme déconseillé.

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 requête 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ée deCommonClientOptions.additionalPolicies

agent

Options de configuration de l’instance de l’agent pour les demandes sortantes

agent?: Agent

Valeur de propriété

Agent

héritée deCommonClientOptions.agent

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ée deCommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Valeur de propriété

HttpClient

héritée deCommonClientOptions.httpClient

proxyOptions

Options de configuration d’un proxy pour les demandes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

héritée deCommonClientOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

héritée 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ée deCommonClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valeur de propriété

TelemetryOptions

héritée deCommonClientOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

héritée deCommonClientOptions.tlsOptions

userAgentOptions

Options d’ajout de détails de l’agent utilisateur aux demandes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

héritée deCommonClientOptions.userAgentOptions