azure_migrate_project_machines resource

Use the azure_migrate_project_machines InSpec audit resource to test the properties related to all Azure Migrate Project machines within a project.

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

An azure_migrate_project_machines resource block returns all Azure Migrate Project machines within a project.

describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  #...
end

Parameters

resource_group: Azure resource group where the targeted resource resides.
project_name: Azure Migrate project name.

The parameter set that should be provided for a valid query is resource_group and project_name.

Properties

ids: Path reference to the project machines.
Field: id
names: Unique names for all project machines.
Field: name
types: Type of the objects.
Field: type
properties: A list of properties for all the project machines.
Field: properties
discoveryData: The discovery details of all the machines published by various sources.
Field: discoveryData
assessmentData: The assessment details of all the machines published by various sources.
Field: assessmentData
migrationData: The migration details of all the machines published by various sources.
Field: migrationData
lastUpdatedTimes: The times of the last modification of all the machines.
Field: lastUpdatedTime

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Examples

Loop through Migrate Project machines by their names:

azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name|
  describe azure_migrate_project_machine(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: `NAME`) do
    it { should exist }
  end
end

Test that there are Migrate Project machines with Windows OS:

describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ discoveryData.detect{ |data| data[:osType] == 'WINDOWSGUEST' } } do
  it { should exist }
end

Test that the Migrate Project machines are of BIOS boot type:

describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ discoveryData.detect{ |data| data[:extendedInfo][:bootType] == 'BIOS' } } do
  it { should exist }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

# Should not exist if no Migrate Project machines are present in the project and the resource group.

describe azure_migrate_project_machines(resource_group: 'migrate_vms', project_name: 'zoneA_migrate_project') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Migrate Project machine in the project and the resource group.

describe azure_migrate_project_machines(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.