azure_migrate_assessment_group Resource
Use the azure_migrate_assessment_group
InSpec audit resource to test the properties related to an Azure Migrate assessment group.
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
name
, project_name
, and resource_group
are required parameters.
describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do
it { should exist }
its('name') { should eq 'GROUP_NAME' }
its('type') { should cmp 'Microsoft.Migrate/assessmentProjects/groups' }
end
describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do
it { should exist }
end
Parameters
name
- Name of the Azure Migrate assessment group to test.
resource_group
- Azure resource group where the targeted resource resides.
project_name
- Azure Migrate assessment project.
The parameter set that should be provided for a valid query is resource_group
, project_name
, and name
.
Properties
id
- Path reference to the group.
name
- Name of the group.
type
- Object type.
eTag
- For optimistic concurrency control.
properties
- Properties of the group.
properties.areAssessmentsRunning
- If the assessments are in a running state.
properties.assessments
- List of references to assessments created on this group.
properties.machineCount
- Number of machines part of this group.
For properties applicable to all resources, such as type
, name
, id
, and properties
, refer to azure_generic_resource
.
Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.
).
Examples
Test the migrate assessment group has at least five machines
describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do
its('properties.machineCount') { should be >= 5 }
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 Assessment Group is found, it will exist.
describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do
it { should exist }
end
not_exists
# If Migrate Assessment Group is not found, it will not exist.
describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_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.