Collection interface

Paket:

@azure/arm-cosmosdb

Schnittstelle, die eine Sammlung darstellt.

Methoden

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Ruft Metrikdefinitionen für die angegebene Auflistung ab.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Ruft die Metriken ab, die vom angegebenen Filter für das angegebene Datenbankkonto und die angegebene Sammlung bestimmt werden.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Ruft die Verwendungen (die neuesten Speicherdaten) für die angegebene Sammlung ab.

Details zur Methode

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

Ruft Metrikdefinitionen für die angegebene Auflistung ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

accountName

string

Name des Cosmos DB-Datenbankkontos.

databaseRid

string

Cosmos DB-Datenbank wird entfernt.

collectionRid

string

Cosmos DB-Sammlung wird entfernt.

options

CollectionListMetricDefinitionsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

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

Ruft die Metriken ab, die vom angegebenen Filter für das angegebene Datenbankkonto und die angegebene Sammlung bestimmt werden.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

accountName

string

Name des Cosmos DB-Datenbankkontos.

databaseRid

string

Cosmos DB-Datenbank wird entfernt.

collectionRid

string

Cosmos DB-Sammlung wird entfernt.

filter

string

Ein OData-Filterausdruck, der eine Teilmenge der zurückzugebenden Metriken beschreibt. Die Parameter, die gefiltert werden können, sind name.value (Name der Metrik, kann einen oder mehrere Namen aufweisen), startTime, endTime und timeGrain. Der unterstützte Operator ist eq.

options

CollectionListMetricsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

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

Ruft die Verwendungen (die neuesten Speicherdaten) für die angegebene Sammlung ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

accountName

string

Name des Cosmos DB-Datenbankkontos.

databaseRid

string

Cosmos DB-Datenbank wird entfernt.

collectionRid

string

Cosmos DB-Sammlung wird entfernt.

options

CollectionListUsagesOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>