Interface IMongoCollection

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

A Mongo Collection.

public interface IMongoCollection : IBeta, IHasInner<MongoDBCollectionGetResultsInner>, IExternalChildResource<IMongoCollection, IMongoDB>, IChildResource<IMongoDB>, IHasName, IIndexable, IHasParent<IMongoDB>, IRefreshable<IMongoCollection>

Properties

Indexes

Gets list of index keys.

IReadOnlyList<MongoIndex> Indexes { get; }

Property Value

IReadOnlyList<MongoIndex>

MongoCollectionId

Gets name of the Cosmos DB Mongo Collection.

string MongoCollectionId { get; }

Property Value

string

ShardKey

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

IReadOnlyDictionary<string, string> ShardKey { get; }

Property Value

IReadOnlyDictionary<string, string>

_etag

Gets a system generated property representing the resource etag required for optimistic concurrency control.

string _etag { get; }

Property Value

string

_rid

Gets a system generated property. A unique identifier.

string _rid { get; }

Property Value

string

_ts

Gets a system generated property that denotes the last updated timestamp of the resource.

object _ts { get; }

Property Value

object

Methods

GetThroughputSettings()

ThroughputSettingsGetPropertiesResource GetThroughputSettings()

Returns

ThroughputSettingsGetPropertiesResource

The throughput settings of the Mongo Collection.

GetThroughputSettingsAsync(CancellationToken)

Task<ThroughputSettingsGetPropertiesResource> GetThroughputSettingsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ThroughputSettingsGetPropertiesResource>

The throughput settings of the Mongo Collection.