azure_subscriptions Resource
Use the azure_subscriptions
InSpec audit resource to test the 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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
Syntax
An azure_subscriptions
resource block returns all subscriptions 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
Note
Examples
Check a specific subscription is present
describe azure_subscriptions do
its('names') { should include 'my-subscription' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
The control passes 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.