apim/api_management_subscription¶

Overview¶

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

graph TD azurerm_api_management_subscription.apim["azurerm_api_management_subscription.apim"]

Category: apim
Path: modules/apim/api_management_subscription
Azure Resources: azurerm_api_management_subscription

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 subscription. display_name is required. Optional provider arguments inc...	`object({display_name = string, api_id...`	yes	`-`	"state must be active, cancelled, expired, rejected, submitted, or suspended."
`"remote_objects"`	"Remote objects used by the root module to resolve API Management, resource-group, and product 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	`-`	-
`"product_id"`	"Optional resolved API Management product ID. Cannot be set together with settings.api_id."	`string`	no	`-`	-

Name	Description	Sensitive	Value
`"id"`	"The ID of the API Management subscription."	-	`azurerm_api_management_subscription.apim.id`
`"primary_key"`	"The primary subscription key to use for the subscription."	true	`azurerm_api_management_subscription.apim.primary_key`
`"secondary_key"`	"The secondary subscription key to use for the subscription."	true	`azurerm_api_management_subscription.apim.secondary_key`