@azure/cosmos package

Classes

AbortError	Cette erreur est générée lorsqu’une opération asynchrone a été abandonnée. Vérifiez cette erreur en testant que name la propriété name de l’erreur correspond "AbortError"à . Exemple const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Fournit un itérateur pour le flux de modification. Utilisez Items.changeFeed() pour obtenir une instance de l’itérateur.
ChangeFeedIteratorResponse	Page de réponse unique du flux de modification Azure Cosmos DB
ChangeFeedResponse	Page de réponse unique du flux de modification Azure Cosmos DB
ChangeFeedStartFrom	Classe de base pour l’emplacement de démarrage d’un ChangeFeedIterator.
ClientSideMetrics
Conflict	Utilisez pour lire ou supprimer un conflit donné par ID. Consultez Conflits pour interroger ou lire tous les conflits.
ConflictResponse
Conflicts	Utilisez pour interroger ou lire tous les conflits. Consultez Conflit pour lire ou supprimer un conflit donné par ID.
Container	Opérations de lecture, de remplacement ou de suppression d’un conteneur existant spécifique par ID. Consultez Conteneurs pour créer de nouveaux conteneurs et lire/interroger tous les conteneurs. utilisez .containers. Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système de manière à ce que ces appels soient mis à l’échelle de manière inférieure à celle de votre application. Pour instance, n’appelez container(id).read() pas avant chaque item.read() appel, pour vous assurer que le conteneur existe ; effectuez cette opération une fois au démarrage de l’application.
ContainerResponse	Objet Response pour les opérations de conteneur
Containers	Opérations de création de conteneurs et de lecture/interrogation de tous les conteneurs Consultez Conteneur pour lire, remplacer ou supprimer un conteneur existant. utilisez .container(id). Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système de manière à ce que ces appels soient mis à l’échelle de manière inférieure à celle de votre application. Pour instance, n’appelez containers.readAll() pas avant chaque item.read() appel, pour vous assurer que le conteneur existe ; effectuez cette opération une fois au démarrage de l’application.
CosmosClient	Fournit une représentation logique côté client du compte de base de données Azure Cosmos DB. Ce client est utilisé pour configurer et exécuter des requêtes dans le service de base de données Azure Cosmos DB. Exemple Instancier un client et créer une base de données const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); Exemple Instancier un client avec une stratégie de connexion personnalisée const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	Il s’agit d’un type de diagnostic Cosmos qui contient les informations de diagnostic collectées lors d’une opération cliente. Ie. Item.read(), Container.create(). Il a trois membres - clientSideRequestStatistics le membre contient des informations de diagnostic agrégées, notamment : recherches de métadonnées. Ici, toutes les demandes de serveur, à l’exception de la ressource finale prévue, sont considérées comme des appels de métadonnées. Par exemple, pour item.read(id), si le client effectue un appel de serveur pour découvrir des points de terminaison, il est considéré comme un appel de métadonnées. retries points de terminaison contactés. statistiques de charge utile de la requête et de la réponse. gatewayStatistics : informations correspondant à main opération. Par exemple, pendant Item.read(), le client peut effectuer de nombreuses opérations, par exemple la recherche de métadonnées, etc., mais gatewayStatistics représente les informations diagnostics pour l’opération de lecture réelle. diagnosticNode : structure semblable à une arborescence qui capture des informations de diagnostic détaillées. Par défaut, elle est désactivée et est destinée à être utilisée uniquement pour le débogage sur des environnements hors production. Le type de détails capturés dans diagnosticNode est contrôlé par CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info : valeur par défaut. Dans ce niveau, seul clientSideRequestStatistics est capturé. Is est destiné aux environnements de production. CosmosDbDiagnosticLevel.debug : capture diagnosticNode et clientConfig. Aucune charge utile de requête et de réponse n’est capturée. N’est pas destiné à être utilisé dans l’environnement de production. CosmosDbDiagnosticLevel.debug-unsafe : en plus des données capturées dans CosmosDbDiagnosticLevel.debug, capture également les charges utiles de requête et de réponse. N’est pas destiné à être utilisé dans l’environnement de production. clientConfig : capture les informations relatives à la façon dont le client a été configuré pendant l’initialisation.
Database	Opérations de lecture ou de suppression d’une base de données existante. Consultez Bases de données pour la création de bases de données et la lecture/interrogation de toutes les bases de données. utilisez client.databases. Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système de manière à ce que ces appels soient mis à l’échelle de manière inférieure à celle de votre application. Pour instance, n’appelez database.read() pas avant chaque item.read() appel, pour vous assurer que la base de données existe ; effectuez cette opération une fois au démarrage de l’application.
DatabaseAccount	Représente un DatabaseAccount dans le service de base de données Azure Cosmos DB.
DatabaseResponse	Objet Response pour les opérations de base de données
Databases	Opérations de création de bases de données et de lecture/interrogation de toutes les bases de données Consultez Base de données pour lire ou supprimer une base de données existante. utilisez client.database(id). Remarque : toutes ces opérations effectuent des appels sur un budget fixe. Vous devez concevoir votre système de manière à ce que ces appels soient mis à l’échelle de manière inférieure à celle de votre application. Pour instance, n’appelez databases.readAll() pas avant chaque item.read() appel, pour vous assurer que la base de données existe ; effectuez cette opération une fois au démarrage de l’application.
ErrorResponse
FeedRange	Spécifie une plage de flux pour le flux de modification.
FeedResponse
Item	Utilisé pour effectuer des opérations sur un élément spécifique. Consultez Éléments pour connaître les opérations sur tous les éléments ; consultez container.items.
ItemResponse
Items	Opérations de création d’éléments et de lecture/interrogation de tous les éléments Consultez Élément pour lire, remplacer ou supprimer un conteneur existant . utilisez .item(id).
Offer	Utilisez pour lire ou remplacer une offre existante par ID. Consultez Offres pour interroger ou lire toutes les offres.
OfferResponse
Offers	Utilisez pour interroger ou lire toutes les offres. Consultez Offre pour lire ou remplacer une offre existante par id.
PartitionKeyBuilder	Classe Builder pour la génération de PartitionKey.
Permission	Utilisez pour lire, remplacer ou supprimer une autorisation donnée par ID. Consultez Autorisations pour créer, upsert, interroger ou lire toutes les autorisations.
PermissionResponse
Permissions	Utilisez pour créer, remplacer, interroger et lire toutes les autorisations. Consultez Autorisation de lecture, de remplacement ou de suppression d’une autorisation spécifique par ID.
QueryIterator	Représente un objet QueryIterator, une implémentation de flux ou de réponse de requête qui permet de parcourir et d’itérer la réponse dans le service de base de données Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Opérations de lecture, de remplacement, de suppression ou d’exécution d’une procédure stockée existante spécifique par ID. Pour les opérations de création, de lecture ou d’interrogation de procédures stockées,
StoredProcedureResponse
StoredProcedures	Opérations de création, d’upserting ou de lecture/interrogation de toutes les procédures stockées. Pour que les opérations de lecture, de remplacement, de suppression ou d’exécution d’une procédure stockée existante spécifique par id, consultez container.storedProcedure().
TimeoutError
Trigger	Opérations de lecture, de remplacement ou de suppression d’un déclencheur. Utilisez container.triggers pour créer, upsert, interroger ou lire tout.
TriggerResponse
Triggers	Opérations de création, de mise à jour, d’interrogation et de lecture de tous les déclencheurs. Utilisez container.triggers pour lire, remplacer ou supprimer un déclencheur.
User	Utilisé pour lire, remplacer et supprimer des utilisateurs. En outre, vous pouvez accéder aux autorisations d’un utilisateur donné via user.permission et user.permissions. Consultez Utilisateurs pour créer, upsert, interroger ou lire tout.
UserDefinedFunction	Utilisé pour lire, remplacer ou supprimer une fonction définie par l’utilisateur spécifiée par id. Consultez UserDefinedFunction pour créer, upsert, interroger et lire toutes les fonctions définies par l’utilisateur.
UserDefinedFunctionResponse
UserDefinedFunctions	Utilisé pour créer, upsert, interroger ou lire toutes les fonctions définies par l’utilisateur. Consultez UserDefinedFunction pour lire, remplacer ou supprimer une fonction définie par l’utilisateur par id.
UserResponse
Users	Permet de créer, d’effectuer une mise à jour, d’interroger et de lire tous les utilisateurs. Consultez Utilisateur pour lire, remplacer ou supprimer un utilisateur spécifique par ID.

