azure_sql_virtual_machine_group_availability

Use the azure_sql_virtual_machine_group_availability_listener InSpec audit resource to test the properties related to an Azure SQL virtual machine group availability listener.

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

describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners' }
end

describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_NAME') do
  it  { should exist }
end

Parameters

name (required): Name of the Azure SQL virtual machine group availability listeners to test.
resource_group (required): Azure resource group where the targeted resource resides.
sql_virtual_machine_group_name (required): The Azure SQL virtual machine group name.

Properties

id: Resource ID.
name: Resource name.
type: Resource type.
properties: The properties of the SQL virtual machine group availability listener.
properties.provisioningState: State of the resource.

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 virtual machine group availability listener is provisioned successfully:

describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_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 virtual machine group availability listener is found, it will exist.

describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_NAME') do
  it { should exist }
end

not_exists

# if SQL virtual machine group availability listener is not found, it will not exist

describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_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.

azure_sql_virtual_machine_group_availability_listener resource