apim/api_management_group¶

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_group.apim["azurerm_api_management_group.apim"] remote:api_management["remote:api_management"] remote:resource_group["remote:resource_group"] azurerm_api_management_group.apim --> azurecaf_name.apim azurerm_api_management_group.apim --> remote:api_management azurerm_api_management_group.apim --> remote:resource_group

Module Reference¶

Category: apim
Path: modules/apim/api_management_group
Azure Resources: azurecaf_name, azurerm_api_management_group

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 group. name, display_name, and references to api_management and resourc...	`object({name = string, display_name =...`	yes	`-`	"type must be custom, external, or system."; "api_management must provide either a key reference or a direct name."; "resource_group must provide a key, a direct name, or the legacy resource_group_key."
`"remote_objects"`	"Remote API Management services and resource groups 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 Group."	-	`azurerm_api_management_group.apim.id`

Sources¶

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