azure_db_migration_services Resource

[edit on GitHub]

Use the azure_db_migration_services InSpec audit resource to test properties related to Azure DB Migration Service for a resource group or the entire subscription.

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_db_migration_services resource block returns all Azure DB Migration Services within a Resource Group.

describe azure_db_migration_services(resource_group: 'my-rg') do
  #...
end

or

describe azure_db_migration_services(resource_group: 'my-rg') do
  #...
end

Parameters

resource_group

The name of the resource group.

Properties

ids

A list of the unique resource ids.

Field: id

names

A list of name for all the Resource names.

Field: name

types

A list of types for all the resources.

Field: type

locations

A list of locations for all the resources.

Field: location

kinds

A list of kinds for all the resources.

Field: kind

etags

A list of HTTP strong entity tag value.

Field: etag

tags

A list of resource tags.

Field: tags

sku_names

A list of SKU names.

Field: sku_name

sku_sizes

A list of SKU sizes.

Field: sku_sizes

sku_tiers

A list of SKU tiers.

Field: sku_tiers

provisioning_states

A list of provisioning_states from the properties.

Field: provisioning_state

virtual_nic_ids

A list of virtual nic IDs from the properties.

Field: virtual_nic_id

virtual_subnet_ids

A list of vitual subnet IDs from the properties.

Field: virtual_subnet_id

Examples

Loop through DB Migration Services by their names.

azure_db_migration_services(resource_group: 'my-rg').names.each do |name|
  describe azure_db_migration_service(service_name: name) do
    it { should exist }
  end
end

Test that there are DB Migration Services that includes a certain string in their names (Client Side Filtering).

describe azure_db_migration_services(resource_group: 'my-rg').where { name.include?('UAT') } 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 db migration service are in the resource group

describe azure_db_migration_services(resource_group: 'my-rg') do
  it { should_not exist }
end

# Should exist if the filter returns at least one db migration service

describe azure_db_migration_services(resource_group: 'my-rg') do
  it { should exist }
end

Azure Permissions

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