azure_migrate_assessment_project resource

Use the azure_migrate_assessment_project InSpec audit resource to test the properties related to an Azure Migrate assessment 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

name and resource_group are required parameters.

describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do
  it                                      { should exist }
  its('name')                             { should cmp 'ASSESSMENT_PROJECT_NAME' }
  its('type')                             { should cmp 'Microsoft.Migrate/assessmentprojects' }
end

describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do
  it  { should exist }
end

Parameters

name: Name of the Azure Migrate assessment project to test.
resource_group: Azure resource group where the targeted project resides.

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

Properties

id: Path reference to the project.
name: Project name.
type: Type of the object.
eTag: For optimistic concurrency control.
properties: Properties of the project.
location: Azure location in which the project is created.
properties.assessmentSolutionId: Assessment solution ARM ID tracked by Microsoft.Migrate/migrateProjects.
properties.customerStorageAccountArmId: The ARM ID of the storage account is used for interactions when public access is disabled.
properties.privateEndpointConnections: The list of private endpoint connections to the project.
properties.numberOfMachines: Number of machines in the project.
tags: Tags provided by Azure Tagging service.

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

Refer to the Azure documentation for other available properties. Access any attribute in the response by separating the key names with a period (.).

Examples

Test that the migrate assessment project has a minimum scaling factor:

describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do
  its('properties.numberOfGroups') { should eq 2 }
end

Matchers

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

exists

# If a Migrate Assessment project is found, it will exist.

describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do
  it { should exist }
end

not_exists

# If Migrate Assessment project is not found, it will not exist.

describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_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.