{"id":19129455,"url":"https://github.com/launchbynttdata/tf-azurerm-module_primitive-api_management","last_synced_at":"2026-05-13T13:46:07.402Z","repository":{"id":241178807,"uuid":"804522574","full_name":"launchbynttdata/tf-azurerm-module_primitive-api_management","owner":"launchbynttdata","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-23T15:05:29.000Z","size":76,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-23T16:22:21.559Z","etag":null,"topics":["azure","infrastructure-as-code","platform-automation","primitive","terraform"],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/launchbynttdata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-22T18:42:09.000Z","updated_at":"2025-01-13T15:18:43.000Z","dependencies_parsed_at":"2024-12-06T17:35:12.232Z","dependency_job_id":null,"html_url":"https://github.com/launchbynttdata/tf-azurerm-module_primitive-api_management","commit_stats":null,"previous_names":["launchbynttdata/tf-azurerm-module_primitive-api_management"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_primitive-api_management","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_primitive-api_management/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_primitive-api_management/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_primitive-api_management/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/launchbynttdata","download_url":"https://codeload.github.com/launchbynttdata/tf-azurerm-module_primitive-api_management/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240199258,"owners_count":19763827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure","infrastructure-as-code","platform-automation","primitive","terraform"],"created_at":"2024-11-09T06:07:33.255Z","updated_at":"2025-11-13T13:01:38.562Z","avatar_url":"https://github.com/launchbynttdata.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-azurerm-module_primitive-api_management\n\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)\n\n## Overview\n\nThis module provisions an Azure API Management instance.\n\n## Pre-Commit hooks\n\n[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.\n\n`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:\n\n- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).\n- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).\n- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.\nfooters other than BREAKING CHANGE: \u003cdescription\u003e may be provided and follow a convention similar to git trailer format.\n- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)\n- **chore**: a commit of the type `chore` adds changes that don't modify src or test files\n- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)\n- **docs**: a commit of the type `docs` adds documentation only changes\n- **perf**: a commit of the type `perf` adds code change that improves performance\n- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature\n- **revert**: a commit of the type `revert` reverts a previous commit\n- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n- **test**: a commit of the type `test` adds missing tests or correcting existing tests\n\nBase configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)\n\nIf you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.\n\n`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS\n\nIn order for `pre-commit` hooks to work properly\n\n- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.\n- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below\n\n```\npre-commit install --hook-type commit-msg\n```\n\n## To test the resource group module locally\n\n1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.\n\n```\nmake configure\n```\n\nThis adds in several files and directories that are ignored by `git`. They expose many new Make targets.\n\n2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.\n\n`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.\n\nThese environment variables are used by `terratest` integration suit.\n\nService principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.\n\n```\n\"Microsoft.Resources/subscriptions/resourceGroups/write\"\n\"Microsoft.Resources/subscriptions/resourceGroups/read\"\n\"Microsoft.Resources/subscriptions/resourceGroups/delete\"\n```\n\nThen run this make target to set the environment variables on developer workstation.\n\n```\nmake env\n```\n\n3. The first target you care about is `check`.\n\n**Pre-requisites**\nBefore running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.\n\n- A file named `provider.tf` with contents below\n\n```\nprovider \"azurerm\" {\n  features {}\n}\n```\n\n- A file named `terraform.tfvars` which contains key value pair of variables used.\n\nNote that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.\n\nAfter creating these files, for running tests associated with the primitive/segment, run\n\n```\nmake check\n```\n\nIf `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.\n\n`make check` target\n\n- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.\n- runs `conftests`. `conftests` make sure `policy` checks are successful.\n- runs `terratest`. This is integration test suit.\n- runs `opa` tests\n\u003c!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | ~\u003e 1.5 |\n| \u003ca name=\"requirement_azurerm\"\u003e\u003c/a\u003e [azurerm](#requirement\\_azurerm) | ~\u003e3.67 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_azurerm\"\u003e\u003c/a\u003e [azurerm](#provider\\_azurerm) | 3.117.0 |\n\n## Modules\n\nNo modules.\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [azurerm_api_management.apim](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/api_management) | resource |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_name\"\u003e\u003c/a\u003e [name](#input\\_name) | Name of the API Management Service | `string` | n/a | yes |\n| \u003ca name=\"input_resource_group_name\"\u003e\u003c/a\u003e [resource\\_group\\_name](#input\\_resource\\_group\\_name) | Name of the resource group | `string` | n/a | yes |\n| \u003ca name=\"input_location\"\u003e\u003c/a\u003e [location](#input\\_location) | Azure location for Eventhub. | `string` | n/a | yes |\n| \u003ca name=\"input_sku_name\"\u003e\u003c/a\u003e [sku\\_name](#input\\_sku\\_name) | String consisting of two parts separated by an underscore. The fist part is the name, valid values include: Developer, Basic, Standard and Premium. The second part is the capacity | `string` | `\"Basic_1\"` | no |\n| \u003ca name=\"input_publisher_name\"\u003e\u003c/a\u003e [publisher\\_name](#input\\_publisher\\_name) | The name of publisher/company. | `string` | n/a | yes |\n| \u003ca name=\"input_publisher_email\"\u003e\u003c/a\u003e [publisher\\_email](#input\\_publisher\\_email) | The email of publisher/company. | `string` | n/a | yes |\n| \u003ca name=\"input_additional_location\"\u003e\u003c/a\u003e [additional\\_location](#input\\_additional\\_location) | List of the name of the Azure Region in which the API Management Service should be expanded to. | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_zones\"\u003e\u003c/a\u003e [zones](#input\\_zones) | (Optional) Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created. Supported in Premium Tier. | `list(number)` | `[]` | no |\n| \u003ca name=\"input_certificate_configuration\"\u003e\u003c/a\u003e [certificate\\_configuration](#input\\_certificate\\_configuration) | List of certificate configurations | \u003cpre\u003elist(object({\u003cbr\u003e    encoded_certificate  = string\u003cbr\u003e    certificate_password = string\u003cbr\u003e    store_name           = string\u003cbr\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_client_certificate_enabled\"\u003e\u003c/a\u003e [client\\_certificate\\_enabled](#input\\_client\\_certificate\\_enabled) | (Optional) Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is `Consumption`. | `bool` | `false` | no |\n| \u003ca name=\"input_gateway_disabled\"\u003e\u003c/a\u003e [gateway\\_disabled](#input\\_gateway\\_disabled) | (Optional) Disable the gateway in main region? This is only supported when `additional_location` is set. | `bool` | `false` | no |\n| \u003ca name=\"input_min_api_version\"\u003e\u003c/a\u003e [min\\_api\\_version](#input\\_min\\_api\\_version) | (Optional) The version which the control plane API calls to API Management service are limited with version equal to or newer than. | `string` | `null` | no |\n| \u003ca name=\"input_enable_http2\"\u003e\u003c/a\u003e [enable\\_http2](#input\\_enable\\_http2) | Should HTTP/2 be supported by the API Management Service? | `bool` | `false` | no |\n| \u003ca name=\"input_management_hostname_configuration\"\u003e\u003c/a\u003e [management\\_hostname\\_configuration](#input\\_management\\_hostname\\_configuration) | List of management hostname configurations | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_scm_hostname_configuration\"\u003e\u003c/a\u003e [scm\\_hostname\\_configuration](#input\\_scm\\_hostname\\_configuration) | List of scm hostname configurations | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_proxy_hostname_configuration\"\u003e\u003c/a\u003e [proxy\\_hostname\\_configuration](#input\\_proxy\\_hostname\\_configuration) | List of proxy hostname configurations | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_portal_hostname_configuration\"\u003e\u003c/a\u003e [portal\\_hostname\\_configuration](#input\\_portal\\_hostname\\_configuration) | Legacy portal hostname configurations | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_developer_portal_hostname_configuration\"\u003e\u003c/a\u003e [developer\\_portal\\_hostname\\_configuration](#input\\_developer\\_portal\\_hostname\\_configuration) | Developer portal hostname configurations | `list(map(string))` | `[]` | no |\n| \u003ca name=\"input_notification_sender_email\"\u003e\u003c/a\u003e [notification\\_sender\\_email](#input\\_notification\\_sender\\_email) | Email address from which the notification will be sent | `string` | `null` | no |\n| \u003ca name=\"input_policy_configuration\"\u003e\u003c/a\u003e [policy\\_configuration](#input\\_policy\\_configuration) | Map of policy configuration | `map(string)` | `{}` | no |\n| \u003ca name=\"input_public_network_access_enabled\"\u003e\u003c/a\u003e [public\\_network\\_access\\_enabled](#input\\_public\\_network\\_access\\_enabled) | Should the API Management Service be accessible from the public internet?\u003cbr\u003e    This option is applicable only to the Management plane, not the API gateway or Developer portal.\u003cbr\u003e    It is required to be true on the creation. | `bool` | `true` | no |\n| \u003ca name=\"input_public_ip_address_id\"\u003e\u003c/a\u003e [public\\_ip\\_address\\_id](#input\\_public\\_ip\\_address\\_id) | The ID of the public IP address to use for the API Management Service | `string` | `null` | no |\n| \u003ca name=\"input_enable_sign_in\"\u003e\u003c/a\u003e [enable\\_sign\\_in](#input\\_enable\\_sign\\_in) | Should anonymous users be redirected to the sign in page? | `bool` | `false` | no |\n| \u003ca name=\"input_enable_sign_up\"\u003e\u003c/a\u003e [enable\\_sign\\_up](#input\\_enable\\_sign\\_up) | Can users sign up on the development portal? | `bool` | `false` | no |\n| \u003ca name=\"input_terms_of_service_configuration\"\u003e\u003c/a\u003e [terms\\_of\\_service\\_configuration](#input\\_terms\\_of\\_service\\_configuration) | Map of terms of service configuration | `list(map(string))` | \u003cpre\u003e[\u003cbr\u003e  {\u003cbr\u003e    \"consent_required\": false,\u003cbr\u003e    \"enabled\": false,\u003cbr\u003e    \"text\": \"\"\u003cbr\u003e  }\u003cbr\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_security_configuration\"\u003e\u003c/a\u003e [security\\_configuration](#input\\_security\\_configuration) | Map of security configuration | `map(string)` | `{}` | no |\n| \u003ca name=\"input_virtual_network_type\"\u003e\u003c/a\u003e [virtual\\_network\\_type](#input\\_virtual\\_network\\_type) | The type of virtual network you want to use, valid values include: None, External, Internal. | `string` | `\"None\"` | no |\n| \u003ca name=\"input_virtual_network_configuration\"\u003e\u003c/a\u003e [virtual\\_network\\_configuration](#input\\_virtual\\_network\\_configuration) | The id(s) of the subnet(s) that will be used for the API Management. Required when virtual\\_network\\_type is External or Internal | `list(string)` | `[]` | no |\n| \u003ca name=\"input_identity_type\"\u003e\u003c/a\u003e [identity\\_type](#input\\_identity\\_type) | Type of Managed Service Identity that should be configured on this API Management Service | `string` | `\"SystemAssigned\"` | no |\n| \u003ca name=\"input_identity_ids\"\u003e\u003c/a\u003e [identity\\_ids](#input\\_identity\\_ids) | A list of IDs for User Assigned Managed Identity resources to be assigned. This is required when type is set to UserAssigned or SystemAssigned, UserAssigned. | `list(string)` | `null` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | A mapping of tags to assign to the resource. | `map(string)` | `{}` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_api_management_name\"\u003e\u003c/a\u003e [api\\_management\\_name](#output\\_api\\_management\\_name) | The name of the API Management Service |\n| \u003ca name=\"output_api_management_id\"\u003e\u003c/a\u003e [api\\_management\\_id](#output\\_api\\_management\\_id) | The ID of the API Management Service |\n| \u003ca name=\"output_api_management_additional_location\"\u003e\u003c/a\u003e [api\\_management\\_additional\\_location](#output\\_api\\_management\\_additional\\_location) | Map listing gateway\\_regional\\_url and public\\_ip\\_addresses associated |\n| \u003ca name=\"output_api_management_gateway_url\"\u003e\u003c/a\u003e [api\\_management\\_gateway\\_url](#output\\_api\\_management\\_gateway\\_url) | The URL of the Gateway for the API Management Service |\n| \u003ca name=\"output_api_management_gateway_regional_url\"\u003e\u003c/a\u003e [api\\_management\\_gateway\\_regional\\_url](#output\\_api\\_management\\_gateway\\_regional\\_url) | The Region URL for the Gateway of the API Management Service |\n| \u003ca name=\"output_api_management_management_api_url\"\u003e\u003c/a\u003e [api\\_management\\_management\\_api\\_url](#output\\_api\\_management\\_management\\_api\\_url) | The URL for the Management API associated with this API Management service |\n| \u003ca name=\"output_api_management_portal_url\"\u003e\u003c/a\u003e [api\\_management\\_portal\\_url](#output\\_api\\_management\\_portal\\_url) | The URL for the Publisher Portal associated with this API Management service |\n| \u003ca name=\"output_api_management_public_ip_addresses\"\u003e\u003c/a\u003e [api\\_management\\_public\\_ip\\_addresses](#output\\_api\\_management\\_public\\_ip\\_addresses) | The Public IP addresses of the API Management Service |\n| \u003ca name=\"output_api_management_private_ip_addresses\"\u003e\u003c/a\u003e [api\\_management\\_private\\_ip\\_addresses](#output\\_api\\_management\\_private\\_ip\\_addresses) | The Private IP addresses of the API Management Service |\n| \u003ca name=\"output_api_management_scm_url\"\u003e\u003c/a\u003e [api\\_management\\_scm\\_url](#output\\_api\\_management\\_scm\\_url) | The URL for the SCM Endpoint associated with this API Management service |\n| \u003ca name=\"output_api_management_identity\"\u003e\u003c/a\u003e [api\\_management\\_identity](#output\\_api\\_management\\_identity) | The identity of the API Management |\n\u003c!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_primitive-api_management","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_primitive-api_management","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_primitive-api_management/lists"}