Sdílet prostřednictvím


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.

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.

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 performance guide at https://docs.microsoft.com/azure/cosmos-db/performance-tips.

CosmosClientOptions

Defines all the configurable options that the CosmosClient requires.

CosmosConflicts

Operations for reading/querying conflicts in a Azure Cosmos container.

CosmosContainer

Operations for reading, replacing, or deleting a specific, existing container or item in a container by id. There are two different types of operations.

  1. The object operations where it serializes and deserializes the item on request/response
  2. The stream response which takes a Stream containing a JSON serialized object and returns a response containing a Stream CosmosDatabase for creating new containers, and reading/querying all containers;
CosmosDatabase

Operations for reading or deleting an existing database.

CosmosClient for or creating new databases, and reading/querying all databases; use client.Databases.

CosmosException

The Cosmos Client exception

CosmosPermission

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.
CosmosUser

Operations for reading, replacing, or deleting a specific existing user by id and query a user's permissions.

DatabaseProperties

Represents a database in the Azure Cosmos DB account.

DatabaseResponse

The cosmos database response

ExcludedPath

Specifies a path within a JSON document to be excluded while indexing data for the Azure Cosmos DB service.

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

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

Regions

The LocationNames class contains the names of Azure regions that are currently supported by the Azure Cosmos DB service.

RequestOptions

The default cosmos request options

StoredProcedureRequestOptions

The cosmos stored procedure request options

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

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.

UserProperties

Represents a user in the Azure Cosmos DB service.

UserResponse

The cosmos user response

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.

DataType

Defines the target data type of an index path specification 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.

PermissionMode

These are the access permissions for creating or replacing a PermissionProperties resource in the Azure Cosmos DB service.