Class MongoDBCollectionResource

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.Models

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Cosmos DB MongoDB collection resource object

public class MongoDBCollectionResource

Inheritance

object

MongoDBCollectionResource

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MongoDBCollectionResource()

Initializes a new instance of the MongoDBCollectionResource class.

public MongoDBCollectionResource()

MongoDBCollectionResource(string, IDictionary<string, string>, IList<MongoIndex>)

Initializes a new instance of the MongoDBCollectionResource class.

public MongoDBCollectionResource(string id, IDictionary<string, string> shardKey = null, IList<MongoIndex> indexes = null)

Parameters

id string

Name of the Cosmos DB MongoDB collection

shardKey IDictionary<string, string>

A key-value pair of shard keys to be applied for the request.

indexes IList<MongoIndex>

List of index keys

Properties

Id

Gets or sets name of the Cosmos DB MongoDB collection

public string Id { get; set; }

Property Value

string

Indexes

Gets or sets list of index keys

public IList<MongoIndex> Indexes { get; set; }

Property Value

IList<MongoIndex>

ShardKey

Gets or sets a key-value pair of shard keys to be applied for the request.

public IDictionary<string, string> ShardKey { get; set; }

Property Value

IDictionary<string, string>

Methods

Validate()

Validate the object.

public virtual void Validate()

Exceptions

Microsoft.Rest.ValidationException

Thrown if validation fails