azurerm_network_watcher

Use the azurerm_network_watcher InSpec audit resource to test properties of an Azure Network Watcher.


Azure REST API version

This resource interacts with version 2018-02-01 of the Azure Management API. For more information see the official Azure documentation.

At the moment, there doesn’t appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version.

Availability

Installation

This resource is available in the inspec-azure resource pack. To use it, add the following to your inspec.yml in your top-level profile:

depends:
  inspec-azure:
    git: https://github.com/inspec/inspec-azure.git

You’ll also need to setup your Azure credentials; see the resource pack README.

Syntax

An azurerm_network_watcher resource block identifies a Network Watcher by name and resource group.

describe azurerm_network_watcher(resource_group: 'example', name: 'WatcherName') do
  ...
end


Examples

Test that an example Resource Group has the specified Network Watcher

describe azurerm_network_watcher(resource_group: 'example', name: 'WatcherName') do
  it { should exist }
end

Test that an example Resource Group has a Network Watcher with the Provisioning State value ‘Succeeded’

describe azurerm_network_watcher(resource_group: 'example', name: 'WatcherName') do
  its('provisioning_state') { should eq 'Succeeded' }
end


Parameters

  • name
  • resource_group

Parameter Examples

The Resource Group as well as the Network Watcher name.

describe azurerm_network_watcher(resource_group: 'example', name: 'WatcherName') do
  its('provisioning_state') { should eq 'Succeeded' }
end

Attributes

  • provisioning_state

provisioning_state

The provisioning_state field can be checked for the value of the Provisioning State.

its('provisioning_state') { should eq 'Succeeded' }

Other Attributes

There are additional attributes that may be accessed that we have not documented. Please take a look at the Azure documentation. Any attribute in the response may be accessed with the key names separated by dots (.).

The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you’ll be able to guard against nil keys. Pull requests are always welcome.

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 'WatcherName' to always exist
describe azurerm_network_watcher(resource_group: 'example', name: 'WatcherName') do
  it { should exist }
end

# If we expect 'WatcherNotFound' to never exist
describe azurerm_network_watcher(resource_group: 'example', name: 'WatcherNotFound') 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.