com.azure.resourcemanager.cosmos.models

Interface CosmosDBAccount

All Superinterfaces:

GroupableResource<CosmosManager,DatabaseAccountGetResultsInner>, HasId, HasInnerModel<InnerT>, HasManager<TManager>, HasName, HasResourceGroup, Indexable, Refreshable<CosmosDBAccount>, Resource, Updatable<CosmosDBAccount.Update>

public interface CosmosDBAccount
extends GroupableResource<CosmosManager,DatabaseAccountGetResultsInner>, Refreshable<CosmosDBAccount>, Updatable<CosmosDBAccount.Update>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CosmosDBAccount.Definition Grouping of cosmos db definition stages.
static interface	CosmosDBAccount.DefinitionStages Grouping of cosmos db definition stages.
static interface	CosmosDBAccount.Update Grouping of cosmos db update stages.
static interface	CosmosDBAccount.UpdateStages Grouping of cosmos db update stages.

Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Field Summary

Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

DUMMY

Method Summary

Modifier and Type	Method and Description
List<Capability>	capabilities()
boolean	cassandraConnectorEnabled()
ConnectorOffer	cassandraConnectorOffer()
ConsistencyPolicy	consistencyPolicy()
DatabaseAccountOfferType	databaseAccountOfferType()
DefaultConsistencyLevel	defaultConsistencyLevel()
String	documentEndpoint()
PrivateEndpointConnection	getPrivateEndpointConnection(String name)
Mono<PrivateEndpointConnection>	getPrivateEndpointConnectionAsync(String name)
PrivateLinkResource	getPrivateLinkResource(String groupName)
Mono<PrivateLinkResource>	getPrivateLinkResourceAsync(String groupName)
String	ipRangeFilter()
boolean	keyBasedMetadataWriteAccessDisabled()
DatabaseAccountKind	kind()
DatabaseAccountListConnectionStringsResult	listConnectionStrings()
Mono<DatabaseAccountListConnectionStringsResult>	listConnectionStringsAsync()
DatabaseAccountListKeysResult	listKeys()
Mono<DatabaseAccountListKeysResult>	listKeysAsync()
Map<String,PrivateEndpointConnection>	listPrivateEndpointConnection()
Mono<Map<String,PrivateEndpointConnection>>	listPrivateEndpointConnectionAsync()
List<PrivateLinkResource>	listPrivateLinkResources()
com.azure.core.http.rest.PagedFlux<PrivateLinkResource>	listPrivateLinkResourcesAsync()
DatabaseAccountListReadOnlyKeysResult	listReadOnlyKeys()
Mono<DatabaseAccountListReadOnlyKeysResult>	listReadOnlyKeysAsync()
List<SqlDatabase>	listSqlDatabases()
com.azure.core.http.rest.PagedFlux<SqlDatabase>	listSqlDatabasesAsync()
boolean	multipleWriteLocationsEnabled()
void	offlineRegion(com.azure.core.management.Region region) It takes offline the specified region for the current Azure Cosmos DB database account.
Mono<Void>	offlineRegionAsync(com.azure.core.management.Region region) Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account.
void	onlineRegion(com.azure.core.management.Region region) It brings online the specified region for the current Azure Cosmos DB database account.
Mono<Void>	onlineRegionAsync(com.azure.core.management.Region region) Asynchronously it brings online the specified region for the current Azure Cosmos DB database account.
List<Location>	readableReplications()
void	regenerateKey(KeyKind keyKind)
Mono<Void>	regenerateKeyAsync(KeyKind keyKind)
List<VirtualNetworkRule>	virtualNetworkRules()
List<Location>	writableReplications()

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Method Detail

kind

DatabaseAccountKind kind()

Returns:

indicates the type of database account

documentEndpoint

String documentEndpoint()

Returns:

the connection endpoint for the CosmosDB database account

databaseAccountOfferType

DatabaseAccountOfferType databaseAccountOfferType()

Returns:

the offer type for the CosmosDB database account

ipRangeFilter

String ipRangeFilter()

Returns:

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

consistencyPolicy

ConsistencyPolicy consistencyPolicy()

Returns:

the consistency policy for the CosmosDB database account

defaultConsistencyLevel

DefaultConsistencyLevel defaultConsistencyLevel()

Returns:

the default consistency level for the CosmosDB database account

writableReplications

List<Location> writableReplications()

