Interface IMongoDB

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

A Mongo DB.

public interface IMongoDB : IBeta, IHasInner<MongoDBDatabaseGetResultsInner>, IExternalChildResource<IMongoDB, ICosmosDBAccount>, IChildResource<ICosmosDBAccount>, IHasName, IIndexable, IHasParent<ICosmosDBAccount>, IRefreshable<IMongoDB>

Properties

MongoDBId

Gets name of the Cosmos DB Mongo DB.

string MongoDBId { get; }

Property Value

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

GetCollection(string)

IMongoCollection GetCollection(string name)

Parameters

name string

The name of the Mongo Collection.

Returns

IMongoCollection

The specific Mongo Collection.

GetCollectionAsync(string, CancellationToken)

Task<IMongoCollection> GetCollectionAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the Mongo Collection.

cancellationToken CancellationToken

Returns

Task<IMongoCollection>

The specific Mongo Collection.

GetThroughputSettings()

ThroughputSettingsGetPropertiesResource GetThroughputSettings()

Returns

ThroughputSettingsGetPropertiesResource

The throughput settings of the Mongo DB.

GetThroughputSettingsAsync(CancellationToken)

Task<ThroughputSettingsGetPropertiesResource> GetThroughputSettingsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ThroughputSettingsGetPropertiesResource>

The throughput settings of the Mongo DB.

ListCollections()

IEnumerable<IMongoCollection> ListCollections()

Returns

IEnumerable<IMongoCollection>

All Mongo Collections in the DB.

ListCollectionsAsync(CancellationToken)

Task<IEnumerable<IMongoCollection>> ListCollectionsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<IMongoCollection>>

All Mongo Collections in the DB.