IndexingPolicy Class
Updated: June 30, 2017
Represents the indexing policy configuration for a collection in the Azure DocumentDB database service.
Assembly: Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)
| Name | Description | |
|---|---|---|
 | IndexingPolicy | Initializes a new instance of the IndexingPolicy class for the Azure DocumentDB database service. |
| IndexingPolicy | Initializes a new instance of the IndexingPolicy class with the specified set of indexes as default index specifications for the root path for the Azure DocumentDB database service. |
| Name | Description | |
|---|---|---|
 | Gets or sets a value that indicates whether automatic indexing is enabled for a collection in the Azure DocumentDB database service. | |
| Gets or sets the collection containing ExcludedPath objects in the Azure DocumentDB database service. | |
| Gets or sets the collection containing IncludedPath objects in the Azure DocumentDB database service. | |
| Gets or sets the indexing mode (consistent or lazy) in the Azure DocumentDB database service. |
| Name | Description | |
|---|---|---|
| Clone | Performs a deep copy of the indexing policy for the Azure DocumentDB database service. |
| Equals | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| LoadFrom | Loads the object from the specified JSON reader in the Azure DocumentDB database service. (Inherited from JsonSerializable.) |
| SaveTo | Saves the object to the specified stream in the Azure DocumentDB database service. (Inherited from JsonSerializable.) |
| ToString | Returns the string representation of the object in the Azure DocumentDB database service. (Inherited from JsonSerializable.) |
| Name | Description | |
|---|---|---|
| IsDefined | Determines if a certain property is defined or not. (Defined by TypeCheckFunctionsExtensions.) |
| IsNull | Determines if a certain property is null or not. (Defined by TypeCheckFunctionsExtensions.) |
| IsPrimitive | Determines if a certain property is of premitive JSON type. (Defined by TypeCheckFunctionsExtensions.) |
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.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.