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"`	"Global settings object (see module README.md)"	`any`	yes	`-`	-
`"client_config"`	"Client configuration object (see module README.md)."	`any`	yes	`-`	-
`"settings"`	"(Required) Used to handle passthrough paramenters."	`any`	yes	`-`	-
`"remote_objects"`	"Remote objects configuration."	`any`	no	`{}`	-
`"api_management_name"`	" The Name of the API Management Service where this subscription should be created. Changing this forces a new resour...	`any`	yes	`-`	-
`"resource_group_name"`	" The Name of the Resource Group where the API Management subscription exists. Changing this forces a new resource to...	`any`	yes	`-`	-
`"product_id"`	"The ID of the API Management Product within the API Management Service. Changing this forces a new resource to be cr...	`any`	yes	`-`	-

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`