Collection interface

Paket:

@azure/arm-cosmosdb

Gränssnitt som representerar en samling.

Metoder

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Hämtar måttdefinitioner för den angivna samlingen.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Hämtar de mått som bestäms av det angivna filtret för det angivna databaskontot och samlingen.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Hämtar användningarna (senaste lagringsdata) för den angivna samlingen.

Metodinformation

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

Hämtar måttdefinitioner för den angivna samlingen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

accountName

string

Cosmos DB-databaskontonamn.

databaseRid

string

Cosmos DB databas rid.

collectionRid

string

Cosmos DB samling rid.

options

CollectionListMetricDefinitionsOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

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

Hämtar de mått som bestäms av det angivna filtret för det angivna databaskontot och samlingen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

accountName

string

Cosmos DB-databaskontonamn.

databaseRid

string

Cosmos DB databas rid.

collectionRid

string

Cosmos DB samling rid.

filter

string

Ett OData-filteruttryck som beskriver en delmängd mått som ska returneras. Parametrarna som kan filtreras är name.value (måttets namn, kan ha ett eller flera namn), startTime, endTime och timeGrain. Operatorn som stöds är eq.

options

CollectionListMetricsOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

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

Hämtar användningarna (senaste lagringsdata) för den angivna samlingen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

accountName

string

Cosmos DB-databaskontonamn.

databaseRid

string

Cosmos DB databas rid.

collectionRid

string

Cosmos DB samling rid.

options

CollectionListUsagesOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>