azure_api_managements resource

Use the azure_api_managements InSpec audit resource to test the 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. 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_api_managements resource block returns all Azure API Management Services, either within a Resource Group (if provided) or an entire Subscription.

describe azure_api_managements do
  #...
end

describe azure_api_managements(resource_group: 'RESOURCE_GROUP') 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

Note

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

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 that match the specified string value:

describe azure_api_managements.where{ name.eql?('production-apim-01') } 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

The control passes 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

not_exists

# If we expect 'EMPTYEXAMPLEGROUP' Resource Group not to 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.