CosmosDBAccount Interface

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.47.0

Implements

GroupableResource<CosmosManager,DatabaseAccountGetResultsInner> SupportsUpdatingPrivateEndpointConnection Refreshable<CosmosDBAccount> Updatable<Update>

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

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

Method Summary

Modifier and Type	Method and Description
abstract List<Capability>	capabilities() Gets a list that contains the Cosmos DB capabilities.
abstract boolean	cassandraConnectorEnabled() Checks whether cassandra connector is enabled.
abstract ConnectorOffer	cassandraConnectorOffer() Gets the current cassandra connector offer.
abstract ConsistencyPolicy	consistencyPolicy() Gets the consistency policy for the CosmosDB database account.
abstract DatabaseAccountOfferType	databaseAccountOfferType() Gets the offer type for the CosmosDB database account.
abstract DefaultConsistencyLevel	defaultConsistencyLevel() Gets the default consistency level for the CosmosDB database account.
abstract String	documentEndpoint() Gets the connection endpoint for the CosmosDB database account.
abstract PrivateEndpointConnection	getPrivateEndpointConnection(String name) Gets the specific private endpoint connection.
abstract Mono<PrivateEndpointConnection>	getPrivateEndpointConnectionAsync(String name) Gets the specific private endpoint connection.
abstract PrivateLinkResource	getPrivateLinkResource(String groupName) Gets the specific private link resource.
abstract Mono<PrivateLinkResource>	getPrivateLinkResourceAsync(String groupName) Gets the specific private link resource.
abstract String	ipRangeFilter() Deprecated use ipRules() Gets specifies the set of IP addresses or IP address ranges in CIDR form.
abstract List<IpAddressOrRange>	ipRules() Gets specifies the set of IP addresses or IP address ranges in CIDR form.
abstract boolean	keyBasedMetadataWriteAccessDisabled() Checks whether metadata write access is disabled.
abstract DatabaseAccountKind	kind() Gets the type of database account.
abstract DatabaseAccountListConnectionStringsResult	listConnectionStrings() Gets the connection strings for the specified Azure CosmosDB database account.
abstract Mono<DatabaseAccountListConnectionStringsResult>	listConnectionStringsAsync() Gets the connection strings for the specified Azure CosmosDB database account.
abstract DatabaseAccountListKeysResult	listKeys() Gets the access keys for the specified Azure CosmosDB database account.
abstract Mono<DatabaseAccountListKeysResult>	listKeysAsync() Gets the access keys for the specified Azure CosmosDB database account.
abstract Map<String,PrivateEndpointConnection>	listPrivateEndpointConnection() Gets all private endpoint connection in the account.
abstract Mono<Map<String,PrivateEndpointConnection>>	listPrivateEndpointConnectionAsync() Gets all private endpoint connection in the account.
abstract List<PrivateLinkResource>	listPrivateLinkResources() Gets all private link resources in the account.
abstract PagedFlux<PrivateLinkResource>	listPrivateLinkResourcesAsync() Gets all private link resources in the account.
abstract DatabaseAccountListReadOnlyKeysResult	listReadOnlyKeys() Gets the read-only access keys for the specified Azure CosmosDB database account.
abstract Mono<DatabaseAccountListReadOnlyKeysResult>	listReadOnlyKeysAsync() Gets the read-only access keys for the specified Azure CosmosDB database account.
abstract List<SqlDatabase>	listSqlDatabases() Gets the list of Azure Cosmos DB SQL databases.
abstract PagedFlux<SqlDatabase>	listSqlDatabasesAsync() Gets the list of Azure Cosmos DB SQL databases.
abstract boolean	multipleWriteLocationsEnabled() Checks whether write is enabled for multiple locations.
abstract void	offlineRegion(Region region) It takes offline the specified region for the current Azure Cosmos DB database account.
abstract Mono<Void>	offlineRegionAsync(Region region) Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account.
abstract void	onlineRegion(Region region) It brings online the specified region for the current Azure Cosmos DB database account.
abstract Mono<Void>	onlineRegionAsync(Region region) Asynchronously it brings online the specified region for the current Azure Cosmos DB database account.
abstract PublicNetworkAccess	publicNetworkAccess() Whether the CosmosDB account can be accessed from public network.
abstract List<Location>	readableReplications() Gets an array that contains the readable georeplication locations enabled for the CosmosDB account.
abstract void	regenerateKey(KeyKind keyKind) Regenerates secret keys.
abstract Mono<Void>	regenerateKeyAsync(KeyKind keyKind) A deferred emitter that regenerates secret keys.
abstract List<VirtualNetworkRule>	virtualNetworkRules() Gets a list that contains the Cosmos DB Virtual Network ACL Rules.
abstract List<Location>	writableReplications() Gets an array that contains the writable georeplication locations enabled for the CosmosDB account.

Method Details

capabilities

public abstract List capabilities()

Gets a list that contains the Cosmos DB capabilities.

Returns:

a list that contains the Cosmos DB capabilities

cassandraConnectorEnabled

public abstract boolean cassandraConnectorEnabled()

Checks whether cassandra connector is enabled.

Returns:

whether cassandra connector is enabled or not.

cassandraConnectorOffer

public abstract ConnectorOffer cassandraConnectorOffer()

Gets the current cassandra connector offer.

Returns:

the current cassandra connector offer.

consistencyPolicy

public abstract ConsistencyPolicy consistencyPolicy()

Gets the consistency policy for the CosmosDB database account.

