Class DatabaseOperationsExtensions

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Extension methods for DatabaseOperations.

public static class DatabaseOperationsExtensions

Inheritance

object

DatabaseOperationsExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

ListMetricDefinitionsAsync(IDatabaseOperations, string, string, string, CancellationToken)

Retrieves metric definitions for the given database.

public static Task<IEnumerable<MetricDefinition>> ListMetricDefinitionsAsync(this IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseRid string

Cosmos DB database rid.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<MetricDefinition>>

ListMetricsAsync(IDatabaseOperations, string, string, string, string, CancellationToken)

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

public static Task<IEnumerable<Metric>> ListMetricsAsync(this IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, string filter, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

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.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<Metric>>

ListUsagesAsync(IDatabaseOperations, string, string, string, string, CancellationToken)

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

public static Task<IEnumerable<Usage>> ListUsagesAsync(this IDatabaseOperations operations, string resourceGroupName, string accountName, string databaseRid, string filter = null, CancellationToken cancellationToken = default)

Parameters

operations IDatabaseOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseRid string

Cosmos DB database rid.

filter string

An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<Usage>>