azure_webapps Resource

[edit on GitHub]

Use the azure_webapps InSpec audit resource to test properties and configuration of multiple Azure web applications.

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_webapps resource block returns all webapps, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_webapps do
  #...
end

or

describe azure_webapps(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

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

properties

A list of properties for all the resources being interrogated.

Field: properties

Examples

Test that an Example Resource Group has the Named Web Application.

describe azure_webapps(resource_group: 'ExampleGroup') do
  its('names') { should include('my_web_app') }
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 filter returns at least one result. Use should_not if you expect zero matches.

# If we expect 'ExampleGroup' Resource Group to have at least one web application
describe azure_webapps(resource_group: 'ExampleGroup') do
  it { should exist }
end

# If we expect 'EmptyExampleGroup' Resource Group to not have any web applications
describe azure_webapps(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.