azure_migrate_project_database_instances Resource

[edit on GitHub]

Use the azure_migrate_project_database_instances InSpec audit resource to test properties of all Azure Migrate project database instances in a migrate project.

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_migrate_project_database_instances resource block returns all Azure Migrate project database instances within a project.

describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  #...
end

Parameters

resource_group (required)

Name of the Azure Resource Group that migrate project is part of.

project_name (required)

Name of the Azure Migrate project.

Properties

ids

Path reference to the project database instances.

Field: id

names

Unique names for all project database instances.

Field: name

types

Type of the objects.

Field: type

properties

A list of properties for all the project database instances.

Field: properties

discoveryDatas

The assessment details of the database published by various sources.

Field: assessmentData

summaries

The database instances summaries per solution.

Field: summary

lastUpdatedTimes

The time of the last modification of the database instance details.

Field: lastUpdatedTime

enqueueTimes

The times the message were enqueued.

Field: enqueueTimes

extendedInfos

The extended properties of the database servers.

Field: extendedInfos

hostNames

The host names of the database servers.

Field: hostNames

instanceIds

The database instance IDs.

Field: instanceIds

instanceNames

The database instance names.

Field: instanceNames

instanceTypes

The database instance types.

Field: instanceTypes

instanceVersions

The database instance versions.

Field: instanceVersions

ipAddresses

The IP addresses of the database server. IP addresses could be IPV4 or IPV6.

Field: ipAddresses

portNumbers

The port numbers of the database server.

Field: portNumbers

solutionNames

The names of the solution that sent the data.

Field: solutionNames

Examples

Loop through Migrate project database instances by their names.

azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name|
  describe azure_migrate_project_database_instance(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: name) do
    it { should exist }
  end
end

Test that there are Migrate project database instances that are of SQL instance types.

describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ instanceTypes.include?('SQL') } 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 Migrate project database instances are present in the project and in the resource group

describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  it { should_not exist }
end
# Should exist if the filter returns at least one Migrate project database instances in the project and in the resource group

describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') 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.