azure_webapp Resource

[edit on GitHub]

Use the azure_webapp InSpec audit resource to test properties and configuration of an Azure webapp.

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

resource_group and name or the resource_id must be given as a parameter.

describe azure_webapp(resource_group: 'inspec-rg', name: 'my_app') do
  it { should exist }
end

describe azure_webapp(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group that the targeted resource resides in. MyResourceGroup.

name

Name of the webapp to test. my_webapp.

resource_id

The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}.

auth_settings_api_version

The endpoint api version for the auth_settings property. The latest version will be used unless provided.

configuration_api_version

The endpoint api version for the configuration property. The latest version will be used unless provided.

supported_stacks_api_version

The endpoint api version for the supported_stacks property. The latest version will be used unless provided.

Either one of the parameter sets can be provided for a valid query along with the optional ones:

• resource_id
• resource_group and name

Properties

auth_settings

Authentication/Authorization settings of the interrogated app with these properties.

configuration

Configuration of an app, such as platform version, default documents, virtual applications, always on, etc. For more see here.

supported_stacks

Available application frameworks and their versions with these properties.

For properties applicable to all resources, such as type, name, id, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.), eg. properties.<attribute>.

Examples

Test that a Resource Group has the Specified Webapp and Verify it’s Authentication Settings and Platform-specific Security Token Storing are Enabled .

describe azure_webapp(resource_group: 'example', name: 'webapp_name') do
  it { should exist }
  its('auth_settings.properties') { should have_attributes(enabled: true ) }
  its('configuration.properties') { should have_attributes(tokenStoreEnabled: true) }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

Test Webapp to Ensure it’s Using the Latest Supported Version of .NET

describe azure_webapp(resource_group: 'example', name: 'webapp_name') do
  it { should be_using_latest('aspnet') }
end

Test Webapp to Ensure it’s Using the Latest Supported Version of Python

describe azure_webapp(resource_group: 'example', name: 'webapp_name') do
  it { should be_using_latest('python') }
end

exists

# If we expect a resource to always exist

describe azure_webapp(resource_group: 'inspec-rg', name: 'webapp_name') do
  it { should exist }
end
# If we expect a resource to never exist

describe azure_webapp(resource_group: 'inspec-rg', name: 'webapp_name') 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.