Interfaces

@azure/cosmos.Index

Agent
BulkOptions	Objet Options utilisé pour modifier l’exécution en bloc. continueOnError (valeur par défaut : false) : poursuit l’exécution en bloc en cas d’échec d’une opération ** REMARQUE LA VALEUR PAR DÉFAUT EST TRUE DANS la VERSION 4.0
ChangeFeedIteratorOptions	Spécifie les options du flux de modification Si aucune de ces options n’est définie, il commence à lire les modifications à partir de maintenant pour l’ensemble du conteneur.
ChangeFeedOptions	Spécifie les options du flux de modification Certaines de ces options contrôlent où et quand commencer la lecture à partir du flux de modification. L’ordre de priorité est le suivant : continuation startTime startFromBeginning Si aucune de ces options n’est définie, il commence à lire les modifications à partir du premier ChangeFeedIterator.fetchNext() appel.
ChangeFeedPullModelIterator	Utilisez Items.getChangeFeedIterator() pour retourner un itérateur qui peut itérer sur toutes les modifications d’une clé de partition, d’une plage de flux ou d’un conteneur entier.
ConflictDefinition
ConflictResolutionPolicy	Représente la configuration de la stratégie de résolution des conflits pour spécifier comment résoudre les conflits au cas où les écritures provenant de différentes régions entraînent des conflits sur les documents de la collection dans le service Azure Cosmos DB.
ConnectionPolicy	Représente la stratégie de connexion associée à un CosmosClient dans le service de base de données Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Représente une arborescence comme une structure, pour capturer des informations de diagnostic.
ErrorBody
FailedRequestAttemptDiagnostic	Ce type capture les informations de diagnostic relatives à une demande ayant échoué à l’API du serveur.
FeedOptions	Options de flux et méthodes de requête.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	Les éléments dans Cosmos DB sont simplement des objets JSON. La plupart des opérations Item vous permettent de fournir votre propre type qui étend la très simple ItemDefinition. Vous ne pouvez pas utiliser de clés réservées. Vous pouvez voir la liste des clés réservées dans <xref:ItemBody>
JSONArray
JSONObject
Location	Utilisé pour spécifier les emplacements disponibles, la lecture est l’index 1 et l’écriture l’index 0.
MetadataLookUpDiagnostic	Ce type contient des informations de diagnostic concernant une requête de métadonnées unique au serveur.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Options qui peuvent être spécifiées pour une demande émise sur les serveurs Azure Cosmos DB.=
Resource
RetryOptions	Représente la stratégie de nouvelle tentative avec les requêtes limitées dans le service de base de données Azure Cosmos DB.
SharedOptions	Options qui peuvent être spécifiées pour une demande émise sur les serveurs Azure Cosmos DB.=
SpatialIndex
SqlParameter	Représente un paramètre dans une requête SQL paramétrée, spécifiée dans SqlQuerySpec
SqlQuerySpec	Représente une requête SQL dans le service Azure Cosmos DB. Les requêtes avec des entrées doivent être paramétrées pour se protéger contre l’injection SQL. Exemple Requête SQL paramétrée const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	Interface pour une clé unique transmise dans le cadre d’UniqueKeyPolicy
UniqueKeyPolicy	Interface permettant de définir des clés uniques lors de la création d’un conteneur
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Alias de type

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Ce type contient des informations relatives à l’initialisation de CosmosClient
ClientSideRequestStatistics	Il s’agit d’un type de collection pour toutes les informations de diagnostic côté client.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Ce type contient des informations de diagnostic concernant toutes les demandes de métadonnées adressées au serveur pendant une opération cliente CosmosDB.
NonePartitionKeyType	L’objet retourné représente une valeur de clé de partition qui permet de créer et d’accéder à des éléments sans valeur pour la clé de partition
NullPartitionKeyType	L’objet retourné représente une valeur de clé de partition qui permet de créer et d’accéder à des éléments avec une valeur null pour la clé de partition.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey d’un conteneur.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Valeur primitive de clé de partition.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Ce type capture les informations de diagnostic concernant les nouvelles tentatives pendant une opération cliente CosmosDB.
TokenProvider
UpsertOperation

