Class CosmosDBAccountImpl

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

The implementation for DatabaseAccount.

public class CosmosDBAccountImpl : GroupableResource<ICosmosDBAccount, DatabaseAccountGetResultsInner, CosmosDBAccountImpl, ICosmosDBManager, IWithGroup, IWithKind, IWithCreate, IUpdate>, ICosmosDBAccount, IGroupableResource<ICosmosDBManager, DatabaseAccountGetResultsInner>, IResource, IHasId, IHasName, IHasResourceGroup, IHasManager<ICosmosDBManager>, IHasInner<DatabaseAccountGetResultsInner>, IRefreshable<ICosmosDBAccount>, IUpdatable<IUpdate>, IDefinition, IBlank, IDefinitionWithRegion<IWithGroup>, IWithGroup, IWithGroup<IWithKind>, IWithExistingResourceGroup<IWithKind>, IWithNewResourceGroup<IWithKind>, IWithCreatableResourceGroup<IWithKind>, IWithKind, IWithKindBeta, IWithWriteReplication, IWithCreate, IWithReadReplication, IWithChildResource, ICreatable<ICosmosDBAccount>, IWithConsistencyPolicy, IWithIpRangeFilter, IWithVirtualNetworkRule, IWithMultipleLocations, IWithConnector, IWithKeyBasedMetadataWriteAccess, IWithPrivateEndpointConnection, IWithAutomaticFailover, IWithKeyVault, IDefinitionWithTags<IWithCreate>, IUpdate, IWithReadLocations, IWithWriteReplication, IWithOptionals, IAppliable<ICosmosDBAccount>, IIndexable, IUpdateWithTags<IWithOptionals>, IWithConsistencyPolicy, IWithVirtualNetworkRule, IBeta, IWithIpRangeFilter, IWithConnector, IWithMultipleLocations, IWithKeyBasedMetadataWriteAccess, IWithPrivateEndpointConnection, IWithAutomaticFailover, IWithKeyVault, IWithChildResource

Inheritance

object

CosmosDBAccountImpl

Implements

ICosmosDBAccount

IGroupableResource<ICosmosDBManager, DatabaseAccountGetResultsInner>

IResource

IHasId

IHasName

IHasResourceGroup

IHasManager<ICosmosDBManager>

IHasInner<DatabaseAccountGetResultsInner>

IRefreshable<ICosmosDBAccount>

IUpdatable<IUpdate>

IDefinition

IBlank

IDefinitionWithRegion<IWithGroup>

IWithGroup

IWithGroup<IWithKind>

IWithExistingResourceGroup<IWithKind>

IWithNewResourceGroup<IWithKind>

IWithCreatableResourceGroup<IWithKind>

IWithKind

IWithKindBeta

IWithWriteReplication

IWithCreate

IWithReadReplication

IWithChildResource

ICreatable<ICosmosDBAccount>

IWithConsistencyPolicy

IWithIpRangeFilter

IWithVirtualNetworkRule

IWithMultipleLocations

IWithConnector

IWithKeyBasedMetadataWriteAccess

IWithPrivateEndpointConnection

IWithAutomaticFailover

IWithKeyVault

IDefinitionWithTags<IWithCreate>

IUpdate

IWithReadLocations

IWithWriteReplication

IWithOptionals

IAppliable<ICosmosDBAccount>

IIndexable

IUpdateWithTags<IWithOptionals>

IWithConsistencyPolicy

IWithVirtualNetworkRule

IBeta

IWithIpRangeFilter

IWithConnector

IWithMultipleLocations

IWithKeyBasedMetadataWriteAccess

IWithPrivateEndpointConnection

IWithAutomaticFailover

IWithKeyVault

IWithChildResource

Methods

AutomaticFailoverEnabled()

public bool AutomaticFailoverEnabled()

Returns

bool

Capabilities()

public IReadOnlyList<Capability> Capabilities()

Returns

IReadOnlyList<Capability>

CassandraConnectorEnabled()

public bool CassandraConnectorEnabled()

Returns

bool

CassandraConnectorOffer()

public ConnectorOffer CassandraConnectorOffer()

Returns

ConnectorOffer

ConsistencyPolicy()

public ConsistencyPolicy ConsistencyPolicy()

Returns

ConsistencyPolicy

CreateResourceAsync(CancellationToken)

public override Task<ICosmosDBAccount> CreateResourceAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ICosmosDBAccount>

DatabaseAccountOfferType()

public DatabaseAccountOfferType DatabaseAccountOfferType()

Returns

DatabaseAccountOfferType

DefaultConsistencyLevel()

public DefaultConsistencyLevel DefaultConsistencyLevel()

