azure_migrate_project_solutions Resource

[edit on GitHub]

Use the azure_migrate_project_solutions InSpec audit resource to test the properties related to all Azure Migrate project solutions 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_solutions resource block returns all Azure Migrate project solutions within a project.

describe azure_migrate_project_solutions(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 solutions.; Field: id
names: Unique names for all project solutions.; Field: name
types: Type of the objects.; Field: type
eTags: A list of eTags for all the Project Solutions.; Field: eTag
properties: A list of Properties for all the Project Solutions.; Field: properties
tools: The tool used in all the solutions.; Field: tool
purposes: The purpose of all the solutions.; Field: purpose
goals: The goals of all the solutions.; Field: goal
statuses: The current status of all the solutions.; Field: status
cleanupStates: The cleanup states of all the solutions.; Field: cleanupState
summaries: The summary of all the solutions.; Field: summary
details: The details of all the solutions.; Field: details
instanceTypes: The Instance types.; Field: instanceType
databasesAssessedCounts: The count of databases assessed.; Field: databasesAssessedCount
databaseInstancesAssessedCounts: The count of database instances assessed.; Field: databaseInstancesAssessedCount
migrationReadyCounts: The count of databases ready for migration.; Field: migrationReadyCount
groupCounts: The count of groups reported by all the solutions.; Field: groupCount
assessmentCounts: The count of assessments reported by all the solutions.; Field: assessmentCount
extendedDetails: The extended details reported by all the solutions.; Field: extendedDetails

Note

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

Examples

Loop through migrate project solutions by their names.

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

Test to ensure the migrate project solutions for assessment.

describe azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(purpose: 'Assessment') 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 Solutions are present in the project and in the resource group

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

describe azure_migrate_project_solutions(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?