Collection interface
Интерфейс, представляющий коллекцию.
Методы
| list |
Извлекает определения метрик для данной коллекции. |
| list |
Извлекает метрики, определенные заданным фильтром для данной учетной записи базы данных и коллекции. |
| list |
Извлекает данные об использовании (последние данные хранилища) для данной коллекции. |
Сведения о методе
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, избавая от коллекции.
Параметры параметров.
Возвращаемое значение
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.
Параметры параметров.
Возвращаемое значение
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, избавая от коллекции.
Параметры параметров.