azure_resource_health_availability

Use the azure_resource_health_availability_statuses InSpec audit resource to test the properties related to all Azure Availability Statuses 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_availability_statuses resource block returns all Azure Availability Statuses within a subscription.

describe azure_resource_health_availability_statuses do
  #...
end

Parameters

This resource does not require any parameters.

Properties

ids: A list of the Azure Resource Manager Identity for the availabilityStatuses resources.
Field: id
names: current.
Field: name
types: Microsoft.ResourceHealth/AvailabilityStatuses.
Field: type
properties: A list of Properties of availability state.
Field: properties
locations: A list of Azure Resource Manager geo locations of the resource.
Field: location

Note

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

Examples

Loop through availability statuses by resource ID:

azure_resource_health_availability_statuses.ids.each do |id|
  describe azure_resource_health_availability_status(resource_id: id) do
    it { should exist }
  end
end

Test that there are availability statuses that have an ‘Available’ availability state:

describe azure_resource_health_availability_statuses.where{ properties.select{|prop| prop.availabilityState == 'Available' } } 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 availability statuses are present in the subscription.

describe azure_resource_health_availability_statuses do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one availability status in the subscription.

describe azure_resource_health_availability_statuses 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_statuses resource