azure_migrate_assessment resource

Use the azure_migrate_assessment InSpec audit resource to test the properties related to the Azure Migrate assessment.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

name, resource_group, project_name, and group_name are required parameters.

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it                                      { should exist }
  its('name')                             { should cmp 'ASSESSMENT_NAME' }
  its('type')                             { should cmp 'Microsoft.Migrate/assessmentprojects/groups/assessments' }
end

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it  { should exist }
end

Parameters

name

Name of the Azure Migrate assessment to test.

resource_group

Azure resource group where the targeted resource resides.

project_name

Azure Migrate assessment project.

group_name

Unique name of a group within a project.

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

Properties

id

Path reference to the assessment.

name

Unique name of an assessment.

type

Object type.

eTag

For optimistic concurrency control.

properties

Properties of the assessment.

properties.azureDiskType

Storage type selected for this disk.

properties.currency

Currency to report the prices.

properties.sizingCriterion

Assessment sizing criterion.

properties.reservedInstance

Azure reserved instance.

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

Refer to the Azure documentation for a full list of available properties. Access any attribute in the response by separating the key names with a period (.).

Examples

Test that the migrate assessments have a minimum scaling factor:

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  its('properties.scalingFactor') { should eq 1.0 }
end

Matchers

exists

# If a Migrate Assessment is found, it will exist.

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it { should exist }
end

not_exists

# If Migrate Assessments are not found, it will not exist.

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_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.