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.
The api_version
can be defined as a resource parameter.
If not provided, this resource uses the latest version.
For more information, refer to the azure_generic_resource
document.
Unless defined, this resource uses the azure_cloud
global endpoint and default values for the HTTP client.
For more information, refer to the resource pack README.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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
, andname
resource_group
,server_name
, anddatabase_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, refer to Azure documentation for other properties available.
Any attribute in the response may be accessed 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
For a full list of available matchers, see our Universal Matchers page.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.