Returns:

the consistency policy for the CosmosDB database account

databaseAccountOfferType

public abstract DatabaseAccountOfferType databaseAccountOfferType()

Gets the offer type for the CosmosDB database account.

Returns:

the offer type for the CosmosDB database account

defaultConsistencyLevel

public abstract DefaultConsistencyLevel defaultConsistencyLevel()

Gets the default consistency level for the CosmosDB database account.

Returns:

the default consistency level for the CosmosDB database account

documentEndpoint

public abstract String documentEndpoint()

Gets the connection endpoint for the CosmosDB database account.

Returns:

the connection endpoint for the CosmosDB database account

getPrivateEndpointConnection

public abstract PrivateEndpointConnection getPrivateEndpointConnection(String name)

Gets the specific private endpoint connection.

Parameters:

name - name of private endpoint connection

Returns:

the specific private endpoint connection

getPrivateEndpointConnectionAsync

public abstract Mono getPrivateEndpointConnectionAsync(String name)

Gets the specific private endpoint connection.

Parameters:

name - name of private endpoint connection

Returns:

the specific private endpoint connection

getPrivateLinkResource

public abstract PrivateLinkResource getPrivateLinkResource(String groupName)

Gets the specific private link resource.

Parameters:

groupName - group name of private link resource

Returns:

the specific private link resource

getPrivateLinkResourceAsync

public abstract Mono getPrivateLinkResourceAsync(String groupName)

Gets the specific private link resource.

Parameters:

groupName - group name of private link resource

Returns:

the specific private link resource

ipRangeFilter

@Deprecated
public abstract String ipRangeFilter()

Deprecated

use ipRules()

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

Returns:

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

ipRules

public abstract List ipRules()

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

Returns:

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

keyBasedMetadataWriteAccessDisabled

public abstract boolean keyBasedMetadataWriteAccessDisabled()

Checks whether metadata write access is disabled.

Returns:

whether metadata write access is disabled or not.

kind

public abstract DatabaseAccountKind kind()

Gets the type of database account.

Returns:

indicates the type of database account

listConnectionStrings

public abstract DatabaseAccountListConnectionStringsResult listConnectionStrings()

Gets the connection strings for the specified Azure CosmosDB database account.

Returns:

the connection strings for the specified Azure CosmosDB database account

listConnectionStringsAsync

public abstract Mono listConnectionStringsAsync()

Gets the connection strings for the specified Azure CosmosDB database account.

Returns:

the connection strings for the specified Azure CosmosDB database account

listKeys

public abstract DatabaseAccountListKeysResult listKeys()

Gets the access keys for the specified Azure CosmosDB database account.

Returns:

the access keys for the specified Azure CosmosDB database account

listKeysAsync

public abstract Mono listKeysAsync()

Gets the access keys for the specified Azure CosmosDB database account.

Returns:

the access keys for the specified Azure CosmosDB database account

listPrivateEndpointConnection

public abstract Map listPrivateEndpointConnection()

Gets all private endpoint connection in the account.

Returns:

all private endpoint connection in the account.

listPrivateEndpointConnectionAsync

public abstract Mono> listPrivateEndpointConnectionAsync()

Gets all private endpoint connection in the account.

Returns:

all private endpoint connection in the account.

listPrivateLinkResources

public abstract List listPrivateLinkResources()

Gets all private link resources in the account.

Returns:

all private link resources in the account.

listPrivateLinkResourcesAsync

public abstract PagedFlux listPrivateLinkResourcesAsync()

Gets all private link resources in the account.

Returns:

all private link resources in the account.

listReadOnlyKeys

public abstract DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys()

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

Returns:

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

listReadOnlyKeysAsync

public abstract Mono listReadOnlyKeysAsync()

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

Returns:

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

listSqlDatabases

public abstract List listSqlDatabases()

Gets the list of Azure Cosmos DB SQL databases.

Returns:

the list of Azure Cosmos DB SQL databases

listSqlDatabasesAsync

public abstract PagedFlux listSqlDatabasesAsync()

Gets the list of Azure Cosmos DB SQL databases.

Returns:

the list of Azure Cosmos DB SQL databases

multipleWriteLocationsEnabled

public abstract boolean multipleWriteLocationsEnabled()

Checks whether write is enabled for multiple locations.

Returns:

whether write is enabled for multiple locations or not

offlineRegion

public abstract void offlineRegion(Region region)

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

Parameters:

region - Cosmos DB region

offlineRegionAsync

public abstract Mono offlineRegionAsync(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

public abstract void onlineRegion(Region region)

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

Parameters:

region - Cosmos DB region

onlineRegionAsync

public abstract Mono onlineRegionAsync(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

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the CosmosDB account can be accessed from public network.

Returns:

whether the CosmosDB account can be accessed from public network.

readableReplications

public abstract List readableReplications()

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

Returns:

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

regenerateKey

public abstract void regenerateKey(KeyKind keyKind)

Regenerates secret keys.

Parameters:

keyKind - the key kind

regenerateKeyAsync

public abstract Mono regenerateKeyAsync(KeyKind keyKind)

A deferred emitter that regenerates secret keys.

Parameters:

keyKind - the key kind

Returns:

a representation of the deferred computation of this call

virtualNetworkRules

public abstract List virtualNetworkRules()

Gets a list that contains the Cosmos DB Virtual Network ACL Rules.

Returns:

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

writableReplications

public abstract List writableReplications()

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

Returns:

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