azure_managed_applications resource

Use the azure_managed_applications InSpec audit resource to test the properties related to all Azure Managed applications.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_managed_applications resource block returns all Azure Managed applications.

describe azure_managed_applications do
  #...
end

Parameters

resource_group (optional): Azure resource group where the targeted resource resides.

Properties

ids: A list of resource IDs.
Field: id
names: A list of resource Names.
Field: name
types: A list of the resource types.
Field: type
properties: A list of properties for all the Managed applications.
Field: properties
locations: A list of the resource locations.
Field: location
identities: A list of the identity of the resources.
Field: identity
plans: A list of the plan information.
Field: plan
provisioningStates: A list of provisioning states of the app.
Field: provisioningState
publisherTenantIds: A list of the publisher tenant ID.
Field: publisherTenantId

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Examples

Loop through Managed applications by their names:

azure_managed_applications(resource_group: 'RESOURCE_GROUP').names.each do |name|
  describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: name) do
    it { should exist }
  end
end

Test that there are Managed applications that are successfully provisioned:

describe azure_managed_applications(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do
  it { should exist }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

# Should not exist if no Managed applications are present.

describe azure_managed_applications(resource_group: 'RESOURCE_GROUP') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Managed application.

describe azure_managed_applications(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

Azure permissions

Your Service Principal must be set up with at least a reader role on the subscription you wish to test.