Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DatabaseAccountsImpl

Package version

Class containing DatabaseAccounts operations.

Hierarchy

  • DatabaseAccountsImpl

Implements

Index

Constructors

constructor

Methods

beginCreateOrUpdate

beginCreateOrUpdateAndWait

beginDelete

beginDeleteAndWait

beginFailoverPriorityChange

  • 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.

    Parameters

    Returns Promise<PollerLike<PollOperationState<void>, void>>

beginFailoverPriorityChangeAndWait

  • 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.

    Parameters

    Returns Promise<void>

beginOfflineRegion

beginOfflineRegionAndWait

beginOnlineRegion

beginOnlineRegionAndWait

beginRegenerateKey

beginRegenerateKeyAndWait

beginUpdate

beginUpdateAndWait

checkNameExists

get

getReadOnlyKeys

list

listByResourceGroup

listConnectionStrings

listKeys

listMetricDefinitions

listMetrics

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

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • accountName: string

      Cosmos DB database account name.

    • filter: string

      An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

    • Optional options: DatabaseAccountsListMetricsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Metric>

listReadOnlyKeys

listUsages

Generated using TypeDoc