azure_sql_database resource

Use the azure_sql_database InSpec audit resource to test the properties and configuration of an Azure SQL Database.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

resource_group, server_name, and name, or the resource_id are required parameters.

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  it { should exist }
end

describe azure_sql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

server_name

The name of the server on which the database resides.

name

Name of the SQL database to test.

database_name

Alias for the name parameter.

resource_id

The unique resource ID.

auditing_settings_api_version

The endpoint API version for the auditing_settings property. The latest version will be used unless provided.

threat_detection_settings_api_version

The endpoint API version for the threat_detection_settings property. The latest version will be used unless provided.

encryption_settings_api_version

The endpoint API version for the encryption_settings property. The latest version will be used unless provided.

Either one of the parameter sets can be provided for a valid query:

• resource_id
• resource_group, server_name, and name
• resource_group, server_name, and database_name

Properties

encryption_settings

Database’s transparent data encryption configuration with these properties.

auditing_settings

Database’s blob auditing policy with these properties.

threat_detection_settings

Threat detection settings for the targeted database with these properties.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.). For example, properties.<attribute>.

Examples

Test if a SQL database is referenced with a valid name:

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  it { should exist }
end

Test if a SQL database is referenced with an invalid name:

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  it { should_not exist }
end

Test if a SQL database has transparent data encryption is enabled:

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  its('encryption_settings.properties.status') { should cmp 'Enabled' }
end

Test if a SQL database auditing is enabled:

describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do
  its('auditing_settings.properties.status') { should cmp 'Enabled' }
end

Test if a SQL database threat detection is enabled:

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  its('threat_detection_settings.properties.status') { should cmp 'Enabled' }
end

Matchers

This resource has the following special matchers.

exists

# If we expect a resource to always exist.

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  it { should exist }
end

not_exists

# If we expect a resource to never exist.

describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.