azure_subscriptions Resource

[edit on GitHub]

Use the azure_subscriptions InSpec audit resource to test properties and configuration of all Azure subscriptions for a tenant.

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_subscriptions resource block returns all subscription for a tenant.

describe azure_subscriptions do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

ids

A list of the subscription ids.

Field: id

names

A list of display names of all the subscriptions.

Field: name

tags

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

Field: tags

tenant_ids

A list of tenant ids of all the subscriptions.

Field: tenant_id

Examples

Check a Specific Subscription is Present.

describe azure_subscriptions do
  its('names')  { should include 'my-subscription' }
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

The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

describe azure_subscriptions 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.