title | platform |
---|---|
About the azurerm_load_balancers Resource |
azure |
Use the azurerm_load_balancers
InSpec audit resource to test properties and configuration of Azure Load Balancers.
This resource interacts with version 2018-11-01
of the Azure Management API. For more
information see the Official Azure Documentation.
At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version.
This resource is available in the inspec-azure
resource
pack. To use it, add the
following to your inspec.yml
in your top-level profile:
depends:
inspec-azure:
git: https://github.com/inspec/inspec-azure.git
You'll also need to setup your Azure credentials; see the resource pack README.
This resource first became available in 1.7.2 of the inspec-azure resource pack.
An azurerm_load_balancers
resource block returns all Azure Load Balancers, either within a Resource Group (if provided), or within an entire Subscription.
describe azurerm_load_balancer do
...
end
or
describe azurerm_load_balancers(resource_group: 'my-rg') do
...
end
The following examples show how to use this InSpec audit resource.
describe azurerm_load_balancers do
it { should exist }
its('names') { should include 'my-lb' }
end
names
Filters the results to include only those load balancers which match the given name. This is a string value.
describe azurerm_load_balancers.where{ name.eql?('production-lb-5') } do
it { should exist }
end
location
Filters the results to include only those load balancers which reside in a given location. This is a string value.
describe azurerm_load_balancers.where{ location.eql?('eastus') } do
it { should exist }
end
id
name
sku
location
properties
type
Azure resource ID.
Load balancer name, e.g. my-lb
.
its('names') { should include 'my-lb' }
SKU of load balancer. This is metadata used for the Azure portal experience.
Resource location, e.g. eastus
.
its('locations') { should_not include 'eastus' }
A collection of additional configuration properties related to the Load Balancer, e.g. loadBalancingRules
.
The type of Resource, typically Microsoft.Network/loadBalancers
.
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.
The control will pass if the filter returns at least one result. Use
should_not
if you expect zero matches.
describe azurerm_load_balancers do
it { should exist }
end
Your Service
Principal
must be setup with a contributor
role on the subscription you wish to test.