azure_web_app_functions Resource

[edit on GitHub]

Use the azure_web_app_functions InSpec audit resource to test properties related to azure functions for a resource group or the entire subscription.

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

describe azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http') do
  #...
end

or

describe azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http') do
  #...
end

Parameters

resource_group

The name of the resource group.

site_name

The name of the function App.

Properties

ids

A list of the unique resource ids.

Field: id

names

A list of all the key vault names.

Field: name

types

A list of types of all the functions.

Field: type

locations

A list of locations for all the functions.

Field: location

properties

A list of properties for all the functions.

Field: properties

Examples

Loop through functions by their IDs.

azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http').ids.each do |id|
  describe azure_web_app_function(resource_id: id) do
    it { should exist }
  end
end

Test that there are functions that includes a certain string in their names (Client Side Filtering).

describe azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http').where { name.include?('queue') } do
  it { should exist }
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

# Should not exist if no functions are in the resource group

describe azure_web_app_functions(resource_group: 'MyResourceGroup', site_name: 'function-app-http') do
  it { should_not exist }
end

# Should exist if the filter returns at least one key vault

describe azure_web_app_functions(resource_group: 'MyResourceGroup', site_name: 'function-app-http') do
  it { should exist }
end

Azure Permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.