Table of Contents

Interface ICosmosDBAccount

Namespace
Microsoft.Azure.Management.CosmosDB.Fluent
Assembly
Microsoft.Azure.Management.CosmosDB.Fluent.dll

An immutable client-side representation of an Azure Cosmos DB.

public interface ICosmosDBAccount : IBeta, IGroupableResource<ICosmosDBManager, DatabaseAccountGetResultsInner>, IResource, IIndexable, IHasId, IHasName, IHasResourceGroup, IHasManager<ICosmosDBManager>, IHasInner<DatabaseAccountGetResultsInner>, IRefreshable<ICosmosDBAccount>, IUpdatable<IUpdate>

Remarks

(Beta: This functionality is in preview and as such is subject to change in non-backwards compatible ways in future releases, including removal, regardless of any compatibility expectations set by the containing library version number.).

Properties

AutomaticFailoverEnabled

Gets whether automatic failover is enabled or not.

bool AutomaticFailoverEnabled { get; }

Property Value

bool

Capabilities

Gets a list that contains the Cosmos DB capabilities.

IReadOnlyList<Capability> Capabilities { get; }

Property Value

IReadOnlyList<Capability>

CassandraConnectorEnabled

Gets whether cassandra connector is enabled or not.

bool CassandraConnectorEnabled { get; }

Property Value

bool

CassandraConnectorOffer

Gets the current cassandra connector offer.

ConnectorOffer CassandraConnectorOffer { get; }

Property Value

ConnectorOffer

ConsistencyPolicy

Gets the consistency policy for the CosmosDB database account.

ConsistencyPolicy ConsistencyPolicy { get; }

Property Value

ConsistencyPolicy

DatabaseAccountOfferType

Gets the offer type for the CosmosDB database account.

DatabaseAccountOfferType DatabaseAccountOfferType { get; }

Property Value

DatabaseAccountOfferType

DefaultConsistencyLevel

Gets the default consistency level for the CosmosDB database account.

DefaultConsistencyLevel DefaultConsistencyLevel { get; }

Property Value

DefaultConsistencyLevel

DocumentEndpoint

Gets the connection endpoint for the CosmosDB database account.

string DocumentEndpoint { get; }

Property Value

string

IPRangeFilter

Gets specifies the set of IP addresses or IP address ranges in CIDR form.

string IPRangeFilter { get; }

Property Value

string

KeyBasedMetadataWriteAccessDisabled

Gets whether metadata write access is disabled or not.

bool KeyBasedMetadataWriteAccessDisabled { get; }

Property Value

bool

KeyVaultUri

Gets the key vault identifier linked to the CosmosDB account.

string KeyVaultUri { get; }

Property Value

string

Kind

Gets indicates the type of database account.

string Kind { get; }

Property Value

string

MultipleWriteLocationsEnabled

Gets whether write is enabled for multiple locations or not

bool? MultipleWriteLocationsEnabled { get; }

Property Value

bool?

ReadableReplications

Gets an array that contains the readable georeplication locations enabled for the CosmosDB account.

IReadOnlyList<Location> ReadableReplications { get; }

Property Value

IReadOnlyList<Location>

VirtualNetoworkFilterEnabled

Gets whether virtual network filter is enabled or not.

bool VirtualNetoworkFilterEnabled { get; }

Property Value

bool

VirtualNetworkRules

Gets a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set).

IReadOnlyList<VirtualNetworkRule> VirtualNetworkRules { get; }

Property Value

IReadOnlyList<VirtualNetworkRule>

WritableReplications

Gets an array that contains the writable georeplication locations enabled for the CosmosDB account.

IReadOnlyList<Location> WritableReplications { get; }

Property Value

IReadOnlyList<Location>

Methods

GetCassandraKeyspace(string) 

ICassandraKeyspace GetCassandraKeyspace(string name)

Parameters

name string

The name of Cassandra keyspace.

