Project: Chef InSpec (Provisioning / Security & Compliance)
File: azurerm_cosmosdb_database_account.md

+++ title = "azurermcosmosdbdatabase_account resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurermcosmosdbdatabase_account" identifier = "inspec/resources/azure/azurermcosmosdbdatabaseaccount.md azurermcosmosdbdatabaseaccount resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azurecosmosdbdatabaseaccount" >}} Use the `azurermcosmosdbdatabase_account` InSpec audit resource to test properties and configuration of an Azure CosmosDb Database Account within a Resource Group. This resource interacts with version `2015-04-08` of the Azure Management API. For more information see the . At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version. This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the following to your `inspec.yml` in your top-level profile: depends: inspec-azure: git: https://github.com/inspec/inspec-azure.git You'll also need to setup your Azure credentials; see the resource pack . This resource first became available in 1.11.0 of the inspec-azure resource pack. The `resourcegroup` and `cosmosdbdatabase_account` must be given as a parameter. describe azurermcosmosdbdatabaseaccount(resourcegroup: 'my-rg', cosmosdbdatabaseaccount 'my-cosmos-db') do it { should exist } end If an CosmosDb Database Account is referenced with a valid `Resource Group` and `CosmosDb Database Account` describe azurermcosmosdbdatabaseaccount(resourcegroup: 'my-rg', cosmosdbdatabaseaccount 'my-cosmos-db') do it { should exist } end If an CosmosDb Database Account is referenced with an invalid `Resource Group` and `CosmosDb Database Account` describe azurermcosmosdbdatabaseaccount(resourcegroup: 'my-rg', cosmosdbdatabaseaccount 'fake-cosmos-db') do it { should not exist } end `resource_group` - The resource Group to which the CosmosDb Database Account belongs. `cosmosdbdatabaseaccount` - The unique name of the CosmosDb Database Account. `id` `name` `location` `type` `kind` `tags` `properties` Azure resource ID. CosmosDb Database Account name, e.g. `my-cosmosdb-account`. Resource location, e.g. `eastus`. The type of Resource, typically `Microsoft.DocumentDB/databaseAccounts`. Indicates the type of database account, e.g. `GlobalDocumentDB`, `MongoDB` Resource tags applied to the Cosmos DB Account. A collection of additional configuration properties related to the CosmosDb Database Account, e.g. `Capability, ConsistencyPolicy, DatabaseAccountKind`. For a full list of properties please take a look at the There are additional attributes that may be accessed that we have not documented. Please take a look at the . Any attribute in the response may be accessed with the key names separated by dots (`.`). The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you'll be able to guard against nil keys. Pull requests are always welcome. {{< readfile file="content/inspec/reusable/md/inspecmatcherslink.md" >}} This resource has the following special matchers. ```ruby describe azurermcosmosdbdatabaseaccount(resourcegroup: 'my-rg', cosmosdbdatabaseaccount 'my-cosmos-db') do it { should exist } end ``` Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test.