Returns

DefaultConsistencyLevel

DocumentEndpoint()

public string DocumentEndpoint()

Returns

string

GetCassandraKeyspace(string)

public ICassandraKeyspace GetCassandraKeyspace(string databaseName)

Parameters

databaseName string

Returns

ICassandraKeyspace

GetCassandraKeyspaceAsync(string, CancellationToken)

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

Parameters

databaseName string

cancellationToken CancellationToken

Returns

Task<ICassandraKeyspace>

GetGremlinDatabase(string)

public IGremlinDatabase GetGremlinDatabase(string databaseName)

Parameters

databaseName string

Returns

IGremlinDatabase

GetGremlinDatabaseAsync(string, CancellationToken)

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

Parameters

databaseName string

cancellationToken CancellationToken

Returns

Task<IGremlinDatabase>

GetInnerAsync(CancellationToken)

protected override Task<DatabaseAccountGetResultsInner> GetInnerAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<DatabaseAccountGetResultsInner>

GetMongoDB(string)

public IMongoDB GetMongoDB(string databaseName)

Parameters

databaseName string

Returns

IMongoDB

GetMongoDBAsync(string, CancellationToken)

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

Parameters

databaseName string

cancellationToken CancellationToken

Returns

Task<IMongoDB>

GetPrivateEndpointConnection(string)

public IPrivateEndpointConnection GetPrivateEndpointConnection(string name)

Parameters

name string

Name of private endpoint connection.

Returns

IPrivateEndpointConnection

GetPrivateEndpointConnectionAsync(string, CancellationToken)

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

Parameters

name string

Name of private endpoint connection.

cancellationToken CancellationToken

Returns

Task<IPrivateEndpointConnection>

GetPrivateLinkResource(string)

public IPrivateLinkResource GetPrivateLinkResource(string groupName)

Parameters

groupName string

Group name of private link resource.

Returns

IPrivateLinkResource

GetPrivateLinkResourceAsync(string, CancellationToken)

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

Parameters

groupName string

Group name of private link resource.

cancellationToken CancellationToken

Returns

Task<IPrivateLinkResource>

GetSqlDatabase(string)

public ISqlDatabase GetSqlDatabase(string databaseName)

Parameters

databaseName string

Database name of SQL database.

Returns

ISqlDatabase

The specific SQL database.

GetSqlDatabaseAsync(string, CancellationToken)

public 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)

public ITable GetTable(string databaseName)

Parameters

databaseName string

Returns

ITable

GetTableAsync(string, CancellationToken)

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

Parameters

databaseName string

cancellationToken CancellationToken

Returns

Task<ITable>

IPRangeFilter()

public string IPRangeFilter()

Returns

string

KeyBaseMetadataWriteAccessDisabled()

public bool KeyBaseMetadataWriteAccessDisabled()

Returns

bool

KeyVaultUri()

public string KeyVaultUri()

Returns

string

Kind()

public string Kind()

Returns

string

ListCassandraKeyspaces()

public IEnumerable<ICassandraKeyspace> ListCassandraKeyspaces()

Returns

IEnumerable<ICassandraKeyspace>

ListCassandraKeyspacesAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ICassandraKeyspace>>

ListConnectionStrings()

public IDatabaseAccountListConnectionStringsResult ListConnectionStrings()

Returns

IDatabaseAccountListConnectionStringsResult

ListConnectionStringsAsync(CancellationToken)

public Task<IDatabaseAccountListConnectionStringsResult> ListConnectionStringsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IDatabaseAccountListConnectionStringsResult>

ListGremlinDatabases()

public IEnumerable<IGremlinDatabase> ListGremlinDatabases()

Returns

IEnumerable<IGremlinDatabase>

ListGremlinDatabasesAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<IGremlinDatabase>>

ListKeys()

public IDatabaseAccountListKeysResult ListKeys()

Returns

IDatabaseAccountListKeysResult

ListKeysAsync(CancellationToken)

public Task<IDatabaseAccountListKeysResult> ListKeysAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IDatabaseAccountListKeysResult>

ListMongoDBs()

public IEnumerable<IMongoDB> ListMongoDBs()

Returns

IEnumerable<IMongoDB>

ListMongoDBsAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<IMongoDB>>

ListPrivateEndpointConnection()

public IReadOnlyDictionary<string, IPrivateEndpointConnection> ListPrivateEndpointConnection()

Returns

IReadOnlyDictionary<string, IPrivateEndpointConnection>

ListPrivateEndpointConnectionAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IReadOnlyDictionary<string, IPrivateEndpointConnection>>

ListPrivateLinkResources()

