This terraform module streamlines the setup and management of the Azure API Management service, providing customizable configurations for an API Management service, as well as creating custom domains and application insights and Redis Cache integration.
The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.
The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.
A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.
A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.
These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.
They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.
Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.
End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.
- Create and manage API Management service
- Make use of custom domains for management, portal, developer portal and scm.
- Add API's
- Add an Application Insights instance for logging
- Add an Azure Cache for Redis for caching
- Add AAD Identity provider
- Add products and users
| Name | Version |
|---|---|
| terraform | >= 1.9.3 |
| azurerm | ~> 4.0 |
| Name | Version |
|---|---|
| azurerm | ~> 4.0 |
| Name | Type |
|---|---|
| azurerm_api_management.apim | resource |
| azurerm_api_management_api.api | resource |
| azurerm_api_management_custom_domain.apim | resource |
| azurerm_api_management_identity_provider_aad.provider | resource |
| azurerm_api_management_logger.logger | resource |
| azurerm_api_management_product.product | resource |
| azurerm_api_management_redis_cache.apim | resource |
| azurerm_api_management_user.user | resource |
| azurerm_role_assignment.apimcert | resource |
| azurerm_user_assigned_identity.identity | resource |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| config | describes the apim configuration | any |
n/a | yes |
| location | default azure region to be used. | string |
null |
no |
| resource_group | default resource group to be used. | string |
null |
no |
| tags | tags to be added to the resources | map(string) |
{} |
no |
| Name | Description |
|---|---|
| config | contains all redis cache configuration |
| user_assigned_identities | contains all user assigned identities configuration |
For more information, please see our goals and non-goals.
For more information, please see our testing guidelines
Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes.
Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory.
To update the module's documentation run make doc
We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.
For more information, please see our contribution guidelines.
MIT Licensed. See LICENSE for full details.