azure_migrate_project_database Resource

[edit on GitHub]

Use the azure_migrate_project_database InSpec audit resource to test the properties related to an Azure Migrate Project database.

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

name is a required parameter and resource_group is an optional parameter.

describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do
  it                                      { should exist }
  its('name')                             { should eq 'PROJECT_DB_NAME' }
  its('type')                             { should eq 'Microsoft.Migrate/MigrateProjects/Databases' }
  its('solutionNames')                    { should include 'MIGRATEDBSOLUTION' }
end

describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do
  it  { should exist }
end

Parameters

name

Name of the Azure Migrate project database to test.

resource_group

Azure resource group where the targeted resource resides.

project_name

Azure Migrate assessment project.

The parameter set should be provided for a valid query are resource_group, project_name, and name.

Properties

id

Path reference to the migrate project database.

name

Unique name of a migrate project database.

type

Type of the object. Microsoft.Migrate/MigrateProjects/Databases.

properties

Properties of the assessment.

properties.assessmentData

Assessment details of the database published by various sources.

assessmentIds

The database assessment scope/IDs.

migrationBlockersCounts

The number of blocking changes found.

breakingChangesCounts

The number of breaking changes found.

assessmentTargetTypes

The assessed target database types.

solutionNames

The names of the solutions that sent the data.

instanceIds

The database servers’ instance IDs.

databaseNames

The name of the databases.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response nested within properties is accessed with the key names separated by dots (.), and attributes nested in the assessmentData are pluralized and listed as a collection.

Examples

Test that Migrate Project database has a SQL ‘assessmentTargetType’

describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do
  its('assessmentTargetTypes') { should include 'SQL' }
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

# If a Migrate Project database is found, it will exist.

describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do
  it { should exist }
end

not_exists

# if Migrate Project Database is not found, it will not exist.

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

Azure Permissions

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