Skip to content

Data Source: azurermCosmosdbSqlDatabase

Use this data source to access information about an existing CosmosDB SQL Database.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.dataAzurermCosmosdbSqlDatabase.DataAzurermCosmosdbSqlDatabase(
  this,
  "example",
  {
    account_name: "tfex-cosmosdb-sql-database-account-name",
    name: "tfex-cosmosdb-sql-database",
    resource_group_name: "tfex-cosmosdb-sql-database-rg",
  }
);

Argument Reference

The following arguments are supported:

  • name - Specifies the name of the Cosmos DB SQL Database.

  • resourceGroupName - The name of the resource group in which the Cosmos DB SQL Database is created.

  • accountName - The name of the Cosmos DB SQL Database to create the table within.

Attributes Reference

The following attributes are exported:

  • id - The ID of the CosmosDB SQL Database.

  • throughput -The throughput of SQL database (RU/s).

  • autoscaleSettings - An autoscaleSettings block as defined below.

An autoscaleSettings block supports the following:

  • maxThroughput - The maximum throughput of the SQL database (RU/s).

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the CosmosDB SQL Database.