CosmosClientOptions interface

Paquet:

@azure/cosmos

Propriétés

aadCredentials	Jeton AAD de @azure/identity Obtenir un objet d’informations d’identification en créant un objet d’informations d’identification @azure/identity Nous allons ensuite utiliser votre objet d’informations d’identification et une URL d’étendue (votre point de terminaison Cosmos db) pour authentifier les demandes auprès de Cosmos
agent	Agent http(s) personnalisé facultatif à utiliser dans les environnements NodeJS Utilisez un agent, par exemple https://github.com/TooTallNate/node-proxy-agent si vous devez vous connecter à Cosmos via un proxy
clientEncryptionOptions	La stratégie de chiffrement pour les opérations impliquant le chiffrement doit être définie sur le client si le chiffrement côté client est utilisé Voir ClientEncryptionOptions
connectionPolicy	Instance de classe ConnectionPolicy. Ce paramètre est facultatif et la stratégie de connexion par défaut est utilisée s’il est omis.
connectionString	Paramètre facultatif qui représente la chaîne de connexion. La chaîne de connexion à votre base de données se trouve dans le portail Azure.
consistencyLevel	Paramètre facultatif qui représente le niveau de cohérence. Il peut prendre n’importe quelle valeur de ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Point de terminaison de service à utiliser pour créer le client.
httpClient	Forme de HttpClient personnalisée facultative pour personnaliser la façon dont les requêtes sont effectuées par le pipeline HTTP. Consultez @azure/core-rest-pipeline pour plus d’informations sur l’implémentation de cette interface.
key	Clé principale ou en lecture seule du compte
permissionFeed	Tableau d’objets Permission.
resourceTokens	Objet qui contient des jetons de ressources. Les clés de l’objet sont des ID de ressource et des valeurs sont les jetons de ressource.
throughputBucket	Paramètre facultatif permettant de définir le numéro de seau de débit. Cette valeur peut être remplacée au niveau de la demande Pour plus d’informations, consultez la page Compartimentage du débit Cosmos DB.
tokenProvider	Fonction fournie par l’utilisateur pour la résolution des jetons d’autorisation d’en-tête. Permet aux utilisateurs de générer leurs propres jetons d’authentification, potentiellement à l’aide d’un service distinct
userAgentSuffix	Chaîne personnalisée à ajouter à l’agent utilisateur du Kit de développement logiciel (SDK) par défaut.

Détails de la propriété

aadCredentials

Jeton AAD de @azure/identity Obtenir un objet d’informations d’identification en créant un objet d’informations d’identification @azure/identity Nous allons ensuite utiliser votre objet d’informations d’identification et une URL d’étendue (votre point de terminaison Cosmos db) pour authentifier les demandes auprès de Cosmos

aadCredentials?: TokenCredential

Valeur de propriété

TokenCredential

agent

Agent http(s) personnalisé facultatif à utiliser dans les environnements NodeJS Utilisez un agent, par exemple https://github.com/TooTallNate/node-proxy-agent si vous devez vous connecter à Cosmos via un proxy

agent?: Agent

Valeur de propriété

Agent

clientEncryptionOptions

La stratégie de chiffrement pour les opérations impliquant le chiffrement doit être définie sur le client si le chiffrement côté client est utilisé

Voir ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Valeur de propriété

ClientEncryptionOptions

connectionPolicy

Instance de classe ConnectionPolicy. Ce paramètre est facultatif et la stratégie de connexion par défaut est utilisée s’il est omis.

connectionPolicy?: ConnectionPolicy

Valeur de propriété

ConnectionPolicy

connectionString

Paramètre facultatif qui représente la chaîne de connexion. La chaîne de connexion à votre base de données se trouve dans le portail Azure.

connectionString?: string

Valeur de propriété

string

consistencyLevel

Paramètre facultatif qui représente le niveau de cohérence. Il peut prendre n’importe quelle valeur de ConsistencyLevel.

consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

Valeur de propriété

"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

defaultHeaders

defaultHeaders?: CosmosHeaders

Valeur de propriété

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Valeur de propriété

CosmosDbDiagnosticLevel

endpoint

Point de terminaison de service à utiliser pour créer le client.

endpoint?: string

Valeur de propriété

string

httpClient

Forme de HttpClient personnalisée facultative pour personnaliser la façon dont les requêtes sont effectuées par le pipeline HTTP. Consultez @azure/core-rest-pipeline pour plus d’informations sur l’implémentation de cette interface.

httpClient?: HttpClient

Valeur de propriété

HttpClient

key

Clé principale ou en lecture seule du compte

key?: string

Valeur de propriété

string

permissionFeed

Tableau d’objets Permission.

permissionFeed?: PermissionDefinition[]

Valeur de propriété

PermissionDefinition[]

resourceTokens

Objet qui contient des jetons de ressources. Les clés de l’objet sont des ID de ressource et des valeurs sont les jetons de ressource.

resourceTokens?: {[resourcePath: string]: string}

Valeur de propriété

{[resourcePath: string]: string}

throughputBucket

Paramètre facultatif permettant de définir le numéro de seau de débit. Cette valeur peut être remplacée au niveau de la demande Pour plus d’informations, consultez la page Compartimentage du débit Cosmos DB.

throughputBucket?: number

Valeur de propriété

number

tokenProvider

Fonction fournie par l’utilisateur pour la résolution des jetons d’autorisation d’en-tête. Permet aux utilisateurs de générer leurs propres jetons d’authentification, potentiellement à l’aide d’un service distinct

tokenProvider?: TokenProvider

Valeur de propriété

TokenProvider

userAgentSuffix

Chaîne personnalisée à ajouter à l’agent utilisateur du Kit de développement logiciel (SDK) par défaut.

userAgentSuffix?: string

Valeur de propriété

string