DatabaseAccountsOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a DatabaseAccounts operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginFailoverPriorityChange
beginFailoverPriorityChangeAndWait
beginOfflineRegion
beginOfflineRegionAndWait
beginOnlineRegion
beginOnlineRegionAndWait
beginRegenerateKey
beginRegenerateKeyAndWait
beginUpdate
beginUpdateAndWait
checkNameExists	Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.
createOrUpdate	Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
delete
failoverPriorityChange	Changes the failover priority for the Azure Cosmos DB 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.
get	Retrieves the properties of an existing Azure Cosmos DB database account.
getReadOnlyKeys	Lists the read-only access keys for the specified Azure Cosmos DB database account.
list	Lists all the Azure Cosmos DB database accounts available under the subscription.
listByResourceGroup	Lists all the Azure Cosmos DB database accounts available under the given resource group.
listConnectionStrings	Lists the connection strings for the specified Azure Cosmos DB database account.
listKeys	Lists the access keys for the specified Azure Cosmos DB database account.
listMetricDefinitions	Retrieves metric definitions for the given database account.
listMetrics	Retrieves the metrics determined by the given filter for the given database account.
listReadOnlyKeys	Lists the read-only access keys for the specified Azure Cosmos DB database account.
listUsages	Retrieves the usages (most recent data) for the given database account.
offlineRegion	Offline the specified region for the specified Azure Cosmos DB database account.
onlineRegion	Online the specified region for the specified Azure Cosmos DB database account.
regenerateKey	Regenerates an access key for the specified Azure Cosmos DB database account.
update	Updates the properties of an existing Azure Cosmos DB database account.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>

Property Value

(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams) => Promise<DatabaseAccountGetResults>

Property Value

(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams) => Promise<DatabaseAccountGetResults>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams) => Promise<void>

beginFailoverPriorityChange

Warning

This API is now deprecated.

use failoverPriorityChange instead

beginFailoverPriorityChange: (resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFailoverPriorityChangeAndWait

Warning

This API is now deprecated.

use failoverPriorityChange instead

beginFailoverPriorityChangeAndWait: (resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams) => Promise<void>

beginOfflineRegion

Warning

This API is now deprecated.

use offlineRegion instead

beginOfflineRegion: (resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginOfflineRegionAndWait

Warning

This API is now deprecated.

use offlineRegion instead

beginOfflineRegionAndWait: (resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams) => Promise<void>

beginOnlineRegion

Warning

This API is now deprecated.

use onlineRegion instead

beginOnlineRegion: (resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginOnlineRegionAndWait

Warning

This API is now deprecated.

use onlineRegion instead

beginOnlineRegionAndWait: (resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams) => Promise<void>

beginRegenerateKey

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKey: (resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRegenerateKeyAndWait

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKeyAndWait: (resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>

Property Value

(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams) => Promise<DatabaseAccountGetResults>

Property Value

(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams) => Promise<DatabaseAccountGetResults>

checkNameExists

Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.

checkNameExists: (accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams) => Promise<DatabaseAccountsCheckNameExistsResponse>

Property Value

(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams) => Promise<DatabaseAccountsCheckNameExistsResponse>

createOrUpdate

Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.

createOrUpdate: (resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams) => PollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>

Property Value

(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams) => PollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>

delete

delete: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

failoverPriorityChange

Changes the failover priority for the Azure Cosmos DB 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.

failoverPriorityChange: (resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams) => PollerLike<OperationState<void>, void>

get

Retrieves the properties of an existing Azure Cosmos DB database account.

get: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams) => Promise<DatabaseAccountGetResults>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams) => Promise<DatabaseAccountGetResults>

getReadOnlyKeys

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

getReadOnlyKeys: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams) => Promise<DatabaseAccountListReadOnlyKeysResult>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams) => Promise<DatabaseAccountListReadOnlyKeysResult>

list

Lists all the Azure Cosmos DB database accounts available under the subscription.

list: (options?: DatabaseAccountsListOptionalParams) => PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>

Property Value

(options?: DatabaseAccountsListOptionalParams) => PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>

listByResourceGroup

Lists all the Azure Cosmos DB database accounts available under the given resource group.

listByResourceGroup: (resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>

Property Value

(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>

listConnectionStrings

Lists the connection strings for the specified Azure Cosmos DB database account.

listConnectionStrings: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams) => Promise<DatabaseAccountListConnectionStringsResult>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams) => Promise<DatabaseAccountListConnectionStringsResult>

listKeys

Lists the access keys for the specified Azure Cosmos DB database account.

listKeys: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams) => Promise<DatabaseAccountListKeysResult>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams) => Promise<DatabaseAccountListKeysResult>

listMetricDefinitions

Retrieves metric definitions for the given database account.

listMetricDefinitions: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams) => PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams) => PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

listMetrics

Retrieves the metrics determined by the given filter for the given database account.

listMetrics: (resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams) => PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams) => PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

listReadOnlyKeys

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

listReadOnlyKeys: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams) => Promise<DatabaseAccountListReadOnlyKeysResult>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams) => Promise<DatabaseAccountListReadOnlyKeysResult>

listUsages

Retrieves the usages (most recent data) for the given database account.

listUsages: (resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams) => PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams) => PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

offlineRegion

Offline the specified region for the specified Azure Cosmos DB database account.

offlineRegion: (resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams) => PollerLike<OperationState<void>, void>

onlineRegion

Online the specified region for the specified Azure Cosmos DB database account.

onlineRegion: (resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams) => PollerLike<OperationState<void>, void>

regenerateKey

Regenerates an access key for the specified Azure Cosmos DB database account.

regenerateKey: (resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates the properties of an existing Azure Cosmos DB database account.

update: (resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams) => PollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>

Property Value

(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams) => PollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>