Skip to content

Latest commit

 

History

History
100 lines (79 loc) · 4.09 KB

azure_load_balancers.md

File metadata and controls

100 lines (79 loc) · 4.09 KB
title platform
About the azure_load_balancers Resource
azure

azure_load_balancers

Use the azure_load_balancers InSpec audit resource to test properties and configuration of Azure Load Balancers.

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

An azure_load_balancers resource block returns all Azure Load Balancers, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_load_balancers do
  #...
end

or

describe azure_load_balancers(resource_group: 'my-rg') do
  #...
end

Parameters

  • resource_group (Optional)

Properties

Property Description Filter Criteria*
ids A list of the unique resource ids. id
locations A list of locations for all the resources being interrogated. location
names A list of names of all the resources being interrogated. name
tags A list of tag:value pairs defined on the resources being interrogated. tags
types A list of the types of resources being interrogated. type
properties A list of properties for all the resources being interrogated. properties
skus A list of the SKUs of the resources being interrogated. sku

* For information on how to use filter criteria on plural resources refer to FilterTable usage.

Examples

Check Load balancers are Present

describe azure_load_balancers do
    it            { should exist }
    its('names')  { should include 'my-lb' }
end

Filter the Results to Include Only those with Names Match the Given String Value

describe azure_load_balancers.where{ name.eql?('production-lb') } do
  it { should exist }
end

Filter the Results to Include Only those with Location Match the Given String Value

describe azure_load_balancers.where{ location.eql?('eastus-2') } 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 will pass if the filter returns at least one result. Use should_not if you expect zero matches.

# If we expect 'ExampleGroup' Resource Group to have Load Balancers
describe azure_load_balancers(resource_group: 'ExampleGroup') do
  it { should exist }
end

# If we expect 'EmptyExampleGroup' Resource Group to not have Load Balancers
describe azure_load_balancers(resource_group: 'ExampleGroup') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.