apim/api_management_gateway_api¶

Overview¶

This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.

Dependency diagram (Mermaid)¶

graph TD azurerm_api_management_gateway_api.apim["azurerm_api_management_gateway_api.apim"] remote:api_management_api["remote:api_management_api"] remote:api_management_gateway["remote:api_management_gateway"] azurerm_api_management_gateway_api.apim --> remote:api_management_api azurerm_api_management_gateway_api.apim --> remote:api_management_gateway

Module Reference¶

Category: apim
Path: modules/apim/api_management_gateway_api
Azure Resources: azurerm_api_management_gateway_api

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 associating an API Management API with a gateway. Both api_management_gateway and api_man...	`object({api_management_gateway = opti...`	yes	`-`	"api_management_gateway must provide either an id or a key reference."; "api_management_api must provide either an id or a key reference."
`"remote_objects"`	"Remote API Management APIs and gateways used to resolve references."	`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 API."	-	`azurerm_api_management_gateway_api.apim.id`

Sources¶

modules/apim/api_management_gateway_api/main.tf
modules/apim/api_management_gateway_api/module.tf
modules/apim/api_management_gateway_api/outputs.tf
modules/apim/api_management_gateway_api/variables.tf