Collection interface

Pakket:

@azure/arm-cosmosdb

Interface die een verzameling vertegenwoordigt.

Methoden

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Haalt metrische definities op voor de opgegeven verzameling.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Haalt de metrische gegevens op die zijn bepaald door het opgegeven filter voor het opgegeven databaseaccount en de opgegeven verzameling.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Hiermee haalt u het gebruik (meest recente opslaggegevens) voor de opgegeven verzameling op.

Methodedetails

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

Haalt metrische definities op voor de opgegeven verzameling.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

accountName

string

Naam van cosmos DB-databaseaccount.

databaseRid

string

Cosmos DB-database rid.

collectionRid

string

Cosmos DB-verzameling rid.

options

CollectionListMetricDefinitionsOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

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

Haalt de metrische gegevens op die zijn bepaald door het opgegeven filter voor het opgegeven databaseaccount en de opgegeven verzameling.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

accountName

string

Naam van cosmos DB-databaseaccount.

databaseRid

string

Cosmos DB-database rid.

collectionRid

string

Cosmos DB-verzameling rid.

filter

string

Een OData-filterexpressie die een subset van metrische gegevens beschrijft die moeten worden geretourneerd. De parameters die kunnen worden gefilterd, zijn name.value (naam van de metrische waarde, kan een of van meerdere namen hebben), startTime, endTime en timeGrain. De ondersteunde operator is eq.

options

CollectionListMetricsOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

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

Hiermee haalt u het gebruik (meest recente opslaggegevens) voor de opgegeven verzameling op.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

accountName

string

Naam van cosmos DB-databaseaccount.

databaseRid

string

Cosmos DB-database rid.

collectionRid

string

Cosmos DB-verzameling rid.

options

CollectionListUsagesOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>