CosmosDBIndexingPolicy Class

Definition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Cosmos DB indexing policy.

C#
public class CosmosDBIndexingPolicy : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBIndexingPolicy>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBIndexingPolicy>
Inheritance
CosmosDBIndexingPolicy
Implements

Constructors

CosmosDBIndexingPolicy()

Initializes a new instance of CosmosDBIndexingPolicy.

Properties

CompositeIndexes

List of composite path list.

ExcludedPaths

List of paths to exclude from indexing.

IncludedPaths

List of paths to include in the indexing.

IndexingMode

Indicates the indexing mode.

IsAutomatic

Indicates if the indexing policy is automatic.

SpatialIndexes

List of spatial specifics.

VectorIndexes

List of paths to include in the vector indexing.

Methods

Explicit Interface Implementations

IJsonModel<CosmosDBIndexingPolicy>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CosmosDBIndexingPolicy>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CosmosDBIndexingPolicy>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CosmosDBIndexingPolicy>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CosmosDBIndexingPolicy>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to

Product Versions
Azure SDK for .NET Latest, Preview