Collection interface

Pakiet:

@azure/arm-cosmosdb

Interfejs reprezentujący kolekcję.

Metody

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Pobiera definicje metryk dla danej kolekcji.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Pobiera metryki określone przez dany filtr dla danego konta bazy danych i kolekcji.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Pobiera dane użycia (najnowsze dane magazynu) dla danej kolekcji.

Szczegóły metody

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

Pobiera definicje metryk dla danej kolekcji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

accountName

string

Nazwa konta bazy danych usługi Cosmos DB.

databaseRid

string

Identyfikator rid bazy danych usługi Cosmos DB.

collectionRid

string

Identyfikator rid kolekcji usługi Cosmos DB.

options

CollectionListMetricDefinitionsOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

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

Pobiera metryki określone przez dany filtr dla danego konta bazy danych i kolekcji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

accountName

string

Nazwa konta bazy danych usługi Cosmos DB.

databaseRid

string

Identyfikator rid bazy danych usługi Cosmos DB.

collectionRid

string

Identyfikator rid kolekcji usługi Cosmos DB.

filter

string

Wyrażenie filtru OData, które opisuje podzestaw metryk do zwrócenia. Parametry, które można filtrować, to name.value (nazwa metryki, może mieć wiele nazw), startTime, endTime i timeGrain. Obsługiwany operator to eq.

options

CollectionListMetricsOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

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

Pobiera dane użycia (najnowsze dane magazynu) dla danej kolekcji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

accountName

string

Nazwa konta bazy danych usługi Cosmos DB.

databaseRid

string

Identyfikator rid bazy danych usługi Cosmos DB.

collectionRid

string

Identyfikator rid kolekcji usługi Cosmos DB.

options

CollectionListUsagesOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>