Skip to content

Latest commit

 

History

History
138 lines (90 loc) · 3.71 KB

azurerm_api_managements.md

File metadata and controls

138 lines (90 loc) · 3.71 KB
title platform
About the azurerm_api_managements Resource
azure

WARNING This resource will be deprecated in InSpec Azure Resource Pack version 2. Please start using fully backward compatible azure_api_managements InSpec audit resource.

azurerm_api_managements

Use the azurerm_api_managements InSpec audit resource to test properties and configuration of Azure Api Management Service.

Azure REST API version

This resource interacts with version 2019-12-01 of the Azure Management API. For more information see the Official Azure Documentation.

At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version.

Availability

Installation

This resource is available in the inspec-azure resource pack. To use it, add the following to your inspec.yml in your top-level profile:

depends:
  inspec-azure:
    git: https://github.com/inspec/inspec-azure.git

You'll also need to setup your Azure credentials; see the resource pack README.

Syntax

An azurerm_api_managements resource block returns all Azure Api Management Services, either within a Resource Group (if provided), or within an entire Subscription.

describe azurerm_api_managements do
  ...
end

or

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

Examples

The following examples show how to use this InSpec audit resource.

Check Api Management Services are present

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

Filter Criteria

  • name

name

Filters the results to include only those Application Gateways which match the given name. This is a string value.

describe azurerm_api_managements.where{ name.eql?('production-apim-01') } do
  it { should exist }
end
  • location

location

Filters the results to include only those Application Gateways which reside in a given location. This is a string value.

describe azurerm_api_managements.where{ location.eql?('eastus') } do
  it { should exist }
end

Attributes

  • ids
  • `names
  • locations
  • properties
  • tags
  • types

ids

Azure resource ID.

names

Api Management Service name, e.g. my-apim.

its('names') { should include 'my-apim' }

locations

Resource location, e.g. eastus.

its('locations') { should_not include 'eastus' }

properties

A collection of additional configuration properties related to the API Management Service, e.g. publisherEmail.

tags

Resource tags applied to the Api Management Service.

types

The type of Resource, typically Microsoft.ApiManagement/service.

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.

describe azurerm_api_managements do
  it { should exist }
end

Azure Permissions

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