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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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
Or
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.