IndexingPolicy Class

Definition

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Package:

Azure.Cosmos v4.0.0-preview3

Represents the indexing policy configuration for a collection in the Azure Cosmos DB service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonIndexingPolicyConverter))]
public sealed class IndexingPolicy

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonIndexingPolicyConverter))>]
type IndexingPolicy = class

Public NotInheritable Class IndexingPolicy

Inheritance

Object

IndexingPolicy

Attributes

JsonConverterAttribute

Remarks

Indexing policies can used to configure which properties (JSON paths) are included/excluded, whether the index is updated consistently or offline (lazy), automatic vs. opt-in per-document, as well as the precision and type of index per path.

Refer to for additional information on how to specify indexing policies.

Constructors

IndexingPolicy()

Initializes a new instance of the IndexingPolicy class for the Azure Cosmos DB service.

Properties

Automatic	Gets or sets a value that indicates whether automatic indexing is enabled for a collection in the Azure Cosmos DB service.
CompositeIndexes	Gets the composite indexes for additional indexes
ExcludedPaths	Gets the collection containing ExcludedPath objects in the Azure Cosmos DB service.
IncludedPaths	Gets the collection containing IncludedPath objects in the Azure Cosmos DB service.
IndexingMode	Gets or sets the indexing mode (consistent or lazy) in the Azure Cosmos DB service.
SpatialIndexes	Collection of spatial index definitions to be used

See also

• ContainerProperties