azure_mysql_server Resource

[edit on GitHub]

Use the azure_mysql_server InSpec audit resource to test 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. 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

resource_group and name or the resource_id must be given as a parameter.

describe azure_mysql_server(resource_group: 'inspec-resource-group-9', name: 'example_server') 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 that the targeted resource resides in. MyResourceGroup.

name

Name of the MySql server to test. MyServer.

server_name

Name of the MySql server to test. MyServer. This is for backward compatibility, use name instead.

resource_id

The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforMySQL/servers/{serverName}.

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

Examples

Test If a MySQL Server is Referenced with a Valid Name.

describe azure_mysql_server(resource_group: 'my-rg', name: 'sql-server-1') do
  it { should exist }
end

Test If a MySQL Server is Referenced with an Invalid Name.

describe azure_mysql_server(resource_group: 'my-rg', 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: 'my-rg', name: 'my-server') 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

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

describe azure_mysql_server(resource_group: 'my-rg', 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.