azure_api_management Resource

Use the azure_api_management InSpec audit resource to test the properties and configuration of an Azure API Management Service.

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.

Install

This resource is available in the Chef InSpec Azure resource pack.

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.

Syntax

resource_group and name, or the resource_id are required parameters.

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

describe azure_api_management(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ApiManagement/service/{apim01}') do
  it { should exist }
end

Parameters

resource_group: Azure resource group where the targeted resource resides.
name: The unique name of the API Management Service.
api_management_name: Alias for the name parameter.
resource_id: The unique resource ID.

Either one of the parameter sets can be provided for a valid query:

resource_id
resource_group and name
resource_group and api_management_name

Properties

identity: Managed service identity of the API Management service. It is an API Management Service.
sku: The SKU (pricing tier) of the resource.

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

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test API Management Service’s publisher Email value

describe azure_api_management(resource_group: RESOURCE_GROUP, api_management_name: API_MANAGEMENT_NAME) do
  its('properties.publisherEmail') { should eq 'company@inspec.io' }
end

Loop through resources via plural resource

azure_api_managements.ids.each do |resource_id|
  describe azure_api_management(resource_id: resource_id) do
    its('properties.publisherEmail') { should eq 'company@inspec.io' }
  end
end

See integration tests for more examples.

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 we expect 'APIM01' always to exist.

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

not_exists

# If we expect 'APIM01' to never exist.

describe azure_api_management(resource_group: 'RESOURCE_GROUP', name: 'APIM01') 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.