DatabaseImpl | @azure/arm-cosmosdb

Class containing Database operations.

Hierarchy

DatabaseImpl

Implements

Database

Index

Constructors

constructor

Methods

Constructors

constructor

new DatabaseImpl(client: CosmosDBManagementClient): DatabaseImpl

- Defined in operations/database.ts:30
Initialize a new instance of the class Database class.

Parameters
- client: CosmosDBManagementClient
  
  Reference to the service client
Returns DatabaseImpl

Methods

listMetricDefinitions

listMetricDefinitions(resourceGroupName: string, accountName: string, databaseRid: string, options?: DatabaseListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition>

Implementation of Database.listMetricDefinitions
- Defined in operations/database.ts:193
Retrieves metric definitions for the given database.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- databaseRid: string
  
  Cosmos DB database rid.
- Optional options: DatabaseListMetricDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MetricDefinition>

listMetrics

listMetrics(resourceGroupName: string, accountName: string, databaseRid: string, filter: string, options?: DatabaseListMetricsOptionalParams): PagedAsyncIterableIterator<Metric>

Implementation of Database.listMetrics
- Defined in operations/database.ts:50
Retrieves the metrics determined by the given filter for the given database account and database.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- databaseRid: string
  
  Cosmos DB database rid.
- 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: DatabaseListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Metric>

listUsages

listUsages(resourceGroupName: string, accountName: string, databaseRid: string, options?: DatabaseListUsagesOptionalParams): PagedAsyncIterableIterator<Usage>

Implementation of Database.listUsages
- Defined in operations/database.ts:125
Retrieves the usages (most recent data) for the given database.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- databaseRid: string
  
  Cosmos DB database rid.
- Optional options: DatabaseListUsagesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Usage>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CosmosDBManagementClient

Returns DatabaseImpl

Methods

listMetricDefinitions

Parameters

resourceGroupName: string

accountName: string

databaseRid: string

Optional options: DatabaseListMetricDefinitionsOptionalParams

Returns PagedAsyncIterableIterator<MetricDefinition>

listMetrics

Parameters

resourceGroupName: string

accountName: string

databaseRid: string

filter: string

Optional options: DatabaseListMetricsOptionalParams

Returns PagedAsyncIterableIterator<Metric>

listUsages

Parameters

resourceGroupName: string

accountName: string

databaseRid: string

Optional options: DatabaseListUsagesOptionalParams

Returns PagedAsyncIterableIterator<Usage>