次の方法で共有

Collection interface

  • リファレンス
パッケージ:
@azure/arm-cosmosdb

コレクションを表すインターフェイス。

メソッド

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

指定されたコレクションのメトリック定義を取得します。
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)

指定されたデータベース アカウントとコレクションの指定されたフィルターによって決定されるメトリックを取得します。
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)

指定されたコレクションの使用状況 (最新のストレージ データ) を取得します。

メソッドの詳細

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

指定されたコレクションのメトリック定義を取得します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

accountName

string

Cosmos DB データベース アカウント名。

databaseRid

string

Cosmos DB データベースの削除。

collectionRid

string

Cosmos DB コレクションの削除。

options
CollectionListMetricDefinitionsOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

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

指定されたデータベース アカウントとコレクションの指定されたフィルターによって決定されるメトリックを取得します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

accountName

string

Cosmos DB データベース アカウント名。

databaseRid

string

Cosmos DB データベースの削除。

collectionRid

string

Cosmos DB コレクションの削除。

filter

string

返されるメトリックのサブセットを記述する OData フィルター式。 フィルター処理できるパラメーターは、name.value (メトリックの名前、または複数の名前を持つことができます)、startTime、endTime、timeGrain です。 サポートされている演算子は eq です。

options
CollectionListMetricsOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

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

指定されたコレクションの使用状況 (最新のストレージ データ) を取得します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

accountName

string

Cosmos DB データベース アカウント名。

databaseRid

string

Cosmos DB データベースの削除。

collectionRid

string

Cosmos DB コレクションの削除。

options
CollectionListUsagesOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>