azure_active_directory_objects Resource

[edit on GitHub]

Use the azure_active_directory_objects InSpec audit resource to test 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.

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_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

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

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.

# If we expect current service principle to have AD objects

describe azure_active_directory_objects do
  it { should exist }
end

# If we expect current service principle to not 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.