azure_generic_resources Resource

[edit on GitHub]

Use the azure_generic_resources Inspec audit resource to test any valid Azure resources.

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

This resource will interrogate all resource in your subscription available through Azure Resource Manager when initiated without a parameter.

describe azure_generic_resources do
  it { should exist }
end

Parameters

The following parameters can be passed for targeting Azure resources. All of them are optional.

resource_group

Azure resource group that the targeted resources have been created in.

Example: MyResourceGroup

substring_of_resource_group

Substring of an Azure resource group name that the targeted resources have been created in.

Example: My

name

Name of the Azure resources to test.

Example: MyVM

substring_of_name

Substring of a name of the Azure resources to test.

Example: My

resource_provider

Azure resource provider of the resources to be tested.

Example: Microsoft.Compute/virtualMachines

tag_name<superscript>*</superscript>

Tag name defined on the Azure resources.

Example: name

tag_value

Tag value of the tag defined with the tag_name.

Example: external_linux

resource_uri

Azure REST API URI of the resources to be tested. This parameter should be used when resources do not reside in resource groups. It requires add_subscription_id parameter to be provided together.

Example: /providers/Microsoft.Authorization/policyDefinitions/

add_subscription_id

Indicates whether the resource_uri contains the subscription id.

Example: true or false

filter_free_text

Filter expression for the endpoints supporting $filter parameter, eg. Azure role assignments. This can only be used with the resource_uri parameter.

Example: "atScope()" * When resources are filtered by a tag name and value, the tags for each resource are not returned in the results.

Either one of the parameter sets can be provided for a valid query:

• resource_group
• substring_of_resource_group
• name
• substring_of_name
• substring_of_resource_group and substring_of_name
• resource_provider
• resource_group and resource_provider
• substring_of_resource_group and resource_provider
• tag_name
• tag_name and tag_value
• add_subscription_id and resource_uri
• add_subscription_id, resource_uri and filter_free_text

Different parameter combinations can be tried. If it is not supported either the InSpec resource or the Azure Rest API will raise an error.

It is advised to use these parameter sets to narrow down the targeted resources at the server side, Azure Rest API, for a more computing resource efficient test.

Properties

ids

A list of the unique resource ids.

Field: id

names

A list of the resource names that are unique within a resource group.

Field: name

tags

A list of tag:value pairs defined on the resources.

Field: tags

types

A list of resource types.

Field: type

locations

A list of locations where resources are created in.

Field: location

created_times<superscript>**</superscript>

A list of created times of the resources.

Field: created_time

changed_times<superscript>**</superscript>

A list of changed times of the resources.

Field: changed_time

provisioning_states<superscript>**</superscript>

A list of provisioning states of the resources.

Field: provisioning_state

** These properties are not available when resource_uri is used.

Examples

Test All Virtual Machines in Your Subscription.

describe azure_generic_resources(resource_provider: 'Microsoft.Compute/virtualMachines') do
  it { should exist }
  its('count') { should eq 43 }
end

Test All Resources Regardless of Their Type and Resource Group with a Common String in Their Names (Server Side Filtering).

azure_generic_resources(substring_of_name: 'project_a').ids.each do |id|
  describe azure_generic_resource(resource_id: id) do
    it { should exist }
    its('location') { should eq 'eastus' }
  end
end

Test All Resources Regardless of Their Type and Resource Group with a Common Tag name:value Pair (Server Side Filtering).

azure_generic_resources(tag_name: 'demo', tag_value: 'shutdown_at_10_pm').ids.each do |id| 
  describe azure_generic_resource(resource_id: id) do
    it { should exist }
    its('location') { should eq 'eastus' }
  end
end

Filters the Results to Only Include Those that Match the Given Location (Client Side Filtering).

describe azure_generic_resources.where(location: 'eastus') do
  it { should exist }
end

Filters the Results to Only Include Those that Created within Last 24 Hours (Client Side Filtering).

describe azure_generic_resources.where{ created_time > Time.now - 86400 } do
  it { should exist }
end

Test Policy Definitions.

describe azure_generic_resources(add_subscription_id: true, resource_uri: 'providers/Microsoft.Authorization/policyDefinitions') do
  it { should exist }
end

Filter Role Assignments via filter_free_text.

describe azure_generic_resources(add_subscription_id: true, resource_uri: "providers/Microsoft.Authorization/roleAssignments", filter_free_text: "atScope()+and+assignedTo('{abcd1234-abcd-1234}')") do
  it { should exist }
end

Please see here for more information on how to leverage FilterTable capabilities on plural resources.

For more examples, please see the integration tests.

Matchers

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

exist

# Should not exist if there is no resource with a given resource group

describe azure_generic_resources(resource_group: 'fake_group') do
  it { should_not exist }
end

# Should exist if there is at least one resource

describe azure_generic_resources(resource_group: 'MyResourceGroup') 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.