azure_sql_servers Resource

Use the azure_sql_servers InSpec audit resource to test properties and configuration of multiple Azure SQL Servers.

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

An azure_sql_servers resource block returns all Azure SQL Servers, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_sql_servers do
  it { should exist }
end

describe azure_sql_servers(resource_group: 'my-rg') do
  it { should exist }
end

Parameters

resource_group (optional): The name of the resource group.

Properties

ids: A list of the unique resource ids.; Field: id
locations: A list of locations for all the resources being interrogated.; Field: location
names: A list of names of all the resources being interrogated.; Field: name
kinds: A list of kinds of all the resources being interrogated.; Field: kind
tags: A list of tag:value pairs defined on the resources.; Field: tags
skus: A list of the SKUs (pricing tiers) of the servers.; Field: sku
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

Note

See the documentation on FilterTable for information on using filter criteria on plural resources.

Examples

Check a Specific SQL Server is Present.

describe azure_sql_servers do
  its('names')  { should include 'my-server-name' }
end

Filters the Results to Include Only Those Servers which Include the Given Name (Client Side Filtering).

describe azure_sql_servers.where{ name.include?('production') } do
  it { should exist }
end

Filters the Results to Include Only Those Servers which Reside in a Given Location (Client Side Filtering).

describe azure_sql_servers.where{ location.eql?('westeurope') } do
  it { should exist }
end

Filters the Results to Include Only Those Servers which Reside in a Given Location and Include the Given Name (Server Side Filtering - Recommended).

describe azure_generic_resources(resource_provider: 'Microsoft.Sql/servers', substring_of_name: 'production', location: 'westeurope') 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.

describe azure_sql_servers 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.