azure_resource_health_emerging_issue Resource

[edit on GitHub]

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. 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

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, 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 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

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

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.