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

+++ title = "azurermsqldatabase resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurermsqldatabase" identifier = "inspec/resources/azure/azurermsqldatabase.md azurermsqldatabase resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azuresql_database" >}} Use the `azurermsqldatabase` InSpec audit resource to test properties and configuration of an Azure SQL Database on a SQL Server. This resource interacts with version `2017-10-01-preview` 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: name: 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.2.0 of the inspec-azure resource pack. The `resourcegroup`, `servername` and `database_name` must be given as a parameter. describe azurermsqldatabase(resourcegroup: 'inspec-rg', servername: 'customerserver', databasename: 'order-db') do it { should exist } end If a SQL Database is referenced with a valid `Resource Group`, `Server Name` and `Database name` describe azurermsqldatabase(resourcegroup: 'inspec-rg', servername: 'customerserver', databasename: 'order-db') do it { should exist } its('name') { should be 'order-db'} end If a SQL Database is referenced with an invalid `Resource Group`, `Server Name` or `Database Name` describe azurermsqldatabase(resourcegroup: 'inspec-rg', servername: 'customerserver', databasename: 'invalid-db-name') do it { should_not exist } end `resource_group` - The resource Group to which the SQL Server belongs. `server_name` - The unique name of the SQL Server. `database_name` - The unique name of the SQL Database. `id` `name` `kind` `location` `type` `sku` `properties` Azure resource ID. SQL Server name, e.g. `customer-database`. Kind of sql database. This is metadata used for the Azure portal experience. Resource location, e.g. `eastus`. The type of Resource, typically `Microsoft.Sql/servers/databases`. The name and tier of the SKU. A collection of additional configuration properties related to the SQL Database, e.g. `collation`. 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. describe azurermsqldatabase(resourcegroup: 'my-rg', servername: 'server-name-1', database_name: 'customer-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.