azure_application_gateways Resource
Use the azure_application_gateways
InSpec audit resource to test the properties and configuration of Azure Application Gateways.
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.
Installation
This resource is available in the Chef InSpec Azure resource pack.
See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.
Syntax
An azure_application_gateways
resource block returns all Azure Application Gateways, either within a Resource Group (if provided) or an entire Subscription.
describe azure_application_gateways do
#...
end
Or
describe azure_application_gateways(resource_group: 'RESOURCE_GROUP') do
#...
end
Parameters
resource_group
(optional)The name of the resource group.
Properties
ids
- A list of the unique resource IDs.
Field:
id
locations
- A list of locations for all the resources being interrogated.
Field:
location
names
- A list of names of all the resources being interrogated.
Field:
name
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
types
- A list of the types of resources being interrogated.
Field:
type
properties
- A list of properties for all the resources being interrogated.
Field:
properties
Note
See the documentation on FilterTable for information on using filter criteria on plural resources.
Examples
Check Application Gateways are present
describe azure_application_gateways do
it { should exist }
its('names') { should include 'my-appgw' }
end
Filter the results to include only those with names that match the specified string value
describe azure_application_gateways.where{ name.eql?('production-appgw-01') } do
it { should exist }
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
The control passes if the filter returns at least one result. Use should_not
if you expect zero matches.
# If we expect 'EXAMPLEGROUP' Resource Group to have Application Gateways.
describe azure_application_gateways(resource_group: 'EXAMPLEGROUP') do
it { should exist }
end
not_exists
# If we expect 'EMPTYEXAMPLEGROUP' Resource Group not to have Application Gateways.
describe azure_application_gateways(resource_group: 'EMPTYEXAMPLEGROUP') 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.
Was this page helpful?