azure_sql_managed_instances Resource

Use the azure_sql_managed_instances InSpec audit resource to test the properties related to all Azure SQL-managed instances within a project.

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.

Install

This resource is available in the Chef InSpec Azure resource pack.

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.

Syntax

An azure_sql_managed_instances resource block returns all Azure SQL-managed instances within a project.

describe azure_sql_managed_instances do
  #...
end

Parameters

resource_group (optional): The Azure resource group where the targeted resource resides.

Properties

ids: A list of resource IDs.; Field: id
names: A list of resource names.; Field: name
types: A list of the resource types.; Field: type
properties: A list of properties for all the SQL-managed instances.; Field: properties
locations: A list of the locations.; Field: location
provisioningStates: A list of provisioning states of all the SQL-managed instances.; Field: provisioningState
minimalTlsVersions: A list of minimalTlsVersion for all the SQL-managed instances.; Field: minimalTlsVersion
sku_names: A list of names for the sku.; Field: sku_name
sku_tiers: A list of tiers for the sku.; Field: sku_tier

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Examples

Loop through SQL managed instances by their names.

azure_sql_managed_instances(resource_group: 'RESOURCE_GROUP').names.each do |name|
  describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: name) do
    it { should exist }
  end
end

Test that there are SQL-managed instances that are successfully provisioned

describe azure_sql_managed_instances.where(provisioningState: 'Succeeded') do
  it { should exist }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

# Should not exist if no SQL-Managed Instances are present.

describe azure_sql_managed_instances do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one SQL-Managed Instance.

describe azure_sql_managed_instances do
  it { should exist }
end

Azure Permissions

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