Microsoft.Azure.Cosmos Espace de noms

Classes

AccountConsistency

Représente la stratégie de cohérence d’un compte de base de données du service Azure Cosmos DB.

AccountProperties

Représente un AccountProperties. Un AccountProperties est le conteneur pour les bases de données dans le service Azure Cosmos DB.

AccountRegion

La classe AccountLocation représente un compte de base de données Azure Cosmos DB dans une région spécifique.

BoundingBoxProperties

Représente un cadre englobant pour le chemin spatial géométrique dans le service Azure Cosmos DB

ChangeFeedEstimator

Permet d’estimer le travail restant en attente à lire par un ChangeFeedProcessor déploiement.

ChangeFeedEstimatorRequestOptions

Options de demande pour ChangeFeedEstimator.

ChangeFeedMode

Classe de base pour le mode ChangeFeedRequestOptionsde flux de modification .

ChangeFeedProcessor

Fournit une API pour démarrer et arrêter un ChangeFeedProcessor instance créé par Build().

ChangeFeedProcessorBuilder

Fournit un moyen flexible de créer un instance de ChangeFeedProcessor avec un ensemble personnalisé de paramètres.

ChangeFeedProcessorContext

Contexte lié à l’ensemble des modifications remises.

ChangeFeedProcessorState

Modifiez l’état du processeur de flux pour une plage particulière de clés de partition.

ChangeFeedProcessorUserException

Une exception s’est produite lorsqu’une opération dans un IChangeFeedObserver est en cours d’exécution et est levée par le code utilisateur

ChangeFeedRequestOptions

Options de demande de flux de modification Cosmos

ChangeFeedStartFrom

Classe de base pour l’emplacement où démarrer une opération ChangeFeed dans ChangeFeedRequestOptions.

ClientEncryptionIncludedPath

Chemin qui a besoin d’un chiffrement et des paramètres associés dans ClientEncryptionPolicy.

ClientEncryptionKey

Fournit des opérations pour lire une clé de chiffrement de données client spécifique (également appelée ClientEncryptionKey) par ID. Consultez pour connaître Database les opérations de création et d’énumération des clés de chiffrement client. Consultez https://aka.ms/CosmosClientEncryption pour plus d’informations sur la prise en charge du chiffrement côté client dans Azure Cosmos DB.

ClientEncryptionKeyProperties

Détails d’une clé de chiffrement à utiliser avec le service Azure Cosmos DB.

ClientEncryptionKeyResponse

Réponse du service Cosmos DB pour une ClientEncryptionKey demande associée.

ClientEncryptionPolicy

Le ClientEncryptionPolicy doit être initialisé avec le type de chiffrement policyFormatVersion 2 et « Déterministe », si la propriété « id » ou les propriétés qui font partie de la clé de partition doivent être chiffrées. Toutes les valeurs de propriété de clé de partition doivent être des chaînes JSON.

CompositePath

DOM pour un chemin composite. Un chemin composite est utilisé dans un index composite. Par exemple, si vous souhaitez exécuter une requête comme « SELECT * FROM c ORDER BY c.age, c.height », vous devez ajouter « /age » et « /height » en tant que chemins composites à votre index composite.

ConflictProperties

Représente un conflit dans le service Azure Cosmos DB.

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 éléments du conteneur dans le service Azure Cosmos DB.

Conflicts

Opérations de lecture/interrogation de conflits dans un conteneur Azure Cosmos.

Container

Opérations de lecture, de remplacement ou de suppression d’un conteneur ou d’un élément existant spécifique dans un conteneur par ID. Il existe deux types d’opérations différents.

  1. Opérations d’objet où il sérialise et désérialise l’élément à la demande/réponse
  2. Réponse de flux qui prend un Stream contenant un objet sérialisé JSON et retourne une réponse contenant un Stream See Database pour créer de nouveaux conteneurs et lire/interroger tous les conteneurs.
ContainerProperties

Représente un conteneur de documents dans le service Azure Cosmos DB. Un conteneur est un conteneur logique nommé pour les documents.

ContainerRequestOptions

Options de demande de conteneur cosmos

ContainerResponse

Réponse du conteneur Cosmos

CosmosClient

Fournit une représentation logique côté client du compte Azure Cosmos DB. Ce client peut être utilisé pour configurer et exécuter des requêtes dans le service de base de données Azure Cosmos DB.

CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.

CosmosClientOptions

Définit toutes les options configurables requises par CosmosClient.

CosmosClientTelemetryOptions

Options de télémétrie pour le client Cosmos pour activer/désactiver la télémétrie et le suivi distribué, ainsi que les valeurs de seuil correspondantes.

CosmosDiagnostics

Contient les informations de diagnostic cosmos pour la demande actuelle au service Azure Cosmos DB.

CosmosException

Exception du client Cosmos

CosmosLinqSerializerOptions

Cette classe permet de configurer les propriétés de sérialisation Linq

CosmosOperationCanceledException

Exception levée dans un thread en cas d'annulation d'une opération en cours d'exécution par ce thread. Cela étend l’exception OperationCanceledException pour inclure la diagnostics de l’opération qui a été annulée.

