azure_bastion_hosts_resources Resource
Use the azure_bastion_hosts_resources
InSpec audit resource to test the properties of Azure Bastion hosts for a resource group or the entire 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.
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
An azure_bastion_hosts_resource
resource block returns all Azure Bastion hosts within a resource group (if provided).
describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do
..
end
Parameters
resource_group
(optional)The name of the resource group.
Properties
name
- A list of the unique resource names.
Field:
name
ids
- A list of Bastion hosts IDs.
Field:
id
tags
- A list of
tag:value
pairs defined on the resources. Field:
tags
provisioning_states
- State of Bastion hosts creation.
Field:
provisioningState
types
- Types of all the Bastion hosts.
Field:
type
properties
- Properties of all the Bastion hosts.
Field:
properties
Note
Examples
Test to ensure that the Bastion hosts resource is from the same type
describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do
its('type') { should eq 'Microsoft.Network/bastionHosts' }
end
Test to ensure that the Bastion hosts resource is in a successful state
describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do
its('provisioning_states') { should include('Succeeded') }
end
Test to ensure that the Bastion hosts resource is from the same location
describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do
its('location') { should include df_location }
end
Test if any Bastion hosts exist in the resource group
describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') 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 Bastion hots are in the resource group.
describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.