azure_migrate_project_solution Resource

[edit on GitHub]

Use the azure_migrate_project_solution InSpec audit resource to test the properties related to an Azure Migrate Project solution.

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 and resource_group are required parameters.

describe azure_migrate_project_solution(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_SOLUTION_NAME') do
  it                                      { should exist }
  its('name')                             { should cmp 'PROJECT_SOLUTION_NAME' }
  its('type')                             { should cmp 'Microsoft.Migrate/MigrateProjects/Solutions' }
end

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

Parameters

name

Name of the Azure Migrate project solution to test.

resource_group

Azure resource group where the targeted resource resides.

project_name

Azure Migrate project.

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

Properties

id

Path reference to the project solution.

name

Unique name of the project solution.

type

Object type. Microsoft.Migrate/MigrateProjects/Solutions.

eTag

For optimistic concurrency control.

properties

Properties of the project Solution.

properties.cleanupState

The cleanup state of the solution.

properties.details

The details of the solution.

properties.summary

The summary of the solution.

properties.purpose

The purpose of the solution.

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 is accessed with the key names separated by dots (.).

Examples

Test that the Migrate Project solution is defined for assessment

describe azure_migrate_project_solution(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_SOLUTION_NAME') do
  its('properties.purpose') { should eq 'ASSESSMENT' }
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 solution is found, it will exist.

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

not_exists

# If Migrate Project solutions are not found, it will not exist.

describe azure_migrate_project_solution(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_SOLUTION_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.