azure_sql_virtual_machine_groups Resource

[edit on GitHub]

Use the azure_sql_virtual_machine_groups InSpec audit resource to test the properties related to all Azure SQL virtual machine groups.

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.

Installation

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

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

An azure_sql_virtual_machine_groups resource block returns all Azure SQL Virtual Machine groups.

describe azure_sql_virtual_machine_groups do
  #...
end

Parameters

resource_group (optional)

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 virtual machine groups.

Field: properties

locations

A list of the resource locations.

Field: location

provisioningStates

A list of provisioning states of the SQL virtual machine groups.

Field: provisioningState

Examples

Loop through SQL virtual machine groups by their names

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

Test that there are SQL virtual machine groups that are successfully provisioned

describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do
  it { should exist }
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

# Should not exist if no SQL Virtual Machine Groups are present.

describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one SQL Virtual Machine group.

describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP') 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.