azure_sql_databases Resource
Use the azure_sql_databases
InSpec audit resource to test the properties and configuration of Azure SQL Databases.
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.
Installation
This resource is available in the Chef InSpec Azure resource pack.
See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.
Syntax
The resource_group
and server_name
are required parameters.
describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do
it { should exist }
end
Parameters
resource_group
- Azure resource group where the targeted resource resides.
server_name
- The name of the server in which the database resides.
Properties
ids
- A list of the unique resource IDs.
Field:
id
names
- A list of names of all the resources being interrogated.
Field:
name
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
types
- A list of the types of resources being interrogated.
Field:
type
properties
- A list of properties for all the resources being interrogated.
Field:
properties
locations
- A list of locations for all the resources being interrogated.
Field:
location
kinds
- A list of kinds of all the resources being interrogated.
Field:
kind
Note
See the documentation on FilterTable for information on using filter criteria on plural resources.
Examples
Check resources are present
describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do
it { should exist }
its('names') { should include 'my-db' }
end
Filter the results to include only those with names that match the specified string value
describe azure_sql_databases.(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ name.eql?('production-db') } do
it { should exist }
end
Filter the results to include only those with ‘GRS’ storage account type
describe azure_sql_databases.(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ properties[:storageAccountType] == 'GRS' } do
it { should exist }
end
Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.
exists
The control passes if the filter returns at least one result. Use should_not
if you expect zero matches.
# If we expect resources to exist.
describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do
it { should exist }
end
not_exists
# If we expect resources not to exist.
describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_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.
Was this page helpful?