azure_web_app_functions resource

Use the azure_web_app_functions InSpec audit resource to test the 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. 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

An azure_web_app_functions resource block returns all Azure functions within a resource group (if provided) or an entire subscription.

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

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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Examples

Loop through functions by their IDs:

azure_web_app_functions(resource_group: 'RESOURCE_GROUP', 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 include a certain string in their names (client-side filtering):

describe azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http').where { name.include?('queue') } do
  it { should exist }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

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

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

not_exists

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

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