apim/api_management_api¶

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_api.apim["azurerm_api_management_api.apim"] azurerm_api_management_api.apim --> azurecaf_name.apim

Module Reference¶

Category: apim
Path: modules/apim/api_management_api
Azure Resources: azurecaf_name, azurerm_api_management_api

Inputs¶

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	`{}`	-
`"base_tags"`	"Base tags for the resource to be inherited from the resource group."	`map(any)`	no	`{}`	-
`"api_management_name"`	" The Name of the API Management Service where this API should be created. Changing this forces a new resource to be ...	`any`	yes	`-`	-
`"resource_group_name"`	" The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be creat...	`any`	yes	`-`	-

Outputs¶

Name	Description	Sensitive	Value
`"id"`	"The ID of the API Management API."	-	`azurerm_api_management_api.apim.id`
`"is_current"`	"Is this the current API Revision?"	-	`azurerm_api_management_api.apim.is_current`
`"is_online"`	"Is this API Revision online/accessible via the Gateway?"	-	`azurerm_api_management_api.apim.is_online`
`"version"`	"The Version number of this API, if this API is versioned."	-	`azurerm_api_management_api.apim.version`
`"version_set_id"`	"The ID of the Version Set which this API is associated with."	-	`azurerm_api_management_api.apim.version_set_id`
`"name"`	"The name of the API Management API."	-	`azurerm_api_management_api.apim.name`

Sources¶

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