azure_management_groups Resource
Use the azure_management_groups
InSpec audit resource to test the properties and configuration of multiple Azure management groups.
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_management_groups
resource block returns management groups for the authenticated user.
describe azure_management_groups do
#...
end
Parameters
This resource does not require any parameters.
Properties
ids
- A list of the unique resource IDs.
Field:
id
names
- A list of names of all the resources being interrogated.
Field:
name
types
- A list of types of all the resources being interrogated.
Field:
type
properties
- A list of properties for all the resources being interrogated.
Field:
properties
Note
Examples
Test that a named Management Group exists
describe azure_management_groups do
its('names') { should include('ABCD-1234') }
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.
# If we expect at least one management group to exist.
describe azure_management_groups do
it { should exist }
end
not_exists
# If we expect zero matches.
describe azure_management_groups do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.