Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*/
package com.microsoft.azure.management.cosmosdb;
import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountsInner;
import com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import rx.Observable;
import java.util.List;
Entry point to Cosmos DB management API.
/**
* Entry point to Cosmos DB management API.
*/
@Fluent()
@Beta(Beta.SinceVersion.V1_2_0)
public interface CosmosDBAccounts extends
SupportsCreating<CosmosDBAccount.DefinitionStages.Blank>,
HasManager<CosmosDBManager>,
HasInner<DatabaseAccountsInner>,
SupportsBatchCreation<CosmosDBAccount>,
SupportsGettingById<CosmosDBAccount>,
SupportsDeletingById,
SupportsDeletingByResourceGroup,
SupportsListing<CosmosDBAccount>,
SupportsListingByResourceGroup<CosmosDBAccount>,
SupportsGettingByResourceGroup<CosmosDBAccount> {
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.
Params: - groupName – the group name
- accountName – the account name
- failoverPolicies – the list of failover policies
/**
* 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.
* @param groupName the group name
* @param accountName the account name
* @param failoverPolicies the list of failover policies
*/
void failoverPriorityChange(String groupName, String accountName, List<Location> failoverPolicies);
Lists the access keys for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
Returns: a list of keys
/**
* Lists the access keys for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @return a list of keys
*/
DatabaseAccountListKeysResult listKeys(String groupName, String accountName);
Lists the read-only access keys for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
Returns: a list of keys
/**
* Lists the read-only access keys for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @return a list of keys
*/
DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys(String groupName, String accountName);
Lists the connection strings for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
Returns: a list of connection strings
/**
* Lists the connection strings for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @return a list of connection strings
*/
DatabaseAccountListConnectionStringsResult listConnectionStrings(String groupName, String accountName);
Regenerates an access key for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
- keyKind – the key kind
/**
* Regenerates an access key for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @param keyKind the key kind
*/
void regenerateKey(String groupName, String accountName, KeyKind keyKind);
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.
Params: - groupName – the group name
- accountName – the account name
- failoverPolicies – the list of failover policies
Returns: the ServiceResponse object if successful.
/**
* 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.
* @param groupName the group name
* @param accountName the account name
* @param failoverPolicies the list of failover policies
* @return the ServiceResponse object if successful.
*/
Observable<Void> failoverPriorityChangeAsync(String groupName, String accountName, List<Location> failoverPolicies);
Lists the access keys for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
Returns: a list of keys
/**
* Lists the access keys for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @return a list of keys
*/
Observable<DatabaseAccountListKeysResult> listKeysAsync(String groupName, String accountName);
Lists the read-only access keys for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
Returns: a list of keys
/**
* Lists the read-only access keys for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @return a list of keys
*/
Observable<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync(String groupName, String accountName);
Lists the connection strings for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
Returns: a list of connection strings
/**
* Lists the connection strings for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @return a list of connection strings
*/
Observable<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync(String groupName, String accountName);
Regenerates an access key for the specified Azure CosmosDB database account.
Params: - groupName – the group name
- accountName – the account name
- keyKind – the key kind
Returns: the ServiceResponse object if successful.
/**
* Regenerates an access key for the specified Azure CosmosDB database account.
* @param groupName the group name
* @param accountName the account name
* @param keyKind the key kind
* @return the ServiceResponse object if successful.
*/
Observable<Void> regenerateKeyAsync(String groupName, String accountName, KeyKind keyKind);
}