public IReadOnlyList<IPrivateLinkResource> ListPrivateLinkResources()

Returns

IReadOnlyList<IPrivateLinkResource>

ListPrivateLinkResourcesAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<IPrivateLinkResource>>

ListReadOnlyKeys()

public IDatabaseAccountListReadOnlyKeysResult ListReadOnlyKeys()

Returns

IDatabaseAccountListReadOnlyKeysResult

ListReadOnlyKeysAsync(CancellationToken)

public Task<IDatabaseAccountListReadOnlyKeysResult> ListReadOnlyKeysAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IDatabaseAccountListReadOnlyKeysResult>

ListSqlDatabases()

public IEnumerable<ISqlDatabase> ListSqlDatabases()

Returns

IEnumerable<ISqlDatabase>

ListSqlDatabasesAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ISqlDatabase>>

ListTables()

public IEnumerable<ITable> ListTables()

Returns

IEnumerable<ITable>

ListTablesAsync(CancellationToken)

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

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<ITable>>

MultipleWriteLocationsEnabled()

public bool? MultipleWriteLocationsEnabled()

Returns

bool?

OfflineRegion(Region)

public void OfflineRegion(Region region)

Parameters

region Region

OfflineRegionAsync(Region, CancellationToken)

public Task OfflineRegionAsync(Region region, CancellationToken cancellationToken = default)

Parameters

region Region

cancellationToken CancellationToken

Returns

Task

OnlineRegion(Region)

public void OnlineRegion(Region region)

Parameters

region Region

OnlineRegionAsync(Region, CancellationToken)

public Task OnlineRegionAsync(Region region, CancellationToken cancellationToken = default)

Parameters

region Region

cancellationToken CancellationToken

Returns

Task

ReadableReplications()

public IReadOnlyList<Location> ReadableReplications()

Returns

IReadOnlyList<Location>

RefreshAsync(CancellationToken)

public override Task<ICosmosDBAccount> RefreshAsync(CancellationToken cancellation = default)

Parameters

cancellation CancellationToken

Returns

Task<ICosmosDBAccount>

RegenerateKey(string)

public void RegenerateKey(string keyKind)

Parameters

keyKind string

RegenerateKeyAsync(string, CancellationToken)

public Task RegenerateKeyAsync(string keyKind, CancellationToken cancellationToken = default)

Parameters

keyKind string

cancellationToken CancellationToken

Returns

Task

VirtualNetoworkFilterEnabled()

public bool VirtualNetoworkFilterEnabled()

Returns

bool

VirtualNetworkRules()

public IReadOnlyList<VirtualNetworkRule> VirtualNetworkRules()

Returns

IReadOnlyList<VirtualNetworkRule>

WithAutomaticFailoverEnabled(bool)

public CosmosDBAccountImpl WithAutomaticFailoverEnabled(bool enabled)

Parameters

enabled bool

Returns

CosmosDBAccountImpl

WithBoundedStalenessConsistency(long, int)

public CosmosDBAccountImpl WithBoundedStalenessConsistency(long maxStalenessPrefix, int maxIntervalInSeconds)

Parameters

maxStalenessPrefix long

maxIntervalInSeconds int

Returns

CosmosDBAccountImpl

WithCassandraConnector(ConnectorOffer)

public CosmosDBAccountImpl WithCassandraConnector(ConnectorOffer connectorOffer)

Parameters

connectorOffer ConnectorOffer

Returns

CosmosDBAccountImpl

WithDataModelAzureTable()

public CosmosDBAccountImpl WithDataModelAzureTable()

Returns

CosmosDBAccountImpl

WithDataModelCassandra()

public CosmosDBAccountImpl WithDataModelCassandra()

Returns

CosmosDBAccountImpl

WithDataModelGremlin()

public CosmosDBAccountImpl WithDataModelGremlin()

Returns

CosmosDBAccountImpl

WithDataModelMongoDB()

public CosmosDBAccountImpl WithDataModelMongoDB()

Returns

CosmosDBAccountImpl

WithDataModelSql()

public CosmosDBAccountImpl WithDataModelSql()

Returns

CosmosDBAccountImpl

WithDefaultWriteReplication()

public CosmosDBAccountImpl WithDefaultWriteReplication()

Returns

CosmosDBAccountImpl

WithDisableKeyBaseMetadataWriteAccess(bool)

public CosmosDBAccountImpl WithDisableKeyBaseMetadataWriteAccess(bool disabled)

Parameters

disabled bool

Returns

CosmosDBAccountImpl

WithEventualConsistency()

public CosmosDBAccountImpl WithEventualConsistency()

Returns

CosmosDBAccountImpl

WithIpRangeFilter(string)

