azure_network_security_groups resource

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

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_network_security_groups resource block returns all Azure network security groups within a resource group or an entire subscription.

describe azure_network_security_groups do
  #...
end

describe azure_network_security_groups(resource_group: 'RESOURCE_GROUP') 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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

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 specified name via a 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

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

The control passes if the resource returns a result. Use should_not if you expect zero matches.

# If we expect the 'EXAMPLEGROUP' resource group to have Network Security groups.

describe azure_network_security_groups(resource_group: 'EXAMPLEGROUP') do
  it { should exist }
end

not_exists

# If we expect the '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.