apim/api_management_gateway¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azurecaf_name.apim["azurecaf_name.apim"]
azurerm_api_management_gateway.apim["azurerm_api_management_gateway.apim"]
remote:api_management["remote:api_management"]
azurerm_api_management_gateway.apim --> azurecaf_name.apim
azurerm_api_management_gateway.apim --> remote:api_management
Module Reference¶
Category: apim
Path: modules/apim/api_management_gateway
Azure Resources: azurecaf_name, azurerm_api_management_gateway
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
"global_settings" |
"<<DESCRIPTION Global CAF settings, as produced by the root module. Supported attributes: - default_region, environme... | object({default_region = optional(str... |
yes | - |
- |
"client_config" |
"<<DESCRIPTION Client configuration, as produced by the root module. landingzone_key is required; client_id, object_i... | object({client_id = optional(string),... |
yes | - |
- |
"settings" |
"<<DESCRIPTION Settings for an API Management Gateway. name and location_data are required. location_data.name is the... | object({name = string, api_management... |
yes | - |
"api_management must provide either an id or a key reference." |
"remote_objects" |
"Remote API Management objects used to resolve gateway dependencies." | any |
no | {} |
- |
"base_tags" |
"Base tags inherited from the resource group." | map(any) |
no | {} |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
"The ID of the API Management Gateway." | - | azurerm_api_management_gateway.apim.id |
Sources¶
modules/apim/api_management_gateway/main.tfmodules/apim/api_management_gateway/module.tfmodules/apim/api_management_gateway/outputs.tfmodules/apim/api_management_gateway/variables.tf