azure_sql_virtual_machine_group_availability_listeners Resource
Use the azure_sql_virtual_machine_group_availability_listeners
InSpec audit resource to test the properties related to all Azure SQL virtual machine group availability listeners.
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_virtual_machine_group_availability_listeners
resource block returns all Azure SQL virtual machine group availability listeners.
describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME') do
#...
end
Parameters
resource_group
(required)Azure resource group where the targeted resource resides.
sql_virtual_machine_group_name
(required)Azure SQL virtual machine group name.
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 virtual machine group availability listeners.
Field:
properties
provisioningStates
- A list of provisioning states of the SQL virtual machine group availability listeners.
Field:
provisioningState
Note
Examples
Loop through SQL virtual machine group availability listeners by their names
azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME').names.each do |name|
describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: name) do
it { should exist }
end
end
Test that there are SQL virtual machine group availability listeners that are successfully provisioned
describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME').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 virtual machine group availability listeners are present.
describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME') do
it { should_not exist }
end
not_exists
# Should exist if the filter returns at least one SQL virtual machine group availability listener.
describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME') 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.