apim/api_management_product¶

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_product.apim["azurerm_api_management_product.apim"] azurerm_api_management_product_policy.apim["azurerm_api_management_product_policy.apim"]

Module Reference¶

Category: apim
Path: modules/apim/api_management_product
Azure Resources: azurerm_api_management_product, azurerm_api_management_product_policy

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 product. product_id, display_name, and published are required. subscrip...	`object({product_id = string, display_...`	yes	`-`	"approval_required can only be set when subscription_required is true."; "subscriptions_limit can only be set when subscription_required is true."; "policy must configure exactly one source: xml_file/xml_content or xml_link."; "policy.xml_file must point to a readable file relative to the Terraform configuration directory."
`"remote_objects"`	"Remote objects used by the root module to resolve API Management and resource-group references."	`any`	no	`{}`	-
`"api_management_name"`	"The name of the API Management service."	`string`	yes	`-`	-
`"resource_group_name"`	"The name of the resource group containing the API Management service."	`string`	yes	`-`	-

Outputs¶

Name	Description	Sensitive	Value
`"id"`	"The ID of the API Management Product."	-	`azurerm_api_management_product.apim.id`
`"product_id"`	"The Product ID of the API Management Product."	-	`azurerm_api_management_product.apim.product_id`
`"policy_id"`	"The ID of the API Management Product Policy."	-	`one(azurerm_api_management_product_policy.apim[*].id)`

Sources¶

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