azure_migrate_assessment_machine resource

Use the azure_migrate_assessment_machine InSpec audit resource to test the properties related to an Azure Migrate assessment machine.

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

describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do
  it                                      { should exist }
  its('name')                             { should eq 'zoneA_machines_migrate_assessment' }
  its('type')                             { should eq 'Microsoft.Migrate/assessmentprojects/machines' }
end

describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do
  it  { should exist }
end

Parameters

name (required)

Name of the Azure Migrate assessment machine to test.

resource_group (required)

Azure resource group where the targeted resource resides.

project_name (required)

The Azure Migrate Assessment project.

Properties

id

Path reference to the assessment.

name

Unique name of an assessment.

type

Type of the object. Microsoft.Migrate/assessmentprojects/machines.

eTag

For optimistic concurrency control.

properties

Properties of the assessment.

properties.bootType

Boot type of machine.

properties.megabytesOfMemory

Memory in Megabytes.

properties.numberOfCores

Processor count.

properties.operatingSystemType

Operating system type of the machine.

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

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.).

Examples

Test the boot migrate assessment machine:

describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME', name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do
  its('properties.bootType') { should eq 'BIOS' }
end

Matchers

exists

# If a migrate assessment machine is found, it exists.

describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do
  it { should exist }
end

not_exists

# If migrate assessment machine is not found, it does not exist.

describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_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.