azure_sql_managed_instance resource

Use the azure_sql_managed_instance InSpec audit resource to test the properties related to an Azure SQL managed instance.

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

name andresource_group are required parameters.

describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.Sql/managedInstances' }
  its('location')                         { should eq 'eastus' }
end

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

Parameters

name: Name of the Azure SQL managed instances to test.
resource_group: Azure resource group where the targeted resource resides.

The parameter set that should be provided for a valid query is resource_group and name.

Properties

id: Resource ID.
name: Resource name.
type: Resource type.
location: Resource location.
properties: The properties of the SQL-Managed Instance.
properties.minimalTlsVersion: Minimal TLS version. Allowed values are None, 1.0, 1.1, and 1.2.
properties.maintenanceConfigurationId: Specifies maintenance configuration ID to apply to this managed instance.
properties.provisioningState: Provisioning state of the SQL-managed instance.
sku.name: The name of the SKU, typically a letter with a number code. For example, P3.

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.

Examples

Test that the SQL managed instances are provisioned successfully:

describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do
  its('properties.provisioningState') { should eq 'Succeeded' }
end

Matchers

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

exists

# If a SQL-managed instance is found, it will exist.

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

not_exists

# if SQL managed instance is not found, it will not exist.

describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do
  it { should_not exist }
end

Azure permissions

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