azurerm_load_balancer resource
Warning
This resource will be deprecated when version 2 of the inspec-azure resource pack is released. Please use the azure_load_balancer resource instead.
Use the azurerm_load_balancer
InSpec audit resource to test properties and configuration of
an Azure Load Balancer.
Azure REST API version
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.
Availability
Install
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.
Version
This resource first became available in 1.7.2 of the inspec-azure resource pack.
Syntax
The resource_group
and loadbalancer_name
must be given as a parameter.
describe azurerm_load_balancer(resource_group: 'inspec-resource-group-9', loadbalancer_name: 'example_lb') do
it { should exist }
end
Examples
If a Load Balancer is referenced with a valid Resource Group
and Load balancer Name
describe azurerm_load_balancer(resource_group: 'my-rg', loadbalancer_name: 'lb-1') do
it { should exist }
end
If a Load Balancer is referenced with an invalid Resource Group
or Load balancer Name
describe azurerm_load_balancer(resource_group: 'invalid-rg', loadbalancer_name: 'i-do-not-exist') do
it { should_not exist }
end
Parameters
resource_group
- The resource Group to which the Load Balancer belongs.loadbalancer_name
- The unique name of the Load balancer.
Attributes
id
name
sku
location
properties
tags
type
id
Azure resource ID.
name
Load Balancer name, e.g. lb-1
.
sku
SKU of load balancer. This is billing information related properties of a load balancer.
location
Resource location, e.g. eastus
.
properties
A collection of additional configuration properties related to the Load balancer, e.g. loadBalancingRules
.
tags
Resource tags applied to the Load balancer.
type
The type of Resource, typically Microsoft.Network/loadBalancers
.
Other Attributes
There are additional attributes that may be accessed that we have not
documented. Please take a look at the Azure documentation.
Any attribute in the response may be accessed with the key names separated by
dots (.
).
The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you’ll be able to guard against nil keys. Pull requests are always welcome.
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
describe azurerm_load_balancer(resource_group: 'my-rg', loadbalancer_name: 'lb-1') do
it { should exist }
end
Azure Permissions
Your Service
Principal
must be setup with a contributor
role on the subscription you wish to test.