azure_active_directory_objects Resource
Use the azure_active_directory_objects
InSpec audit resource to test the properties and configuration of multiple Azure Active Directory objects.
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_active_directory_objects
resource block returns all Active Directory objects for the current service principle.
describe azure_active_directory_objects do
#...
end
Parameters
This resource does not require any parameters.
Properties
values
- A list of the unique directory object values.
Field:
value
Note
Examples
Iterate over and test the visibility of Active Directory objects
azure_active_directory_objects.values.each do |value|
describe azure_active_directory_object(id: value) do
it { should exist }
its('visibility') { should_not be_empty }
end
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 the current service principle to have AD objects.
describe azure_active_directory_objects do
it { should exist }
end
not_exists
# If we expect the current service principle not to have AD objects.
describe azure_active_directory_objects 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.