Skip to content

Latest commit

 

History

History
104 lines (79 loc) · 4.5 KB

azure_api_management.md

File metadata and controls

104 lines (79 loc) · 4.5 KB
Raw
title platform
About the azure_api_management Resource
azure

azure_api_management

Use the azure_api_management InSpec audit resource to test 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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

resource_group and name or the resource_id must be given as a parameter.

describe azure_api_management(resource_group: 'inspec-resource-group-9', name: 'apim01') 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

Name Description
resource_group Azure resource group that the targeted resource resides in. MyResourceGroup
name The unique name of the API Management Service. apim01
api_management_name Alias for the name parameter.
resource_id The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ApiManagement/service/{apim01}

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

Property Description
identity Managed service identity of the Api Management service. It is an api management service identity object.
sku The SKU (pricing tier) of the resource.

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. 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' to always exist
describe azure_api_management(resource_group: 'example', name: 'apim01') do
  it { should exist }
end

# If we expect 'apim01' to never exist
describe azure_api_management(resource_group: 'example', name: 'apim01') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.