azure_resource_health_emerging_issue resource

Use the azure_resource_health_emerging_issue InSpec audit resource to test the properties related to an Azure Resource Health Emerging issue.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

name is a required parameter.

describe azure_resource_health_emerging_issue(name: 'EMERGING_ISSUE_NAME') do
  it                                      { should exist }
  its('properties.statusActiveEvents') { should be_empty }
end

describe azure_resource_health_emerging_issue(name: 'EMERGING_ISSUE_NAME') do
  it  { should exist }
end

Parameters

name

Name of the Azure Resource Health emerging issue to test.

Properties

id

Fully qualified resource ID for the resource.

name

The name of the resource.

type

The type of resource.

properties.statusActiveEvents

The list of emerging issues of the active event type.

properties.statusBanners

The list of emerging issues of banner type.

properties.refreshTimestamp

Timestamp for when last time refreshed for ongoing emerging issue.

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

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.).

Examples

Test that there are emerging issues with an active event type:

describe azure_resource_health_emerging_issue(name: 'default') do
  its('properties.statusActiveEvents') { should_not be_empty }
end

Matchers

exists

# If an emerging issue is found, it will exist.
describe azure_resource_health_emerging_issue(name: 'default') do
  it { should exist }
end

not_exists

# If no emerging issues are found, it will not exist.
describe azure_resource_health_emerging_issue(name: 'default') 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.