azure_resource_health_availability_status Resource
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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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, 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 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
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit 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.