azure_network_security_groups Resource

[edit on GitHub]

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, 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_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)

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 network security groups.

Field: location

names

A list of all the network security group names.

Field: name

tags

A list of tag:value pairs defined on the resources.

Field: tags

etags

A list of etags defined on the resources.

Field: etag

properties

A list of all properties of all the resources.

Field: properties

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 set up with at least a reader role on the subscription you wish to test.