azure_network_watchers Resource
Use the azure_network_watchers
InSpec audit resource to test the properties and configuration of multiple Azure Network Watchers.
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_watchers
resource block returns all network watchers within a resource group (if provided) or an entire subscription.
describe azure_network_watchers do
#...
end
or
describe azure_network_watchers(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 resources being interrogated.
Field:
location
names
- A list of names of all the resources being interrogated.
Field:
name
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
Note
Examples
Test that an example resource group has the named Network Watcher
describe azure_network_watchers(resource_group: 'EXAMPLEGROUP') do
its('names') { should include('NetworkWatcherName') }
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 filter returns at least one result. Use should_not
if you expect zero matches.
# If we expect 'EXAMPLEGROUP' resource group to have Network Watchers.
describe azure_network_watchers(resource_group: 'ExampleGroup') do
it { should exist }
end
not_exists
# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have Network Watchers.
describe azure_network_watchers(resource_group: 'EMPTYEXAMPLEGROUP') do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.