CosmosResponseFactory

Cette fabrique de réponse convertit les messages de réponse en réponse de type correspondante à l’aide du sérialiseur CosmosClient

CosmosSerializationOptions

Cette classe fournit un moyen de configurer les paramètres de sérialiseur de base.

CosmosSerializer

Il s’agit d’une interface permettant d’utiliser un sérialiseur personnalisé par cosmosClient

CosmosThresholdOptions

Valeurs de seuil pour le suivi distribué

Database

Opérations de lecture ou de suppression d’une base de données existante.

Consultez Client pour créer des bases de données et lire/interroger toutes les bases de données ; utilisez client.Databases.

DatabaseProperties

Représente une base de données dans le compte Azure Cosmos DB.

DatabaseResponse

Réponse de la base de données Cosmos

DedicatedGatewayRequestOptions

Options de demande de passerelle dédiée

EncryptionKeyWrapMetadata

Métadonnées qui peuvent être utilisées pour encapsuler/désencapsuler une clé de chiffrement de données à l’aide d’une clé gérée par le client. Consultez https://aka.ms/CosmosClientEncryption pour plus d’informations sur la prise en charge du chiffrement côté client dans Azure Cosmos DB.

ExcludedPath

Spécifie un chemin d’accès dans un document JSON à exclure lors de l’indexation des données pour le service Azure Cosmos DB.

FeedIterator

Itérateur du jeu de résultats Cosmos qui effectue le suivi du jeton de continuation lors de la récupération des résultats d’une requête.

FeedIterator<T>

Itérateur du jeu de résultats Cosmos qui effectue le suivi du jeton de continuation lors de la récupération des résultats d’une requête.

FeedRange

Représente une unité de consommation d’alimentation qui peut être utilisée comme unité de parallélisme.

FeedResponse<T>

Contrat utilisateur pour les différentes réponses de flux qui sérialisent les réponses à un type. Pour suivre la norme .NET pour les réponses typées, toutes les exceptions doivent être levées à l’utilisateur.

GeospatialConfig

Représente la configuration géospatiale d’une collection dans le service Azure Cosmos DB

Headers

Implémentation de l’en-tête utilisée pour la requête et les réponses

IncludedPath

Spécifie un chemin d’accès dans un document JSON à inclure dans le service Azure Cosmos DB.

IndexingPolicy

Représente la configuration de la stratégie d’indexation pour une collection dans le service Azure Cosmos DB.

ItemRequestOptions

Options de demande d’élément Cosmos

ItemResponse<T>

Réponse de l’élément cosmos

PartitionKeyBuilder

Représente une liste de valeurs de clé de partition dans le service Azure Cosmos DB.

PatchItemRequestOptions

Options de demande de correctif Cosmos

PatchOperation

Détails de l’opération patch à appliquer à l’élément Cosmos référencé.

PatchOperation<T>

Définit PatchOperation avec un paramètre de valeur.

Permission

Opérations de lecture, de remplacement ou de suppression d’une autorisation spécifique par ID. Les autorisations sont utilisées pour créer ResourceTokens. Les jetons de ressource fournissent un accès aux ressources d’application au sein d’une base de données. Jetons de ressource :

  • Fournissent un accès à des conteneurs, clés de partition, documents, pièces jointes, procédures stockées, déclencheurs et fonctions définies par l’utilisateur spécifiques.
  • Sont créés lorsqu’un utilisateur dispose des autorisations sur une ressource spécifique.
  • Sont recréés lorsqu’une ressource d’autorisation est exécutée par un appel POST, GET ou PUT.
  • Utilisent un jeton de ressource de hachage créé spécifiquement pour l’utilisateur, la ressource et les autorisations.
  • Sont liés à une période de validité personnalisable. La durée de validité par défaut est d’une heure. La durée de vie du jeton peut cependant être définie de manière explicite (24 heures maximum).
  • Offrent une alternative sûre pour céder la clé principale.
  • Permettent aux clients de lire, d’écrire et de supprimer des ressources dans le compte Azure Cosmos DB en fonction des autorisations qui leur ont été accordées.
PermissionProperties

Représente une autorisation dans le service Azure Cosmos DB.

PermissionResponse

Réponse d’autorisation cosmos

QueryDefinition

Définit une requête Cosmos SQL

QueryRequestOptions

Options de requête Cosmos

ReadManyRequestOptions

Options de requête Cosmos

Regions

La classe LocationNames contient les noms des régions Azure actuellement prises en charge par le service Azure Cosmos DB.

RequestHandler

Abstraction qui permet de définir des gestionnaires de messages personnalisés.

RequestMessage

Représente une requête dans le pipeline de traitement du Kit de développement logiciel (SDK) Azure Cosmos DB.

RequestOptions

Options de requête cosmos par défaut

Response<T>

Classe de réponse aux ressources cosmos

ResponseMessage

Représente une réponse du service Azure Cosmos DB.

ServerSideCumulativeMetrics

Métriques reçues pour les requêtes provenant du back-end.

ServerSideMetrics

