azure_migrate_project_database

Use the azure_migrate_project_database_instances InSpec audit resource to test the 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. 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

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 where the migrate project is part.
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 time when the message was 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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

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

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 Migrate Project database instances are present in the project and the resource group.

describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Migrate project database instance in the project and 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.

azure_migrate_project_database_instances resource