Microsoft.Azure.Cosmos Namespace

Classes

AccountConsistency	Represents the consistency policy of a database account of the Azure Cosmos DB service.
AccountProperties	Represents a AccountProperties. A AccountProperties is the container for databases in the Azure Cosmos DB service.
AccountRegion	The AccountLocation class represents an Azure Cosmos DB database account in a specific region.
BoundingBoxProperties	Represents bounding box for geometry spatial path in the Azure Cosmos DB service
ChangeFeedEstimator	Used to estimate the pending work remaining to be read by a ChangeFeedProcessor deployment.
ChangeFeedEstimatorRequestOptions	Request options for ChangeFeedEstimator.
ChangeFeedMode	Base class for the change feed mode ChangeFeedRequestOptions.
ChangeFeedProcessor	Provides an API to start and stop a ChangeFeedProcessor instance created by Build().
ChangeFeedProcessorBuilder	Provides a flexible way to create an instance of ChangeFeedProcessor with custom set of parameters.
ChangeFeedProcessorContext	Context that is related to the set of delivered changes.
ChangeFeedProcessorState	Change Feed processor state for a particular range of partition keys.
ChangeFeedProcessorUserException	Exception occurred when an operation in an IChangeFeedObserver is running and throws by user code
ChangeFeedRequestOptions	The Cosmos Change Feed request options
ChangeFeedStartFrom	Base class for where to start a ChangeFeed operation in ChangeFeedRequestOptions.
ClientEncryptionIncludedPath	Path that needs encryption and the associated settings within ClientEncryptionPolicy.
ClientEncryptionKey	Provides operations for reading a specific client data encryption key (aka ClientEncryptionKey) by Id. See Database for operations to create and enumerate client encryption keys. See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.
ClientEncryptionKeyProperties	Details of an encryption key for use with the Azure Cosmos DB service.
ClientEncryptionKeyResponse	Response from the Cosmos DB service for a ClientEncryptionKey related request.
ClientEncryptionPolicy	The ClientEncryptionPolicy should be initialized with policyFormatVersion 2 and "Deterministic" encryption type, if "id" property or properties which are part of partition key need to be encrypted. All partition key property values have to be JSON strings.
CompositePath	DOM for a composite path. A composite path is used in a composite index. For example if you want to run a query like "SELECT * FROM c ORDER BY c.age, c.height", then you need to add "/age" and "/height" as composite paths to your composite index.
ConflictProperties	Represents a conflict in the Azure Cosmos DB service.
ConflictResolutionPolicy	Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on items in the container in the Azure Cosmos DB service.
Conflicts	Operations for reading/querying conflicts in a Azure Cosmos container.
Container	Operations for reading, replacing, or deleting a specific, existing container or item in a container by id. There are two different types of operations. The object operations where it serializes and deserializes the item on request/response The stream response which takes a Stream containing a JSON serialized object and returns a response containing a Stream See Database for creating new containers, and reading/querying all containers.
ContainerProperties	Represents a document container in the Azure Cosmos DB service. A container is a named logical container for documents.
ContainerRequestOptions	The cosmos container request options
ContainerResponse	The cosmos container response
CosmosClient	Provides a client-side logical representation of the Azure Cosmos DB account. This client can be used to configure and execute requests in the Azure Cosmos DB database service. CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime of the application which enables efficient connection management and performance. Please refer to the performance guide.
CosmosClientOptions	Defines all the configurable options that the CosmosClient requires.
CosmosClientTelemetryOptions	Telemetry Options for Cosmos Client to enable/disable telemetry and distributed tracing along with corresponding threshold values.
CosmosDiagnostics	Contains the cosmos diagnostic information for the current request to Azure Cosmos DB service.
CosmosException	The Cosmos Client exception
CosmosLinqSerializer	This abstract class can be implemented to allow a custom serializer (Non Json.NET serializer's) to be used by the CosmosClient for LINQ queries.
CosmosLinqSerializerOptions	This class provides a way to configure Linq Serialization Properties
CosmosOperationCanceledException	The exception that is thrown in a thread upon cancellation of an operation that the thread was executing. This extends the OperationCanceledException to include the diagnostics of the operation that was canceled.
CosmosResponseFactory	This response factory converts response messages to the corresponding type response using the CosmosClient serializer
CosmosSerializationOptions	This class provides a way to configure basic serializer settings.
CosmosSerializer	This abstract class can be implemented to allow a custom serializer to be used by the CosmosClient.
CosmosThresholdOptions	This class describes the thresholds when more details diagnostics events are emitted, if subscribed, for an operation due to high latency, high RU consumption or high payload sizes.
Database	Operations for reading or deleting an existing database. See Client for creating new databases, and reading/querying all databases; use client.Databases.
DatabaseProperties	Represents a database in the Azure Cosmos DB account.
DatabaseResponse	The cosmos database response
DedicatedGatewayRequestOptions	The Dedicated Gateway request options
Embedding	Represents the embedding settings for the vector index.
EncryptionKeyWrapMetadata	Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key. See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.
ExcludedPath	Specifies a path within a JSON document to be excluded while indexing data for the Azure Cosmos DB service.
FeedIterator	Cosmos Result set iterator that keeps track of the continuation token when retrieving results form a query.
FeedIterator<T>	Cosmos Result set iterator that keeps track of the continuation token when retrieving results form a query.
FeedRange	Represents a unit of feed consumption that can be used as unit of parallelism.
FeedResponse<T>	The user contract for the various feed responses that serialized the responses to a type. To follow the .NET standard for typed responses any exceptions should be thrown to the user.
GeospatialConfig	Represents geospatial configuration for a collection in the Azure Cosmos DB service
Headers	Header implementation used for Request and Responses
IncludedPath	Specifies a path within a JSON document to be included in the Azure Cosmos DB service.
IndexingPolicy	Represents the indexing policy configuration for a collection in the Azure Cosmos DB service.
ItemRequestOptions	Cosmos item request options
ItemResponse<T>	The cosmos item response
PartitionKeyBuilder	Represents a partition key value list in the Azure Cosmos DB service.
PatchItemRequestOptions	Cosmos Patch request options
PatchOperation	Details of Patch operation that is to be applied to the referred Cosmos item.
PatchOperation<T>	Defines PatchOperation with a value parameter.
Permission	Operations for reading, replacing, or deleting a specific permission by id. Permissions are used to create ResourceTokens. Resource tokens provide access to the application resources within a database. Resource tokens: Provide access to specific containers, partition keys, documents, attachments, stored procedures, triggers, and UDFs. Are created when a user is granted permissions to a specific resource. Are recreated when a permission resource is acted upon on by POST, GET, or PUT call. Use a hash resource token specifically constructed for the user, resource, and permission. Are time bound with a customizable validity period. The default valid timespan is one hour. Token lifetime, however, may be explicitly specified, up to a maximum of 24 hours. Provide a safe alternative to giving out the master key. Enable clients to read, write, and delete resources in the Cosmos DB account according to the permissions they've been granted.
PermissionProperties	Represents a permission in the Azure Cosmos DB service.
PermissionResponse	The cosmos permission response
QueryDefinition	Defines a Cosmos SQL query
QueryRequestOptions	The Cosmos query request options
ReadManyRequestOptions	The Cosmos query request options
Regions	The LocationNames class contains the names of Azure regions that are currently supported by the Azure Cosmos DB service.
RequestHandler	Abstraction which allows defining of custom message handlers.
RequestMessage	Represents a request in the processing pipeline of the Azure Cosmos DB SDK.
RequestOptions	The default cosmos request options
Response<T>	The cosmos resource response class
ResponseMessage	Represents a response from the Azure Cosmos DB service.
ServerSideCumulativeMetrics	Metrics received for queries from the backend.
ServerSideMetrics	Metrics received for queries from the backend.
ServerSidePartitionedMetrics	Represents server side metrics specific for a single partition.
SpatialPath	Spatial index specification
ThroughputProperties	Represents a throughput of the resources in the Azure Cosmos DB service. It is the standard pricing for the resource in the Azure Cosmos DB service.
ThroughputResponse	The cosmos throughput response
TransactionalBatch	Represents a batch of operations against items with the same PartitionKey in a container that will be performed in a transactional manner at the Azure Cosmos DB service. Use CreateTransactionalBatch(PartitionKey) to create an instance of TransactionalBatch.
TransactionalBatchItemRequestOptions	RequestOptions that applies to an operation within a TransactionalBatch.
TransactionalBatchOperationResult	Represents a result for a specific operation that was part of a TransactionalBatch request.
TransactionalBatchOperationResult<T>	Represents a result for a specific operation that is part of a batch.
TransactionalBatchPatchItemRequestOptions	Cosmos Batch Patch request options
TransactionalBatchRequestOptions	Cosmos batch request options.
TransactionalBatchResponse	Response of a TransactionalBatch request.
UniqueKey	Represents a unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicy	Represents the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
User	Operations for reading, replacing, or deleting a specific existing user by id and query a user's permissions.
UserProperties	Represents a user in the Azure Cosmos DB service.
UserResponse	The cosmos user response
VectorEmbeddingPolicy	Represents the vector embedding policy configuration for specifying the vector embeddings on documents in the collection in the Azure Cosmos DB service.
VectorIndexPath	DOM for a vector index path. A vector index path is used in a vector index.

Structs

PartitionKey

Represents a partition key value in the Azure Cosmos DB service.

Enums

CompositePathSortOrder	Defines the target data type of an index path specification in the Azure Cosmos DB service.
ConflictResolutionMode	Specifies the supported conflict resolution modes, as specified in ConflictResolutionPolicy
ConnectionMode	Represents the connection mode to be used by the client when connecting to the Azure Cosmos DB service.
ConsistencyLevel	These are the consistency levels supported by the Azure Cosmos DB service.
CosmosPropertyNamingPolicy	Determines the naming policy used to convert a string-based name to another format, such as a camel-casing where the first letter is lower case.
DataType	Defines the target data type of an index path specification in the Azure Cosmos DB service.
DistanceFunction	Defines the distance function for a vector index specification in the Azure Cosmos DB service.
GeospatialType	Specifies the supported geospatial types in the Azure Cosmos DB service.
IndexingDirective	Specifies whether or not the resource in the Azure Cosmos DB database is to be indexed.
IndexingMode	Specifies the supported indexing modes in the Azure Cosmos DB service.
IndexKind	These are the indexing types available for indexing a path in the Azure Cosmos DB service.
OperationKind	These are the operation types resulted in a version conflict on a resource.
PartitionKeyDefinitionVersion	Partitioning version.
PatchOperationType	Describes the list of Patch supported operation types.
PermissionMode	These are the access permissions for creating or replacing a PermissionProperties resource in the Azure Cosmos DB service.
PortReuseMode	Port reuse policy options used by the transport stack
PriorityLevel	Valid values of Priority Level for a request
QueryTextMode	Defines whether to print query text in tracing attributes.
SpatialType	Defines the target data type of an index path specification in the Azure Cosmos DB service.
VectorDataType	Defines the target data type of a vector index specification in the Azure Cosmos DB service.
VectorIndexType	Defines the target index type of an vector index path specification in the Azure Cosmos DB service.

Delegates

Container.ChangeFeedHandler<T>	Delegate to receive the changes within a ChangeFeedProcessor execution.
Container.ChangeFeedHandlerWithManualCheckpoint<T>	Delegate to receive the changes within a ChangeFeedProcessor execution with manual checkpoint.
Container.ChangeFeedMonitorErrorDelegate	Delegate to notify errors during change feed operations.
Container.ChangeFeedMonitorLeaseAcquireDelegate	Delegate to notify events of leases being acquired by a change feed processor.
Container.ChangeFeedMonitorLeaseReleaseDelegate	Delegate to notify events of leases being releases by a change feed processor.
Container.ChangeFeedStreamHandler	Delegate to receive the changes within a ChangeFeedProcessor execution.
Container.ChangeFeedStreamHandlerWithManualCheckpoint	Delegate to receive the changes within a ChangeFeedProcessor execution with manual checkpoint.
Container.ChangesEstimationHandler	Delegate to receive the estimation of pending changes to be read by the associated ChangeFeedProcessor instance.
Container.ChangesHandler<T>	Delegate to receive the changes within a ChangeFeedProcessor execution.