azure_migrate_project_machines Resource

[edit on GitHub]

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.

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

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 that the targeted resource resides in.

project_name

Azure Migrate project name.

The parameter set should be provided for a valid query:

• 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 machine published by various sources.

Field: discoveryData

assessmentData

The assessment details of all the machine published by various sources.

Field: assessmentData

migrationData

The migration details of all the machine published by various sources.

Field: migrationData

lastUpdatedTimes

The times of the last modification of all the machines.

Field: lastUpdatedTime

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

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# Should not exist, if no migrate project machines are present in the project and in the resource group
describe azure_migrate_project_machines(resource_group: 'migrate_vms', project_name: 'zoneA_migrate_project') do
  it { should_not exist }
end
# Should exist, if the filter returns at least one migrate project machines in the project and in 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.