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

Install

This resource is available in the Chef InSpec Azure resource pack.

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.

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.