azure_resource_health_events Resource

[edit on GitHub]

Use the azure_resource_health_events InSpec audit resource to test properties related to all Azure Resource Health events for the subscription.

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_resource_health_events resource block returns all Azure Resource Health events within a subscription or for a particular resource.

describe azure_resource_health_events do
  #...
end

or

describe azure_resource_health_events(resource_group: 'RESOURCE_GROUP', resource_type: 'RESOURCE_TYPE', resource_id: 'RESOURCE_ID') do
  #...
end

Parameters

Note

To list all service health events in a subscription, do not provide any parameters. To list events for a particular resource, pass in all three parameters listed below. If one or more parameters are missing then all events in a subscription will be returned.

resource_group

Azure resource group that the targeted resource resides in.

resource_type

The name of the resource type.

resource_id

The unique identifier of the resource.

Properties

ids

A list of the unique resource IDs.

Field: id

names

A list of names for all the resources.

Field: name

types

A list of resource types for all the resources.

Field: type

properties

A list of properties for all the resources.

Field: properties

See the Azure documentation for other available properties.

Examples

Test that there are health events that have a service issue.

describe azure_resource_health_events.where{ properties.select{|prop| prop.eventType == 'ServiceIssue' } } do
  it { should exist }
end

Test that there are health events for a particular resource.

describe azure_resource_health_events(resource_group: 'RESOURCE_GROUP', resource_type: 'RESOURCE_TYPE', resource_id: 'RESOURCE_ID') 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.

exists

# Should not exist if no service health events are present in the subscription

describe azure_resource_health_events do
  it { should_not exist }
end

# Should exist if the filter returns at least one service health events in the subscription

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