azure_webapp resource

Use the azure_webapp InSpec audit resource to test the 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. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

resource_group and name or the resource_id are required parameters.

describe azure_webapp(resource_group: 'RESOURCE_GROUP', 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 where the targeted resource resides.

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, or always on. For more information, see the Azure Web Apps SiteConfigResource documentation.

supported_stacks

Available application frameworks and their versions with these properties.

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

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.). For example, properties.<attribute>.

Examples

Test that a resource group has the specified Webapp and verify it’s authentication settings:, platform-specific security token storing is 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 resource has the following special matchers.

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: 'RESOURCE_GROUP', name: 'WEBAPP_NAME') do
  it { should exist }
end

not_exists

# If we expect a resource to never exist.

describe azure_webapp(resource_group: 'RESOURCE_GROUP', 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.