public CosmosDBAccountImpl WithIpRangeFilter(string ipRangeFilter)

Parameters

ipRangeFilter string

Returns

CosmosDBAccountImpl

WithKeyVault(string)

public CosmosDBAccountImpl WithKeyVault(string keyVaultUri)

Parameters

keyVaultUri string

Returns

CosmosDBAccountImpl

WithKind(DatabaseAccountKind, params Capability[])

public CosmosDBAccountImpl WithKind(DatabaseAccountKind kind, params Capability[] capabilities)

Parameters

kind DatabaseAccountKind

capabilities Capability[]

Returns

CosmosDBAccountImpl

WithKind(string)

public CosmosDBAccountImpl WithKind(string kind)

Parameters

kind string

Returns

CosmosDBAccountImpl

WithMultipleWriteLocationsEnabled(bool)

public CosmosDBAccountImpl WithMultipleWriteLocationsEnabled(bool enabled)

Parameters

enabled bool

Returns

CosmosDBAccountImpl

WithReadReplication(Region, bool?)

public CosmosDBAccountImpl WithReadReplication(Region region, bool? isZoneRedundant)

Parameters

region Region

isZoneRedundant bool?

Returns

CosmosDBAccountImpl

WithSessionConsistency()

public CosmosDBAccountImpl WithSessionConsistency()

Returns

CosmosDBAccountImpl

WithStrongConsistency()

public CosmosDBAccountImpl WithStrongConsistency()

Returns

CosmosDBAccountImpl

WithVirtualNetworkFilterEnabled(bool)

public CosmosDBAccountImpl WithVirtualNetworkFilterEnabled(bool enable)

Parameters

enable bool

Returns

CosmosDBAccountImpl

WithVirtualNetworkRule(string, string, bool?)

public CosmosDBAccountImpl WithVirtualNetworkRule(string virtualNetworkId, string subnetName, bool? ignoreMissingVNetServiceEndpoint)

Parameters

virtualNetworkId string

subnetName string

ignoreMissingVNetServiceEndpoint bool?

Returns

CosmosDBAccountImpl

WithVirtualNetworkRules(IList<VirtualNetworkRule>)

public CosmosDBAccountImpl WithVirtualNetworkRules(IList<VirtualNetworkRule> virtualNetworkRules)

Parameters

virtualNetworkRules IList<VirtualNetworkRule>

Returns

CosmosDBAccountImpl

WithWriteReplication(Region, bool?)

public CosmosDBAccountImpl WithWriteReplication(Region region, bool? isZoneRedundant)

Parameters

region Region

isZoneRedundant bool?

Returns

CosmosDBAccountImpl

WithoutAllReplications()

public CosmosDBAccountImpl WithoutAllReplications()

Returns

CosmosDBAccountImpl

WithoutCassandraConnector()

public CosmosDBAccountImpl WithoutCassandraConnector()

Returns

CosmosDBAccountImpl

WithoutCassandraKeyspace(string)

public CosmosDBAccountImpl WithoutCassandraKeyspace(string name)

Parameters

name string

Returns

CosmosDBAccountImpl

WithoutGremlinDatabase(string)

public CosmosDBAccountImpl WithoutGremlinDatabase(string name)

Parameters

name string

Returns

CosmosDBAccountImpl

WithoutKeyVault()

public CosmosDBAccountImpl WithoutKeyVault()

Returns

CosmosDBAccountImpl

WithoutMongoDB(string)

public CosmosDBAccountImpl WithoutMongoDB(string name)

Parameters

name string

Returns

CosmosDBAccountImpl

WithoutPrivateEndpointConnection(string)

public CosmosDBAccountImpl WithoutPrivateEndpointConnection(string name)

Parameters

name string

Returns

CosmosDBAccountImpl

WithoutReadReplication(Region)

public CosmosDBAccountImpl WithoutReadReplication(Region region)

Parameters

region Region

Returns

CosmosDBAccountImpl

WithoutSqlDatabase(string)

public CosmosDBAccountImpl WithoutSqlDatabase(string name)

Parameters

name string

Returns

CosmosDBAccountImpl

WithoutTable(string)

public CosmosDBAccountImpl WithoutTable(string name)

Parameters

name string

Returns

CosmosDBAccountImpl

WithoutVirtualNetworkRule(string, string)

public CosmosDBAccountImpl WithoutVirtualNetworkRule(string virtualNetworkId, string subnetName)

Parameters

virtualNetworkId string

subnetName string

Returns

CosmosDBAccountImpl

WritableReplications()

public IReadOnlyList<Location> WritableReplications()

Returns

IReadOnlyList<Location>