Collection interface

Pacote:

@azure/arm-cosmosdb

Interface que representa uma coleção.

Métodos

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Recupera definições de métrica para a coleção fornecida.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Recupera as métricas determinadas pelo filtro determinado para a conta de banco de dados e a coleção fornecidas.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Recupera os usos (dados de armazenamento mais recentes) para a coleção fornecida.

Detalhes do método

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

Recupera definições de métrica para a coleção fornecida.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

accountName

string

Nome da conta de banco de dados do Cosmos DB.

databaseRid

string

Banco de dados do Cosmos DB livre.

collectionRid

string

Coleção do Cosmos DB livre.

options

CollectionListMetricDefinitionsOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

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

Recupera as métricas determinadas pelo filtro determinado para a conta de banco de dados e a coleção fornecidas.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

accountName

string

Nome da conta de banco de dados do Cosmos DB.

databaseRid

string

Banco de dados do Cosmos DB livre.

collectionRid

string

Coleção do Cosmos DB livre.

filter

string

Uma expressão de filtro OData que descreve um subconjunto de métricas a serem retornadas. Os parâmetros que podem ser filtrados são name.value (nome da métrica, pode ter um ou de vários nomes), startTime, endTime e timeGrain. O operador com suporte é eq.

options

CollectionListMetricsOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

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

Recupera os usos (dados de armazenamento mais recentes) para a coleção fornecida.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

accountName

string

Nome da conta de banco de dados do Cosmos DB.

databaseRid

string

Banco de dados do Cosmos DB livre.

collectionRid

string

Coleção do Cosmos DB livre.

options

CollectionListUsagesOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>