Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 6.21 KB

azure_migrate_project_databases.md

File metadata and controls

110 lines (80 loc) · 6.21 KB
Raw
title platform
About the azure_migrate_project_database Resource
azure

azure_migrate_project_database

Use the azure_migrate_project_database InSpec audit resource to test the properties related to 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 is defined as a resource parameter. If not provided, the latest version is used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint and default values for the HTTP client is used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example, inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

An azure_migrate_project_database resource block returns all Azure Migrate Project Databases within a project.

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

Parameters

Name Description
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

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

* For information on how to use filter criteria on plural resources refer to FilterTable usage.

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_database(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_database(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_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  it { should exist }
end

Azure Permissions

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