Table of Contents

Class IncludedPath

Namespace
Microsoft.Azure.Documents
Assembly
Microsoft.Azure.Documents.Client.dll

Specifies a path within a JSON document to be included in the Azure Cosmos DB service.

public sealed class IncludedPath : JsonSerializable, ICloneable
Inheritance
IncludedPath
Implements
Inherited Members
Extension Methods

Constructors

IncludedPath()

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

public IncludedPath()

Properties

Indexes

Gets or sets the collection of Index objects to be applied for this included path in the Azure Cosmos DB service.

public Collection<Index> Indexes { get; set; }

Property Value

Collection<Index>

The collection of the Index objects to be applied for this included path.

Path

Gets or sets the path to be indexed in the Azure Cosmos DB service.

public string Path { get; set; }

Property Value

string

The path to be indexed.

Remarks

Refer to http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy for how to specify paths. Some valid examples: /"prop"/?, /"prop"/**, /"prop"/"subprop"/?, /"prop"/[]/?

Methods

Clone()

Creates a copy of the included path in the Azure Cosmos DB service.

public object Clone()

Returns

object

A clone of the included path.