azure_resource_health_availability

Use the azure_resource_health_availability_status InSpec audit resource to test the properties related to an Azure Resource Health availability status.

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

resource_group, resource_type, and name are required parameters.

describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do
  it                                      { should exist }
  its('name')                             { should cmp 'current' }
  its('type')                             { should cmp 'Microsoft.ResourceHealth/AvailabilityStatuses' }
  its('location')                         { should cmp 'ukwest' }
  its('properties.availabilityState')     { should cmp 'Available' }
  its('properties.reasonChronicity')      { should cmp 'Persistent' }
end

Parameters

name: Name of the Azure resource to test.
resource_group: Azure resource group where the targeted resource resides.
resource_type: Azure resource type of the targeted resource.

The parameter set should be provided for a valid query are resource_group, resource_type, and name.

Properties

id: Azure Resource Manager Identity for the availabilityStatuses resource.
name: current.
type: Microsoft.ResourceHealth/AvailabilityStatuses.
location: Azure Resource Manager geo location of the resource.
properties: Properties of availability state.

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 availability status of a resource:

describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do
  its('properties.availabilityState') { should eq 'Available' }
end

Test the chronicity type of a resource:

describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do
  its('properties.reasonChronicity') { should include 'Persistent' }
end

Matchers

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

exists

# If a resource status is found, it will exist.

describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_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.

azure_resource_health_availability_status resource