azure_network_security_groups.md

title	platform
About the azure_network_security_groups Resource	azure

azure_network_security_groups

Use the azure_network_security_groups InSpec audit resource to enumerate Network Security Groups.

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_network_security_groups resource block returns all Azure network security groups, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_network_security_groups do
  #...
end

or

describe azure_network_security_groups(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 network security groups.	location
names	A list of all the network security group names.	name
tags	A list of tag:value pairs defined on the resources.	tags
etags	A list of etags defined on the resources.	etag

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

Examples

Test that an Example Resource Group Has the Named Network Security Group

describe azure_network_security_groups(resource_group: 'ExampleGroup') do
  its('names') { should include('ExampleNetworkSecurityGroup') }
end

Filters the Network Security Groups at Azure API to Only Those that Match the Given Name via Generic Resource (Recommended)

# Fuzzy string matching
describe azure_generic_resources(resource_provider: 'Microsoft.Network/networkSecurityGroups', substring_of_name: 'project_A') do
  it { should exist }
end

# Exact name matching
describe azure_generic_resources(resource_provider: 'Microsoft.Network/networkSecurityGroups', name: 'project_A') 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 resource returns a result. Use should_not if you expect zero matches.

# If we expect 'ExampleGroup' Resource Group to have Network Security Groups
describe azure_network_security_groups(resource_group: 'ExampleGroup') do
  it { should exist }
end

# If we expect 'EmptyExampleGroup' Resource Group to not have Network Security Groups
describe azure_network_security_groups(resource_group: 'EmptyExampleGroup') 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.