ICosmosDBAccount Interface

Definition

Namespace:

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly:

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Package:

Microsoft.Azure.Management.CosmosDB.Fluent v1.38.1

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

public interface ICosmosDBAccount : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBManager,Microsoft.Azure.Management.CosmosDB.Fluent.Models.DatabaseAccountGetResultsInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.CosmosDB.Fluent.Models.DatabaseAccountGetResultsInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IUpdatable<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Update.IUpdate>

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

Public Interface ICosmosDBAccount
Implements IBeta, IGroupableResource(Of ICosmosDBManager, DatabaseAccountGetResultsInner), IHasInner(Of DatabaseAccountGetResultsInner), IHasManager(Of ICosmosDBManager), IRefreshable(Of ICosmosDBAccount), IUpdatable(Of IUpdate)

Derived

Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccountImpl

Implements

IBeta IGroupableResource<ICosmosDBManager,DatabaseAccountGetResultsInner> IHasId IHasInner<InnerT> IHasInner<DatabaseAccountGetResultsInner> IHasManager<ManagerT> IHasManager<ICosmosDBManager> IHasName IHasResourceGroup IResource IIndexable 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.
Capabilities	Gets a list that contains the Cosmos DB capabilities.
CassandraConnectorEnabled	Gets whether cassandra connector is enabled or not.
CassandraConnectorOffer	Gets the current cassandra connector offer.
ConsistencyPolicy	Gets the consistency policy for the CosmosDB database account.
DatabaseAccountOfferType	Gets the offer type for the CosmosDB database account.
DefaultConsistencyLevel	Gets the default consistency level for the CosmosDB database account.
DocumentEndpoint	Gets the connection endpoint for the CosmosDB database account.
Id	Gets the resource id string (Inherited from IHasId)
Inner	(Inherited from IHasInner<T>)
IPRangeFilter	Gets specifies the set of IP addresses or IP address ranges in CIDR form.
Key	(Inherited from IIndexable)
KeyBasedMetadataWriteAccessDisabled	Gets whether metadata write access is disabled or not.
KeyVaultUri	Gets the key vault identifier linked to the CosmosDB account.
Kind	Gets indicates the type of database account.
Manager	Gets the manager client type of this resource type. (Inherited from IHasManager<ManagerT>)
MultipleWriteLocationsEnabled	Gets whether write is enabled for multiple locations or not
Name	Gets the name of the resource (Inherited from IHasName)
ReadableReplications	Gets an array that contains the readable georeplication locations enabled for the CosmosDB account.
Region	(Inherited from IResource)
RegionName	(Inherited from IResource)
ResourceGroupName	(Inherited from IHasResourceGroup)
Tags	(Inherited from IResource)
Type	(Inherited from IResource)
VirtualNetoworkFilterEnabled	Gets whether virtual network filter is enabled or not.
VirtualNetworkRules	Gets a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set).
WritableReplications	Gets an array that contains the writable georeplication locations enabled for the CosmosDB account.

Methods

GetCassandraKeyspace(String)
GetCassandraKeyspaceAsync(String, CancellationToken)
GetGremlinDatabase(String)
GetGremlinDatabaseAsync(String, CancellationToken)
GetMongoDB(String)
GetMongoDBAsync(String, CancellationToken)
GetPrivateEndpointConnection(String)
GetPrivateEndpointConnectionAsync(String, CancellationToken)
GetPrivateLinkResource(String)
GetPrivateLinkResourceAsync(String, CancellationToken)
GetSqlDatabase(String)
GetSqlDatabaseAsync(String, CancellationToken)
GetTable(String)
GetTableAsync(String, CancellationToken)
ListCassandraKeyspaces()
ListCassandraKeyspacesAsync(CancellationToken)
ListConnectionStrings()
ListConnectionStringsAsync(CancellationToken)
ListGremlinDatabases()
ListGremlinDatabasesAsync(CancellationToken)
ListKeys()
ListKeysAsync(CancellationToken)
ListMongoDBs()
ListMongoDBsAsync(CancellationToken)
ListPrivateEndpointConnection()
ListPrivateEndpointConnectionAsync(CancellationToken)
ListPrivateLinkResources()
ListPrivateLinkResourcesAsync(CancellationToken)
ListReadOnlyKeys()
ListReadOnlyKeysAsync(CancellationToken)
ListSqlDatabases()
ListSqlDatabasesAsync(CancellationToken)
ListTables()
ListTablesAsync(CancellationToken)
OfflineRegion(Region)	It takes offline the specified region for the current Azure Cosmos DB database account.
OfflineRegionAsync(Region, CancellationToken)	Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account.
OnlineRegion(Region)	It brings online the specified region for the current Azure Cosmos DB database account.
OnlineRegionAsync(Region, CancellationToken)	Asynchronously it brings online the specified region for the current Azure Cosmos DB database account.
Refresh()	Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>)
RefreshAsync(CancellationToken)	Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>)
RegenerateKey(String)
RegenerateKeyAsync(String, CancellationToken)
Update()	(Inherited from IUpdatable<T>)