azure_migrate_project_events Resource

[edit on GitHub]

Use the azure_migrate_project_events InSpec audit resource to test the properties related to all Azure Migrate project events 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_project_events resource block returns all Azure Migrate project events within a project.

describe azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  #...
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

project_name

Azure Migrate Project.

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

Properties

ids

Path reference to the project events.

Field: id

names

Unique names for all project events.

Field: name

types

Type of the objects.

Field: type

properties

A list of properties for all the project events.

Field: properties

instanceTypes

The instance types.

Field: instanceType

machines

The machines for which the error is reported.

Field: machine

errorCodes

The error codes.

Field: errorCode

errorMessages

The error messages.

Field: errorMessage

recommendations

The recommendations for the error.

Field: recommendation

possibleCauses

The possible causes for the error.

Field: possibleCause

solutions

The solutions for which the error is reported.

Field: solution

clientRequestIds

The client request IDs of the payload for which the event is reported.

Field: clientRequestId

For more details on the available properties, refer to Azure documentation.

Examples

Loop through Migrate Project events by their names

azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name|
  describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: `PROJECT_EVENT_NAME`) do
    it { should exist }
  end
end

Test that there are Migrate Project events for databases

describe azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(instanceType: 'Databases') 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.

not_exists

# Should not exist if no migrate project events are present in the project and the resource group.

describe azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
  it { should_not exist }
end

exists

# Should exist if the filter returns at least one migrate project event in the project and the resource group.

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