azure_managed_application Resource

[edit on GitHub]

Use the azure_managed_application InSpec audit resource to test properties related to an Azure managed application.

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

name, resource_group is a required parameter.

describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.ServiceBus/Namespaces' }
  its('location')                         { should eq 'East US' }
end

describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do
  it  { should exist }
end

Parameters

name (required)

Name of the Azure managed applications to test.

resource_group (required)

Azure resource group that the targeted resource resides in.

Properties

id

Resource Id.

name

Resource name.

type

Resource type. Microsoft.Solutions/applications.

location

Resource location.

properties

The properties of the managed application.

properties.plan

The plan information.

properties.identity

The identity of the resource.

properties.provisioningState

Provisioning state of the namespace.

For properties applicable to all resources, such as type, name, id, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available.

Examples

Test that the managed applications is provisioned successfully.

describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do
  its('properties.provisioningState') { should eq 'Succeeded' }
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

# If a managed application is found it will exist

describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do
  it { should exist }
end
# if managed application is not found it will not exist

describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do
  it { should_not exist }
end

Azure Permissions

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