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.
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
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
, and1.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, refer to Azure documentation for other properties available.
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
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit 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.