Énumérations

ConflictResolutionMode
ConnectionMode	Détermine le comportement de connexion de CosmosClient. Notez que nous ne prenons actuellement en charge que le mode passerelle.
ConsistencyLevel	Représente les niveaux de cohérence pris en charge pour les opérations du client Azure Cosmos DB. Le consistencyLevel demandé doit correspondre ou être plus faible que celui provisionné pour le compte de base de données. Niveaux de cohérence. Les niveaux de cohérence par ordre de force sont Strong, BoundedStaleness, Session, Consistent Prefix et Eventual. Consultez https://aka.ms/cosmos-consistency la documentation plus détaillée sur les niveaux de cohérence.
CosmosDbDiagnosticLevel	Niveau de diagnostic Cosmos DB
DataType	Définit un type de données cible d’une spécification de chemin d’index dans le service Azure Cosmos DB.
GeospatialType
IndexKind	Spécifie les types d’index pris en charge.
IndexingMode	Spécifie les modes d’indexation pris en charge.
MetadataLookUpType	Il s’agit de l’énumération pour les recherches de type de métadonnées possibles.
PartitionKeyDefinitionVersion	Version de la définition PartitionKey
PartitionKeyKind	Type de PartitionKey, c’est-à-dire Hachage, MultiHash
PermissionMode	Enum pour les valeurs en mode d’autorisation.
PriorityLevel	Représente le niveau de priorité associé à chaque demande de client Azure Cosmos DB. Les demandes de faible priorité sont toujours limitées avant les demandes à priorité élevée. Par défaut, toutes les demandes sont considérées comme des demandes à priorité élevée. Consultez https://aka.ms/CosmosDB/PriorityBasedExecution une documentation plus détaillée sur la limitation basée sur la priorité.
SpatialType
TriggerOperation	Enum pour les valeurs d’opération de déclencheur. spécifie les opérations sur lesquelles un déclencheur doit être exécuté.
TriggerType	Enum pour les valeurs de type de déclencheur. Spécifie le type de déclencheur.
UserDefinedFunctionType	Enum pour les valeurs de type udf. Spécifie les types de fonctions définies par l’utilisateur.

Fonctions

createAuthorizationSasToken(string, SasTokenProperties)

Expérimental interne génère uniquement la charge utile représentant la configuration d’autorisation pour le jeton sas.

Informations relatives à la fonction

createAuthorizationSasToken(string, SasTokenProperties)

Expérimental interne génère uniquement la charge utile représentant la configuration d’autorisation pour le jeton sas.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Paramètres

masterKey

string

sasTokenProperties

SasTokenProperties

Retours

Promise<string>