Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 4.36 KB

azure_migrate_project_event.md

File metadata and controls

96 lines (66 loc) · 4.36 KB
title platform
About the azure_migrate_project_event Resource
azure

azure_migrate_project_event

Use the azure_migrate_project_event InSpec audit resource to test the properties related to an Azure Migrate project event.

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

resource_group, project_name and name are required parameters.

describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do
  it                             { should exist }
  its('properties.instanceType') { should eq 'SERVERS' }
end
describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do
  it  { should exist }
end

Parameters

Name Description
name Name of the Azure Migrate project event to test.
resource_group Azure resource group that the targeted resource resides in.
project_name Azure Migrate assessment project name.

The parameter set should be provided for a valid query:

  • resource_group, project_name, and name.

Properties

Property Description
id Path reference to the Migrate project event.
name Unique name of a Migrate project event.
type Type of the object. Microsoft.Migrate/MigrateProjects/Databases
properties Properties of the assessment.

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 nested within properties is accessed with the key names separated by dots (.), and attributes nested in the assessmentData are pluralized and listed as a collection.

Examples

Test that the migrate project event is of servers instanceType

describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do
  its('properties.instanceType') { should eq 'SERVERS' }
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 project event is found, it will exist
describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do
  it { should exist }
end
# if migrate project event is not found, it will not exist
describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_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.