Métriques reçues pour les requêtes provenant du back-end.

ServerSidePartitionedMetrics

Représente les métriques côté serveur spécifiques pour une partition unique.

SpatialPath

Spécification d’index spatial

ThroughputProperties

Représente un débit des ressources dans le service Azure Cosmos DB. Il s’agit de la tarification standard de la ressource dans le service Azure Cosmos DB.

ThroughputResponse

Réponse de débit cosmos

TransactionalBatch

Représente un lot d’opérations sur des éléments avec les mêmes PartitionKey dans un conteneur qui seront effectuées de manière transactionnelle sur le service Azure Cosmos DB. Utilisez CreateTransactionalBatch(PartitionKey) pour créer un instance de TransactionalBatch.

TransactionalBatchItemRequestOptions

RequestOptions qui s’applique à une opération dans un TransactionalBatch.

TransactionalBatchOperationResult

Représente un résultat pour une opération spécifique qui faisait partie d’une TransactionalBatch requête.

TransactionalBatchOperationResult<T>

Représente un résultat pour une opération spécifique qui fait partie d’un lot.

TransactionalBatchPatchItemRequestOptions

Options de demande de correctif Cosmos Batch

TransactionalBatchRequestOptions

Options de demande par lots Cosmos.

TransactionalBatchResponse

Réponse d’une TransactionalBatch demande.

UniqueKey

Représente une clé unique sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB.

UniqueKeyPolicy

Représente la configuration de stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB.

User

Opérations de lecture, de remplacement ou de suppression d’un utilisateur existant spécifique par ID et interroger les autorisations d’un utilisateur.

UserProperties

Représente un utilisateur dans le service Azure Cosmos DB.

UserResponse

Réponse de l’utilisateur cosmos

Structures

PartitionKey

Représente une valeur de clé de partition dans le service Azure Cosmos DB.

Énumérations

CompositePathSortOrder

Définit le type de données cible d’une spécification de chemin d’index dans le service Azure Cosmos DB.

ConflictResolutionMode

Spécifie les modes de résolution des conflits pris en charge, comme spécifié dans ConflictResolutionPolicy

ConnectionMode

Représente le mode de connexion à utiliser par le client lors de la connexion au service Azure Cosmos DB.

ConsistencyLevel

Il s’agit des niveaux de cohérence pris en charge par le service Azure Cosmos DB.

CosmosPropertyNamingPolicy

Détermine la stratégie de nommage utilisée pour convertir un nom basé sur une chaîne dans un autre format, tel qu’une casse en chameau où la première lettre est en minuscules.

DataType

Définit le type de données cible d’une spécification de chemin d’index dans le service Azure Cosmos DB.

GeospatialType

Spécifie les types géospatiaux pris en charge dans le service Azure Cosmos DB.

IndexingDirective

Spécifie si la ressource de la base de données Azure Cosmos DB doit être indexée ou non.

IndexingMode

Spécifie les modes d’indexation pris en charge dans le service Azure Cosmos DB.

IndexKind

Il s’agit des types d’indexation disponibles pour l’indexation d’un chemin dans le service Azure Cosmos DB.

OperationKind

Il s’agit des types d’opérations qui ont entraîné un conflit de version sur une ressource.

PartitionKeyDefinitionVersion

Version de partitionnement.

PatchOperationType

Décrit la liste des types d’opérations pris en charge par patch.

PermissionMode

Il s’agit des autorisations d’accès permettant de créer ou de remplacer une PermissionProperties ressource dans le service Azure Cosmos DB.

PortReuseMode

Options de stratégie de réutilisation des ports utilisées par la pile de transport

SpatialType

Définit le type de données cible d’une spécification de chemin d’index dans le service Azure Cosmos DB.

Délégués

Container.ChangeFeedHandler<T>

Déléguer pour recevoir les modifications dans une ChangeFeedProcessor exécution.

Container.ChangeFeedHandlerWithManualCheckpoint<T>

Déléguer pour recevoir les modifications dans une ChangeFeedProcessor exécution avec un point de contrôle manuel.

Container.ChangeFeedMonitorErrorDelegate

Déléguer pour notifier les erreurs lors des opérations de flux de modification.

Container.ChangeFeedMonitorLeaseAcquireDelegate

Déléguer pour notifier les événements d’acquisition de baux par un processeur de flux de modification.

Container.ChangeFeedMonitorLeaseReleaseDelegate

Déléguer pour notifier les événements des baux en cours de publication par un processeur de flux de modification.

Container.ChangeFeedStreamHandler

Déléguer pour recevoir les modifications dans une ChangeFeedProcessor exécution.

Container.ChangeFeedStreamHandlerWithManualCheckpoint

Déléguer pour recevoir les modifications dans une ChangeFeedProcessor exécution avec un point de contrôle manuel.

Container.ChangesEstimationHandler

Déléguer pour recevoir l’estimation des modifications en attente à lire par le instance associé ChangeFeedProcessor .

Container.ChangesHandler<T>

Déléguer pour recevoir les modifications dans une ChangeFeedProcessor exécution.