Returns

ICassandraKeyspace

The specific Cassandra keyspace.

GetCassandraKeyspaceAsync(string, CancellationToken) 

Task<ICassandraKeyspace> GetCassandraKeyspaceAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of Cassandra keyspace.

cancellationToken CancellationToken

Returns

Task<ICassandraKeyspace>

The specific Cassandra keyspace.

GetGremlinDatabase(string) 

IGremlinDatabase GetGremlinDatabase(string name)

Parameters

name string

The name of Gremlin Database.

Returns

IGremlinDatabase

The specific Gremlin Database.

GetGremlinDatabaseAsync(string, CancellationToken) 

Task<IGremlinDatabase> GetGremlinDatabaseAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of Gremlin Database.

cancellationToken CancellationToken

Returns

Task<IGremlinDatabase>

The specific Gremlin Database.

GetMongoDB(string) 

IMongoDB GetMongoDB(string databaseName)

Parameters

databaseName string

Database name of Mongo database.

Returns

IMongoDB

The specific Mongo database.

GetMongoDBAsync(string, CancellationToken) 

Task<IMongoDB> GetMongoDBAsync(string databaseName, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name of Mongo database.

cancellationToken CancellationToken

Returns

Task<IMongoDB>

The specific Mongo database.

GetPrivateEndpointConnection(string) 

IPrivateEndpointConnection GetPrivateEndpointConnection(string name)

Parameters

name string

Name of private endpoint connection.

Returns

IPrivateEndpointConnection

GetPrivateEndpointConnectionAsync(string, CancellationToken) 

Task<IPrivateEndpointConnection> GetPrivateEndpointConnectionAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

Name of private endpoint connection.

cancellationToken CancellationToken

Returns

Task<IPrivateEndpointConnection>

GetPrivateLinkResource(string) 

IPrivateLinkResource GetPrivateLinkResource(string groupName)

Parameters

groupName string

Group name of private link resource.

Returns

IPrivateLinkResource

GetPrivateLinkResourceAsync(string, CancellationToken) 

Task<IPrivateLinkResource> GetPrivateLinkResourceAsync(string groupName, CancellationToken cancellationToken = default)

Parameters

groupName string

Group name of private link resource.

cancellationToken CancellationToken

Returns

Task<IPrivateLinkResource>

GetSqlDatabase(string) 

ISqlDatabase GetSqlDatabase(string databaseName)

Parameters

databaseName string

Database name of SQL database.

Returns

ISqlDatabase

The specific SQL database.

GetSqlDatabaseAsync(string, CancellationToken) 

Task<ISqlDatabase> GetSqlDatabaseAsync(string databaseName, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name of SQL database.

cancellationToken CancellationToken

Returns

Task<ISqlDatabase>

The specific SQL database.

GetTable(string) 

ITable GetTable(string name)

Parameters

name string

The name of Table Database.

Returns

ITable

The specific Table Database.

GetTableAsync(string, CancellationToken) 

Task<ITable> GetTableAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of Table Database.

cancellationToken CancellationToken

Returns

Task<ITable>

The specific Table Database.

ListCassandraKeyspaces() 

IEnumerable<ICassandraKeyspace> ListCassandraKeyspaces()

Returns

IEnumerable<ICassandraKeyspace>

ListCassandraKeyspacesAsync(CancellationToken) 

Task<IEnumerable<ICassandraKeyspace>> ListCassandraKeyspacesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ICassandraKeyspace>>

ListConnectionStrings() 

IDatabaseAccountListConnectionStringsResult ListConnectionStrings()

Returns

IDatabaseAccountListConnectionStringsResult

ListConnectionStringsAsync(CancellationToken) 

Task<IDatabaseAccountListConnectionStringsResult> ListConnectionStringsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IDatabaseAccountListConnectionStringsResult>

ListGremlinDatabases() 

IEnumerable<IGremlinDatabase> ListGremlinDatabases()

Returns

IEnumerable<IGremlinDatabase>

ListGremlinDatabasesAsync(CancellationToken) 

Task<IEnumerable<IGremlinDatabase>> ListGremlinDatabasesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<IGremlinDatabase>>

ListKeys() 

IDatabaseAccountListKeysResult ListKeys()

Returns

IDatabaseAccountListKeysResult

ListKeysAsync(CancellationToken) 

Task<IDatabaseAccountListKeysResult> ListKeysAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IDatabaseAccountListKeysResult>

ListMongoDBs() 

IEnumerable<IMongoDB> ListMongoDBs()

Returns

IEnumerable<IMongoDB>

ListMongoDBsAsync(CancellationToken) 

Task<IEnumerable<IMongoDB>> ListMongoDBsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<IMongoDB>>

ListPrivateEndpointConnection() 

IReadOnlyDictionary<string, IPrivateEndpointConnection> ListPrivateEndpointConnection()

Returns

IReadOnlyDictionary<string, IPrivateEndpointConnection>

ListPrivateEndpointConnectionAsync(CancellationToken) 

Task<IReadOnlyDictionary<string, IPrivateEndpointConnection>> ListPrivateEndpointConnectionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IReadOnlyDictionary<string, IPrivateEndpointConnection>>

ListPrivateLinkResources() 

IReadOnlyList<IPrivateLinkResource> ListPrivateLinkResources()

Returns

IReadOnlyList<IPrivateLinkResource>

ListPrivateLinkResourcesAsync(CancellationToken) 

Task<IReadOnlyList<IPrivateLinkResource>> ListPrivateLinkResourcesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<IPrivateLinkResource>>

ListReadOnlyKeys() 

IDatabaseAccountListReadOnlyKeysResult ListReadOnlyKeys()

Returns

IDatabaseAccountListReadOnlyKeysResult

ListReadOnlyKeysAsync(CancellationToken) 

Task<IDatabaseAccountListReadOnlyKeysResult> ListReadOnlyKeysAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IDatabaseAccountListReadOnlyKeysResult>

ListSqlDatabases() 

IEnumerable<ISqlDatabase> ListSqlDatabases()

Returns

IEnumerable<ISqlDatabase>

ListSqlDatabasesAsync(CancellationToken) 

Task<IEnumerable<ISqlDatabase>> ListSqlDatabasesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ISqlDatabase>>

ListTables() 

IEnumerable<ITable> ListTables()

Returns

IEnumerable<ITable>

ListTablesAsync(CancellationToken) 

Task<IEnumerable<ITable>> ListTablesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ITable>>

OfflineRegion(Region)

It takes offline the specified region for the current Azure Cosmos DB database account.

void OfflineRegion(Region region)

Parameters

region Region

Cosmos DB region.

OfflineRegionAsync(Region, CancellationToken)

Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account.

Task OfflineRegionAsync(Region region, CancellationToken cancellationToken = default)

Parameters

region Region

Cosmos DB region.

cancellationToken CancellationToken

Returns

Task

OnlineRegion(Region)

It brings online the specified region for the current Azure Cosmos DB database account.

void OnlineRegion(Region region)

Parameters

region Region

Cosmos DB region.

OnlineRegionAsync(Region, CancellationToken)

Asynchronously it brings online the specified region for the current Azure Cosmos DB database account.

Task OnlineRegionAsync(Region region, CancellationToken cancellationToken = default)

Parameters

region Region

Cosmos DB region.

cancellationToken CancellationToken

Returns

Task

RegenerateKey(string) 

void RegenerateKey(string keyKind)

Parameters

keyKind string

The key kind.

RegenerateKeyAsync(string, CancellationToken) 

Task RegenerateKeyAsync(string keyKind, CancellationToken cancellationToken = default)

Parameters

keyKind string

The key kind.

cancellationToken CancellationToken

Returns

Task