com.azure.resourcemanager.cosmos.models

Interface CosmosDBAccounts

All Superinterfaces:

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

public interface CosmosDBAccounts
extends SupportsCreating<CosmosDBAccount.DefinitionStages.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
void	failoverPriorityChange(String groupName, String accountName, List<Location> failoverPolicies) Changes the failover priority for the Azure CosmosDB database account.
Mono<Void>	failoverPriorityChangeAsync(String groupName, String accountName, List<Location> failoverPolicies) Changes the failover priority for the Azure CosmosDB database account.
DatabaseAccountListConnectionStringsResult	listConnectionStrings(String groupName, String accountName) Lists the connection strings for the specified Azure CosmosDB database account.
Mono<DatabaseAccountListConnectionStringsResult>	listConnectionStringsAsync(String groupName, String accountName) Lists the connection strings for the specified Azure CosmosDB database account.
DatabaseAccountListKeysResult	listKeys(String groupName, String accountName) Lists the access keys for the specified Azure CosmosDB database account.
Mono<DatabaseAccountListKeysResult>	listKeysAsync(String groupName, String accountName) Lists the access keys for the specified Azure CosmosDB database account.
DatabaseAccountListReadOnlyKeysResult	listReadOnlyKeys(String groupName, String accountName) Lists the read-only access keys for the specified Azure CosmosDB database account.
Mono<DatabaseAccountListReadOnlyKeysResult>	listReadOnlyKeysAsync(String groupName, String accountName) Lists the read-only access keys for the specified Azure CosmosDB database account.
void	regenerateKey(String groupName, String accountName, KeyKind keyKind) Regenerates an access key for the specified Azure CosmosDB database account.
Mono<Void>	regenerateKeyAsync(String groupName, String accountName, KeyKind keyKind) Regenerates an access key for the specified Azure CosmosDB database account.

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating

define

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

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsBatchCreation

create, create, createAsync, createAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById

getById, getByIdAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById

deleteById, deleteByIdAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup

deleteByResourceGroup, deleteByResourceGroupAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing

list, listAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

listByResourceGroup, listByResourceGroupAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup

getByResourceGroup, getByResourceGroupAsync

Method Detail

failoverPriorityChange

void failoverPriorityChange(String groupName,
                            String accountName,
                            List<Location> 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

listKeys

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

listReadOnlyKeys

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

listConnectionStrings

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

regenerateKey

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

failoverPriorityChangeAsync

Mono<Void> failoverPriorityChangeAsync(String groupName,
                                       String accountName,
                                       List<Location> 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.

listKeysAsync

Mono<DatabaseAccountListKeysResult> 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

listReadOnlyKeysAsync

Mono<DatabaseAccountListReadOnlyKeysResult> 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

listConnectionStringsAsync

Mono<DatabaseAccountListConnectionStringsResult> 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

regenerateKeyAsync

Mono<Void> 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.