azure_api_managements Resource

[edit on GitHub]

Use the azure_api_managements InSpec audit resource to test properties and configuration of Azure API Management Services.

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_api_managements resource block returns all Azure Api Management Services, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_api_managements do
  #...
end

or

describe azure_api_managements(resource_group: 'my-rg') do
  #...
end

Parameters

resource_group (optional)

The name of the resource group.

Properties

ids

A list of the unique resource ids.

Field: id

locations

A list of locations for all the resources being interrogated.

Field: location

names

A list of names of all the resources being interrogated.

Field: name

tags

A list of tag:value pairs defined on the resources being interrogated.

Field: tags

types

A list of the types of resources being interrogated.

Field: type

properties

A list of properties for all the resources being interrogated.

Field: properties

Examples

Check Api Management Services are Present.

describe azure_api_managements do
  it            { should exist }
  its('names')  { should include 'my-apim' }
end

Filter the Results to Include Only those with Names Match the Given String Value.

describe azure_api_managements.where{ name.eql?('production-apim-01') } do
  it { should exist }
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 'ExampleGroup' Resource Group to have API Management Services
describe azure_api_managements(resource_group: 'ExampleGroup') do
  it { should exist }
end

# If we expect 'EmptyExampleGroup' Resource Group to not have API Management Services
describe azure_api_managements(resource_group: 'EmptyExampleGroup') 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.