azure_resource_health_events resource

Use the azure_resource_health_events InSpec audit resource to test the 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. 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

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

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 where the targeted resource resides.
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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

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

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

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

not_exists

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