azure_mysql_databases.md

title	platform
About the azure_mysql_databases Resource	azure

azure_mysql_databases

Use the azure_mysql_databases InSpec audit resource to test properties and configuration of Azure MySQL 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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

The resource_group, and server_name must be given as a parameter.

describe azure_mysql_databases(resource_group: 'my-rg', server_name: 'my-server') do
  it { should exist }
end

Parameters

Name	Description
resource_group	Azure resource group that the targeted resource resides in. MyResourceGroup
server_name	The name of the server in which the database resides. serverName

Properties

Property	Description	Filter Criteria*
ids	A list of the unique resource ids.	id
names	A list of names of all the resources being interrogated.	name
tags	A list of tag:value pairs defined on the resources being interrogated.	tags
types	A list of the types of resources being interrogated.	type
properties	A list of properties for all the resources being interrogated.	properties

* For information on how to use filter criteria on plural resources refer to FilterTable usage.

Examples

Check Resources are Present

describe azure_mysql_databases(resource_group: 'my-rg', server_name: 'my-server') do
    it            { should exist }
    its('names')  { should include 'my-db' }
end

Filter the Results to Include Only those with Names Match the Given String Value

describe azure_mysql_databases.(resource_group: 'my-rg', server_name: 'my-server').where{ name.eql?('production-db') } 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 will pass if the filter returns at least one result. Use should_not if you expect zero matches.

# If we expect resources to exist
describe azure_mysql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do
  it { should exist }
end

# If we expect resources not to exist
describe azure_mysql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.