@datafire/azure_cosmos_db

Client library for Cosmos DB

Installation and Usage

npm install --save @datafire/azure_cosmos_db

let azure_cosmos_db = require('@datafire/azure_cosmos_db').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Azure Cosmos DB Database Service Resource Provider REST API

Actions

DatabaseAccounts_CheckNameExists

Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.

azure_cosmos_db.DatabaseAccounts_CheckNameExists({
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

Operations_List

Lists all of the available Cosmos DB Resource Provider operations.

azure_cosmos_db.Operations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output OperationListResult

DatabaseAccounts_List

Lists all the Azure Cosmos DB database accounts available under the subscription.

azure_cosmos_db.DatabaseAccounts_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • subscriptionId required string: Azure subscription ID.

Output

• output DatabaseAccountsListResult

DatabaseAccounts_ListByResourceGroup

Lists all the Azure Cosmos DB database accounts available under the given resource group.

azure_cosmos_db.DatabaseAccounts_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of an Azure resource group.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • subscriptionId required string: Azure subscription ID.

Output

• output DatabaseAccountsListResult

DatabaseAccounts_Delete

Deletes an existing Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

DatabaseAccounts_Get

Retrieves the properties of an existing Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output DatabaseAccountGetResults

DatabaseAccounts_Update

Updates the properties of an existing Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_Update({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "updateParameters": {}
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateParameters required DatabaseAccountUpdateParameters

Output

• output DatabaseAccountGetResults

DatabaseAccounts_CreateOrUpdate

Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.

azure_cosmos_db.DatabaseAccounts_CreateOrUpdate({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "createUpdateParameters": {
    "properties": {
      "locations": [],
      "databaseAccountOfferType": ""
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateParameters required DatabaseAccountCreateUpdateParameters

Output

• output DatabaseAccountGetResults

CassandraResources_ListCassandraKeyspaces

Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

azure_cosmos_db.CassandraResources_ListCassandraKeyspaces({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output CassandraKeyspaceListResult

CassandraResources_DeleteCassandraKeyspace

Deletes an existing Azure Cosmos DB Cassandra keyspace.

azure_cosmos_db.CassandraResources_DeleteCassandraKeyspace({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

CassandraResources_GetCassandraKeyspace

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.CassandraResources_GetCassandraKeyspace({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output CassandraKeyspaceGetResults

CassandraResources_CreateUpdateCassandraKeyspace

Create or update an Azure Cosmos DB Cassandra keyspace

azure_cosmos_db.CassandraResources_CreateUpdateCassandraKeyspace({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "api-version": "",
  "createUpdateCassandraKeyspaceParameters": {
    "properties": {
      "resource": {
        "id": ""
      },
      "options": {}
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateCassandraKeyspaceParameters required CassandraKeyspaceCreateUpdateParameters

Output

• output CassandraKeyspaceGetResults

CassandraResources_ListCassandraTables

Lists the Cassandra table under an existing Azure Cosmos DB database account.

azure_cosmos_db.CassandraResources_ListCassandraTables({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output CassandraTableListResult

CassandraResources_DeleteCassandraTable

Deletes an existing Azure Cosmos DB Cassandra table.

azure_cosmos_db.CassandraResources_DeleteCassandraTable({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "tableName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • tableName required string: Cosmos DB table name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

CassandraResources_GetCassandraTable

Gets the Cassandra table under an existing Azure Cosmos DB database account.

azure_cosmos_db.CassandraResources_GetCassandraTable({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "tableName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • tableName required string: Cosmos DB table name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output CassandraTableGetResults

CassandraResources_CreateUpdateCassandraTable

Create or update an Azure Cosmos DB Cassandra Table

azure_cosmos_db.CassandraResources_CreateUpdateCassandraTable({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "tableName": "",
  "api-version": "",
  "createUpdateCassandraTableParameters": {
    "properties": {
      "resource": {
        "id": ""
      },
      "options": {}
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • tableName required string: Cosmos DB table name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateCassandraTableParameters required CassandraTableCreateUpdateParameters

Output

• output CassandraTableGetResults

CassandraResources_GetCassandraTableThroughput

Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.CassandraResources_GetCassandraTableThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "tableName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • tableName required string: Cosmos DB table name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output ThroughputSettingsGetResults

CassandraResources_UpdateCassandraTableThroughput

Update RUs per second of an Azure Cosmos DB Cassandra table

azure_cosmos_db.CassandraResources_UpdateCassandraTableThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "tableName": "",
  "api-version": "",
  "updateThroughputParameters": {
    "properties": {
      "resource": {
        "throughput": 0
      }
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • tableName required string: Cosmos DB table name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateThroughputParameters required ThroughputSettingsUpdateParameters

Output

• output ThroughputSettingsGetResults

CassandraResources_GetCassandraKeyspaceThroughput

Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.CassandraResources_GetCassandraKeyspaceThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output ThroughputSettingsGetResults

CassandraResources_UpdateCassandraKeyspaceThroughput

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace

azure_cosmos_db.CassandraResources_UpdateCassandraKeyspaceThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "keyspaceName": "",
  "api-version": "",
  "updateThroughputParameters": {
    "properties": {
      "resource": {
        "throughput": 0
      }
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • keyspaceName required string: Cosmos DB keyspace name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateThroughputParameters required ThroughputSettingsUpdateParameters

Output

• output ThroughputSettingsGetResults

Collection_ListMetricDefinitions

Retrieves metric definitions for the given collection.

azure_cosmos_db.Collection_ListMetricDefinitions({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MetricDefinitionsListResult

Collection_ListMetrics

Retrieves the metrics determined by the given filter for the given database account and collection.

azure_cosmos_db.Collection_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output MetricListResult

PartitionKeyRangeId_ListMetrics

Retrieves the metrics determined by the given filter for the given partition key range id.

azure_cosmos_db.PartitionKeyRangeId_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "collectionRid": "",
  "partitionKeyRangeId": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • partitionKeyRangeId required string: Partition Key Range Id for which to get data.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output PartitionMetricListResult

CollectionPartition_ListMetrics

Retrieves the metrics determined by the given filter for the given collection, split by partition.

azure_cosmos_db.CollectionPartition_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output PartitionMetricListResult

CollectionPartition_ListUsages

Retrieves the usages (most recent storage data) for the given collection, split by partition.

azure_cosmos_db.CollectionPartition_ListUsages({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter string: An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

Output

• output PartitionUsagesResult

Collection_ListUsages

Retrieves the usages (most recent storage data) for the given collection.

azure_cosmos_db.Collection_ListUsages({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter string: An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

Output

• output UsagesResult

Database_ListMetricDefinitions

Retrieves metric definitions for the given database.

azure_cosmos_db.Database_ListMetricDefinitions({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MetricDefinitionsListResult

Database_ListMetrics

Retrieves the metrics determined by the given filter for the given database account and database.

azure_cosmos_db.Database_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output MetricListResult

Database_ListUsages

Retrieves the usages (most recent data) for the given database.

azure_cosmos_db.Database_ListUsages({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseRid": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseRid required string: Cosmos DB database rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter string: An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

Output

• output UsagesResult

DatabaseAccounts_FailoverPriorityChange

Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

azure_cosmos_db.DatabaseAccounts_FailoverPriorityChange({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "failoverParameters": null
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • failoverParameters required FailoverPolicies

Output

Output schema unknown

GremlinResources_ListGremlinDatabases

Lists the Gremlin databases under an existing Azure Cosmos DB database account.

azure_cosmos_db.GremlinResources_ListGremlinDatabases({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output GremlinDatabaseListResult

GremlinResources_DeleteGremlinDatabase

Deletes an existing Azure Cosmos DB Gremlin database.

azure_cosmos_db.GremlinResources_DeleteGremlinDatabase({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

GremlinResources_GetGremlinDatabase

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.GremlinResources_GetGremlinDatabase({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output GremlinDatabaseGetResults

GremlinResources_CreateUpdateGremlinDatabase

Create or update an Azure Cosmos DB Gremlin database

azure_cosmos_db.GremlinResources_CreateUpdateGremlinDatabase({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": "",
  "createUpdateGremlinDatabaseParameters": {
    "properties": {
      "resource": {
        "id": ""
      },
      "options": {}
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateGremlinDatabaseParameters required GremlinDatabaseCreateUpdateParameters

Output

• output GremlinDatabaseGetResults

GremlinResources_ListGremlinGraphs

Lists the Gremlin graph under an existing Azure Cosmos DB database account.

azure_cosmos_db.GremlinResources_ListGremlinGraphs({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output GremlinGraphListResult

GremlinResources_DeleteGremlinGraph

Deletes an existing Azure Cosmos DB Gremlin graph.

azure_cosmos_db.GremlinResources_DeleteGremlinGraph({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "graphName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • graphName required string: Cosmos DB graph name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

GremlinResources_GetGremlinGraph

Gets the Gremlin graph under an existing Azure Cosmos DB database account.

azure_cosmos_db.GremlinResources_GetGremlinGraph({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "graphName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • graphName required string: Cosmos DB graph name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output GremlinGraphGetResults

GremlinResources_CreateUpdateGremlinGraph

Create or update an Azure Cosmos DB Gremlin graph

azure_cosmos_db.GremlinResources_CreateUpdateGremlinGraph({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "graphName": "",
  "api-version": "",
  "createUpdateGremlinGraphParameters": {
    "properties": {
      "resource": {
        "id": ""
      },
      "options": {}
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • graphName required string: Cosmos DB graph name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateGremlinGraphParameters required GremlinGraphCreateUpdateParameters

Output

• output GremlinGraphGetResults

GremlinResources_GetGremlinGraphThroughput

Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.GremlinResources_GetGremlinGraphThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "graphName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • graphName required string: Cosmos DB graph name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output ThroughputSettingsGetResults

GremlinResources_UpdateGremlinGraphThroughput

Update RUs per second of an Azure Cosmos DB Gremlin graph

azure_cosmos_db.GremlinResources_UpdateGremlinGraphThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "graphName": "",
  "api-version": "",
  "updateThroughputParameters": {
    "properties": {
      "resource": {
        "throughput": 0
      }
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • graphName required string: Cosmos DB graph name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateThroughputParameters required ThroughputSettingsUpdateParameters

Output

• output ThroughputSettingsGetResults

GremlinResources_GetGremlinDatabaseThroughput

Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.GremlinResources_GetGremlinDatabaseThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output ThroughputSettingsGetResults

GremlinResources_UpdateGremlinDatabaseThroughput

Update RUs per second of an Azure Cosmos DB Gremlin database

azure_cosmos_db.GremlinResources_UpdateGremlinDatabaseThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": "",
  "updateThroughputParameters": {
    "properties": {
      "resource": {
        "throughput": 0
      }
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateThroughputParameters required ThroughputSettingsUpdateParameters

Output

• output ThroughputSettingsGetResults

DatabaseAccounts_ListConnectionStrings

Lists the connection strings for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_ListConnectionStrings({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output DatabaseAccountListConnectionStringsResult

DatabaseAccounts_ListKeys

Lists the access keys for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_ListKeys({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output DatabaseAccountListKeysResult

DatabaseAccounts_ListMetricDefinitions

Retrieves metric definitions for the given database account.

azure_cosmos_db.DatabaseAccounts_ListMetricDefinitions({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MetricDefinitionsListResult

DatabaseAccounts_ListMetrics

Retrieves the metrics determined by the given filter for the given database account.

azure_cosmos_db.DatabaseAccounts_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output MetricListResult

MongoDBResources_ListMongoDBDatabases

Lists the MongoDB databases under an existing Azure Cosmos DB database account.

azure_cosmos_db.MongoDBResources_ListMongoDBDatabases({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MongoDBDatabaseListResult

MongoDBResources_DeleteMongoDBDatabase

Deletes an existing Azure Cosmos DB MongoDB database.

azure_cosmos_db.MongoDBResources_DeleteMongoDBDatabase({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

MongoDBResources_GetMongoDBDatabase

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.MongoDBResources_GetMongoDBDatabase({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MongoDBDatabaseGetResults

MongoDBResources_CreateUpdateMongoDBDatabase

Create or updates Azure Cosmos DB MongoDB database

azure_cosmos_db.MongoDBResources_CreateUpdateMongoDBDatabase({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": "",
  "createUpdateMongoDBDatabaseParameters": {
    "properties": {
      "resource": {
        "id": ""
      },
      "options": {}
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateMongoDBDatabaseParameters required MongoDBDatabaseCreateUpdateParameters

Output

• output MongoDBDatabaseGetResults

MongoDBResources_ListMongoDBCollections

Lists the MongoDB collection under an existing Azure Cosmos DB database account.

azure_cosmos_db.MongoDBResources_ListMongoDBCollections({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MongoDBCollectionListResult

MongoDBResources_DeleteMongoDBCollection

Deletes an existing Azure Cosmos DB MongoDB Collection.

azure_cosmos_db.MongoDBResources_DeleteMongoDBCollection({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "collectionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • collectionName required string: Cosmos DB collection name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

Output schema unknown

MongoDBResources_GetMongoDBCollection

Gets the MongoDB collection under an existing Azure Cosmos DB database account.

azure_cosmos_db.MongoDBResources_GetMongoDBCollection({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "collectionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • collectionName required string: Cosmos DB collection name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output MongoDBCollectionGetResults

MongoDBResources_CreateUpdateMongoDBCollection

Create or update an Azure Cosmos DB MongoDB Collection

azure_cosmos_db.MongoDBResources_CreateUpdateMongoDBCollection({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "collectionName": "",
  "api-version": "",
  "createUpdateMongoDBCollectionParameters": {
    "properties": {
      "resource": {
        "id": ""
      },
      "options": {}
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • collectionName required string: Cosmos DB collection name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • createUpdateMongoDBCollectionParameters required MongoDBCollectionCreateUpdateParameters

Output

• output MongoDBCollectionGetResults

MongoDBResources_GetMongoDBCollectionThroughput

Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.MongoDBResources_GetMongoDBCollectionThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "collectionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • collectionName required string: Cosmos DB collection name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output ThroughputSettingsGetResults

MongoDBResources_UpdateMongoDBCollectionThroughput

Update the RUs per second of an Azure Cosmos DB MongoDB collection

azure_cosmos_db.MongoDBResources_UpdateMongoDBCollectionThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "collectionName": "",
  "api-version": "",
  "updateThroughputParameters": {
    "properties": {
      "resource": {
        "throughput": 0
      }
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • collectionName required string: Cosmos DB collection name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateThroughputParameters required ThroughputSettingsUpdateParameters

Output

• output ThroughputSettingsGetResults

MongoDBResources_GetMongoDBDatabaseThroughput

Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.

azure_cosmos_db.MongoDBResources_GetMongoDBDatabaseThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output ThroughputSettingsGetResults

MongoDBResources_UpdateMongoDBDatabaseThroughput

Update RUs per second of the an Azure Cosmos DB MongoDB database

azure_cosmos_db.MongoDBResources_UpdateMongoDBDatabaseThroughput({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "databaseName": "",
  "api-version": "",
  "updateThroughputParameters": {
    "properties": {
      "resource": {
        "throughput": 0
      }
    }
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • databaseName required string: Cosmos DB database name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • updateThroughputParameters required ThroughputSettingsUpdateParameters

Output

• output ThroughputSettingsGetResults

DatabaseAccounts_OfflineRegion

Offline the specified region for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_OfflineRegion({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "regionParameterForOffline": null
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • regionParameterForOffline required RegionForOnlineOffline

Output

Output schema unknown

DatabaseAccounts_OnlineRegion

Online the specified region for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_OnlineRegion({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "regionParameterForOnline": null
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • regionParameterForOnline required RegionForOnlineOffline

Output

Output schema unknown

Percentile_ListMetrics

Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data

azure_cosmos_db.Percentile_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output PercentileMetricListResult

DatabaseAccounts_GetReadOnlyKeys

Lists the read-only access keys for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_GetReadOnlyKeys({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output DatabaseAccountListReadOnlyKeysResult

DatabaseAccounts_ListReadOnlyKeys

Lists the read-only access keys for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_ListReadOnlyKeys({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.

Output

• output DatabaseAccountListReadOnlyKeysResult

DatabaseAccounts_RegenerateKey

Regenerates an access key for the specified Azure Cosmos DB database account.

azure_cosmos_db.DatabaseAccounts_RegenerateKey({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": "",
  "keyToRegenerate": {
    "keyKind": ""
  }
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • keyToRegenerate required DatabaseAccountRegenerateKeyParameters

Output

Output schema unknown

CollectionRegion_ListMetrics

Retrieves the metrics determined by the given filter for the given database account, collection and region.

azure_cosmos_db.CollectionRegion_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "region": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • region required string: Cosmos DB region, with spaces between words and each word capitalized.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output MetricListResult

PartitionKeyRangeIdRegion_ListMetrics

Retrieves the metrics determined by the given filter for the given partition key range id and region.

azure_cosmos_db.PartitionKeyRangeIdRegion_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "region": "",
  "databaseRid": "",
  "collectionRid": "",
  "partitionKeyRangeId": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • region required string: Cosmos DB region, with spaces between words and each word capitalized.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • partitionKeyRangeId required string: Partition Key Range Id for which to get data.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output PartitionMetricListResult

CollectionPartitionRegion_ListMetrics

Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

azure_cosmos_db.CollectionPartitionRegion_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "region": "",
  "databaseRid": "",
  "collectionRid": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • region required string: Cosmos DB region, with spaces between words and each word capitalized.
  • databaseRid required string: Cosmos DB database rid.
  • collectionRid required string: Cosmos DB collection rid.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output PartitionMetricListResult

DatabaseAccountRegion_ListMetrics

Retrieves the metrics determined by the given filter for the given database account and region.

azure_cosmos_db.DatabaseAccountRegion_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "region": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • region required string: Cosmos DB region, with spaces between words and each word capitalized.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Output

• output MetricListResult

PercentileSourceTarget_ListMetrics

Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data

azure_cosmos_db.PercentileSourceTarget_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "sourceRegion": "",
  "targetRegion": "",
  "api-version": "",
  "$filter": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Cosmos DB database account name.
  • sourceRegion required string: Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized.
  • targetRegion required string: Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized.
  • api-version required string: Version of the API to be used with the client request. The current version is 2019-08-01.
  • $filter required string: An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value