Returns:

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

readableReplications

List<Location> readableReplications()

Returns:

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

listKeys

DatabaseAccountListKeysResult listKeys()

Returns:

the access keys for the specified Azure CosmosDB database account

listKeysAsync

Mono<DatabaseAccountListKeysResult> listKeysAsync()

Returns:

the access keys for the specified Azure CosmosDB database account

listReadOnlyKeys

DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys()

Returns:

the read-only access keys for the specified Azure CosmosDB database account

listReadOnlyKeysAsync

Mono<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync()

Returns:

the read-only access keys for the specified Azure CosmosDB database account

listConnectionStrings

DatabaseAccountListConnectionStringsResult listConnectionStrings()

Returns:

the connection strings for the specified Azure CosmosDB database account

listConnectionStringsAsync

Mono<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync()

Returns:

the connection strings for the specified Azure CosmosDB database account

listSqlDatabases

List<SqlDatabase> listSqlDatabases()

Returns:

the list of Azure Cosmos DB SQL databases

listSqlDatabasesAsync

com.azure.core.http.rest.PagedFlux<SqlDatabase> listSqlDatabasesAsync()

Returns:

the list of Azure Cosmos DB SQL databases

multipleWriteLocationsEnabled

boolean multipleWriteLocationsEnabled()

Returns:

whether write is enabled for multiple locations or not

cassandraConnectorEnabled

boolean cassandraConnectorEnabled()

Returns:

whether cassandra connector is enabled or not.

cassandraConnectorOffer

ConnectorOffer cassandraConnectorOffer()

Returns:

the current cassandra connector offer.

keyBasedMetadataWriteAccessDisabled

boolean keyBasedMetadataWriteAccessDisabled()

Returns:

whether metadata write access is disabled or not.

listPrivateLinkResourcesAsync

com.azure.core.http.rest.PagedFlux<PrivateLinkResource> listPrivateLinkResourcesAsync()

Returns:

all private link resources in the account.

listPrivateLinkResources

List<PrivateLinkResource> listPrivateLinkResources()

Returns:

all private link resources in the account.

getPrivateLinkResourceAsync

Mono<PrivateLinkResource> getPrivateLinkResourceAsync(String groupName)

Parameters:

groupName - group name of private link resource

Returns:

the specific private link resource group

getPrivateLinkResource

PrivateLinkResource getPrivateLinkResource(String groupName)

Parameters:

groupName - group name of private link resource

Returns:

the specific private link resource group

listPrivateEndpointConnectionAsync

Mono<Map<String,PrivateEndpointConnection>> listPrivateEndpointConnectionAsync()

Returns:

all private endpoint connection in the account.

listPrivateEndpointConnection

Map<String,PrivateEndpointConnection> listPrivateEndpointConnection()

Returns:

all private endpoint connection in the account.

getPrivateEndpointConnectionAsync

Mono<PrivateEndpointConnection> getPrivateEndpointConnectionAsync(String name)

Parameters:

name - name of private endpoint connection

Returns:

the specific private endpoint connection

getPrivateEndpointConnection

PrivateEndpointConnection getPrivateEndpointConnection(String name)

Parameters:

name - name of private endpoint connection

Returns:

the specific private endpoint connection

capabilities

List<Capability> capabilities()

Returns:

a list that contains the Cosmos DB capabilities

virtualNetworkRules

List<VirtualNetworkRule> virtualNetworkRules()

Returns:

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

offlineRegion

void offlineRegion(com.azure.core.management.Region region)

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

Parameters:

region - Cosmos DB region

offlineRegionAsync

Mono<Void> offlineRegionAsync(com.azure.core.management.Region region)

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

Parameters:

region - Cosmos DB region

Returns:

a representation of the deferred computation of this call

onlineRegion

void onlineRegion(com.azure.core.management.Region region)

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

Parameters:

region - Cosmos DB region

onlineRegionAsync

Mono<Void> onlineRegionAsync(com.azure.core.management.Region region)

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

Parameters:

region - Cosmos DB region

Returns:

a representation of the deferred computation of this call

regenerateKey

void regenerateKey(KeyKind keyKind)

Parameters:

keyKind - the key kind

regenerateKeyAsync

Mono<Void> regenerateKeyAsync(KeyKind keyKind)

Parameters:

keyKind - the key kind

Returns:

a representation of the deferred computation of this call