azure_migrate_assessment_groups Resource

[edit on GitHub]

Use the azure_migrate_assessment_groups InSpec audit resource to test properties related to all Azure Migrate assessment groups 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_assessment_groups resource block returns all Azure Migrate assessment groups within a project.

describe azure_migrate_assessment_groups(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 assessment project.

The parameter set should be provided for a valid query:

resource_group and project_name.

Properties

ids: Path reference to all the groups.; Field: id
names: Unique names for all groups.; Field: name
types: Type of the objects.; Field: type
eTags: A list of eTags for all the groups.; Field: eTag
properties: A list of properties for all the groups.; Field: properties
areAssessmentsRunnings: A list of boolean describing the assessment run state.; Field: areAssessmentsRunning
assessments: List of references to assessments created on this group.; Field: assessments
createdTimestamps: List of creation times of the groups.; Field: createdTimestamp
groupStatuses: List of creation status of the groups.; Field: groupStatus
groupTypes: List of group types.; Field: groupType
machineCounts: List of machine counts.; Field: machineCount
updatedTimestamps: List of updated timestamps of the groups.; Field: updatedTimestamp

* For information on how to use filter criteria on plural resources refer to FilterTable usage. Also, refer to Azure documentation for the complete list of properties available.

Examples

Loop through migrate assessment groups by their names.

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

Test that the assessments are running for migrate assessment groups.

describe azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(areAssessmentsRunning: true) 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 Assessment Groups are present in the project

describe azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  it { should_not exist }
end
# Should exist if the filter returns at least one Migrate Assessment Groups in the project

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

Was this page helpful?