Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 5.09 KB

azure_migrate_assessment.md

File metadata and controls

102 lines (72 loc) · 5.09 KB
Raw
title platform
About the azure_migrate_assessment Resource
azure

azure_migrate_assessment

Use the azure_migrate_assessment InSpec audit resource to test the properties related to Azure Migrate assessment.

Azure REST API version, Endpoint, and HTTP Client Parameters

This resource interacts with API versions supported by the resource provider. The api_version is defined as a resource parameter. If not provided, the latest version is used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint and default values for the HTTP client are used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example, inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

name, resource_group, project_name, and group_name are required parameters.

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it                                      { should exist }
  its('name')                             { should cmp 'ASSESSMENT_NAME' }
  its('type')                             { should cmp 'Microsoft.Migrate/assessmentprojects/groups/assessments' }
end
describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it  { should exist }
end

Parameters

Name Description
name Name of the Azure Migrate assessment to test.
resource_group Azure resource group where the targeted resource resides in.
project_name Azure Migrate assessment project.
group_name Unique name of a group within a project.

The parameter set should be provided for a valid query:

  • resource_group, project_name, group_name, and name.

Properties

Property Description
id Path reference to the assessment.
name Unique name of an assessment.
type Object type.
eTag For optimistic concurrency control.
properties Properties of the assessment.
properties.azureDiskType Storage type selected for this disk.
properties.currency Currency to report prices in.
properties.sizingCriterion Assessment sizing criterion.
properties.reservedInstance Azure reserved instance.

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

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

Examples

Test that the migrate assessments has a minimum scaling factor

describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  its('properties.scalingFactor') { should eq 1.0 }
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 Assessments is found, it will exist
describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it { should exist }
end

# if Migrate Assessments are not found, it will not exist
describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be set up with a contributor role on the subscription you wish to test.