Collection interface

Paquet:

@azure/arm-cosmosdb

Interface représentant une collection.

Méthodes

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Récupère les définitions de métriques pour la collection donnée.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Récupère les métriques déterminées par le filtre donné pour le compte de base de données et la collection donnés.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Récupère les utilisations (données de stockage les plus récentes) pour la collection donnée.

Détails de la méthode

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)

Récupère les définitions de métriques pour la collection donnée.

function listMetricDefinitions(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, options?: CollectionListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de base de données Cosmos DB.

databaseRid

string

Suppression de la base de données Cosmos DB.

collectionRid

string

Suppression de la collection Cosmos DB.

options

CollectionListMetricDefinitionsOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)

Récupère les métriques déterminées par le filtre donné pour le compte de base de données et la collection donnés.

function listMetrics(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, filter: string, options?: CollectionListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de base de données Cosmos DB.

databaseRid

string

Suppression de la base de données Cosmos DB.

collectionRid

string

Suppression de la collection Cosmos DB.

filter

string

Expression de filtre OData qui décrit un sous-ensemble de métriques à retourner. Les paramètres qui peuvent être filtrés sont name.value (nom de la métrique, peuvent avoir un ou plusieurs noms), startTime, endTime et timeGrain. L’opérateur pris en charge est eq.

options

CollectionListMetricsOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

listUsages(string, string, string, string, CollectionListUsagesOptionalParams)

Récupère les utilisations (données de stockage les plus récentes) pour la collection donnée.

function listUsages(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, options?: CollectionListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de base de données Cosmos DB.

databaseRid

string

Suppression de la base de données Cosmos DB.

collectionRid

string

Suppression de la collection Cosmos DB.

options

CollectionListUsagesOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>