azure_migrate_project_databases Resource

[edit on GitHub]

Use the azure_migrate_project_databases InSpec audit resource to test the properties of all Azure Migrate project databases within a 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_databases resource block returns all Azure Migrate project databases within a project.

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

Parameters

resource_group: Azure resource group that the targeted resource resides in.
project_name: Azure Migrate Project.

The parameter set should be provided for a valid query:

resource_group and project_name.

Properties

ids: Path reference to the project databases.; Field: id
names: Unique names for all project databases.; Field: name
types: Type of the objects.; Field: type
properties: A list of Properties for all the project databases.; Field: properties
assessmentDatas: The assessment details of the database published by various sources.; Field: assessmentData
assessmentIds: The database assessment scopes/Ids.; Field: assessmentId
assessmentTargetTypes: The assessed target database types.; Field: assessmentTargetType
breakingChangesCounts: The number of breaking changes found.; Field: breakingChangesCount
compatibilityLevels: The compatibility levels of the database.; Field: compatibilityLevel
databaseNames: The database names.; Field: databaseName
databaseSizeInMBs: The sizes of the databases.; Field: databaseSizeInMB
enqueueTimes: The list of times the message is enqueued.; Field: enqueueTime
extendedInfos: The extended properties of all the database.; Field: extendedInfo
instanceIds: The database server instance Ids.; Field: instanceId
isReadyForMigrations: The values indicating whether the database is ready for migration.; Field: isReadyForMigration
lastAssessedTimes: The time when the databases were last assessed.; Field: lastAssessedTime
lastUpdatedTimes: The time of the last modifications of the database details.; Field: lastUpdatedTime
migrationBlockersCounts: The number of blocking changes found.; Field: migrationBlockersCount
solutionNames: The names of the solution that sent the data.; Field: solutionName

Note

See the documentation on FilterTable for information on using filter criteria on plural resources.

Examples

Loop through Migrate project databases by their names.

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

Test there are Migrate project databases are ready for migration.

describe azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ isReadyForMigration.include?(true) } 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 databases are present in the project and in the resource group

describe azure_migrate_project_databases(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 databases in the project and in the resource group

describe azure_migrate_project_databases(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.

Was this page helpful?