azure_mysql_server resource

Use the azure_mysql_server InSpec audit resource to test the properties and configuration of an Azure MySQL server.

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 and name, or the resource_id are required parameters.

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

describe azure_mysql_server(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforMySQL/servers/{serverName}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

name

Name of the MySql server to test.

server_name

Name of the MySql server to test. This is for backward compatibility. Use name instead.

resource_id

The unique resource ID.

firewall_rules_api_version

The endpoint API version for the firewall_rules 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 and name
• resource_group and server_name

Properties

firewall_rules

A list of all firewall rules in the targeted server.

sku

The SKU (pricing tier) of the server.

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 (.).

Examples

Test if a MySQL server is referenced with a valid name:

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

Test if a MySQL server is referenced with an invalid name:

describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', name: 'i-dont-exist') do
  it { should_not exist }
end

Test if a MySQL server has firewall rules set:

describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  its('firewall_rules') { should_not be_empty }
end

Test a MySQL server’s fully qualified domain name:, location, and public network access status

describe azure_mysql_server(resource_id: '/subscriptions/.../my-server') do
  its('properties.fullyQualifiedDomainName') { should eq 'my-server.mysql.database.azure.com' }
  its('properties.publicNetworkAccess') { should cmp 'Enabled' }
  its('location') { should cmp 'westeurope' }
end

Matchers

exists

describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME-1') do
  it { should exist }
end

Azure permissions

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