Share via

CosmosDBAccounts Interface

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1

Implements

SupportsDeletingByResourceGroup SupportsGettingById<CosmosDBAccount> SupportsGettingByResourceGroup<CosmosDBAccount> SupportsListingByResourceGroup<CosmosDBAccount> HasManager<CosmosManager> SupportsBatchCreation<CosmosDBAccount> SupportsCreating<Blank> SupportsDeletingById SupportsListing<CosmosDBAccount>

public interface CosmosDBAccounts
extends SupportsCreating<Blank>, HasManager<CosmosManager>, SupportsBatchCreation<CosmosDBAccount>, SupportsGettingById<CosmosDBAccount>, SupportsDeletingById, SupportsDeletingByResourceGroup, SupportsListing<CosmosDBAccount>, SupportsListingByResourceGroup<CosmosDBAccount>, SupportsGettingByResourceGroup<CosmosDBAccount>

Entry point to Cosmos DB management API.

Method Summary

Modifier and Type Method and Description
abstract void failoverPriorityChange(String groupName, String accountName, List<Location> failoverPolicies)

Changes the failover priority for the Azure CosmosDB database account.
abstract Mono<Void> failoverPriorityChangeAsync(String groupName, String accountName, List<Location> failoverPolicies)

Changes the failover priority for the Azure CosmosDB database account.
abstract DatabaseAccountListConnectionStringsResult listConnectionStrings(String groupName, String accountName)

Lists the connection strings for the specified Azure CosmosDB database account.
abstract Mono<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync(String groupName, String accountName)

Lists the connection strings for the specified Azure CosmosDB database account.
abstract DatabaseAccountListKeysResult listKeys(String groupName, String accountName)

Lists the access keys for the specified Azure CosmosDB database account.
abstract Mono<DatabaseAccountListKeysResult> listKeysAsync(String groupName, String accountName)

Lists the access keys for the specified Azure CosmosDB database account.
abstract DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys(String groupName, String accountName)

Lists the read-only access keys for the specified Azure CosmosDB database account.
abstract Mono<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync(String groupName, String accountName)

Lists the read-only access keys for the specified Azure CosmosDB database account.
abstract void regenerateKey(String groupName, String accountName, KeyKind keyKind)

Regenerates an access key for the specified Azure CosmosDB database account.
abstract Mono<Void> regenerateKeyAsync(String groupName, String accountName, KeyKind keyKind)

Regenerates an access key for the specified Azure CosmosDB database account.

Method Details

failoverPriorityChange

public abstract void failoverPriorityChange(String groupName, String accountName, List failoverPolicies)

Changes the failover priority for the Azure CosmosDB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

Parameters:

groupName - the group name
accountName - the account name
failoverPolicies - the list of failover policies

failoverPriorityChangeAsync

public abstract Mono failoverPriorityChangeAsync(String groupName, String accountName, List failoverPolicies)

Changes the failover priority for the Azure CosmosDB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

Parameters:

groupName - the group name
accountName - the account name
failoverPolicies - the list of failover policies

Returns:

the ServiceResponse object if successful.

listConnectionStrings

public abstract DatabaseAccountListConnectionStringsResult listConnectionStrings(String groupName, String accountName)

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

Parameters:

groupName - the group name
accountName - the account name

Returns:

a list of connection strings

listConnectionStringsAsync

public abstract Mono listConnectionStringsAsync(String groupName, String accountName)

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

Parameters:

groupName - the group name
accountName - the account name

Returns:

a list of connection strings

listKeys

public abstract DatabaseAccountListKeysResult listKeys(String groupName, String accountName)

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

Parameters:

groupName - the group name
accountName - the account name

Returns:

a list of keys

listKeysAsync

public abstract Mono listKeysAsync(String groupName, String accountName)

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

Parameters:

groupName - the group name
accountName - the account name

Returns:

a list of keys

listReadOnlyKeys

public abstract DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys(String groupName, String accountName)

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

Parameters:

groupName - the group name
accountName - the account name

Returns:

a list of keys

listReadOnlyKeysAsync

public abstract Mono listReadOnlyKeysAsync(String groupName, String accountName)

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

Parameters:

groupName - the group name
accountName - the account name

Returns:

a list of keys

regenerateKey

public abstract void regenerateKey(String groupName, String accountName, KeyKind keyKind)

Regenerates an access key for the specified Azure CosmosDB database account.

Parameters:

groupName - the group name
accountName - the account name
keyKind - the key kind

regenerateKeyAsync

public abstract Mono regenerateKeyAsync(String groupName, String accountName, KeyKind keyKind)

Regenerates an access key for the specified Azure CosmosDB database account.

Parameters:

groupName - the group name
accountName - the account name
keyKind - the key kind

Returns:

the ServiceResponse object if successful.

Applies to