azure_migrate_assessment_machine Resource

Use the azure_migrate_assessment_machine InSpec audit resource to test 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. 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, 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 that the targeted resource resides in.
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 the 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, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test the Boot Type of 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

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

# 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.