Skip to content

apim/api_management_backend

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_backend.apim["azurerm_api_management_backend.apim"] azurerm_api_management_backend.apim --> azurecaf_name.apim

Module Reference

Category: apim
Path: modules/apim/api_management_backend
Azure Resources: azurecaf_name, azurerm_api_management_backend

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 backend should be created. Changing this forces a new resource to... any yes - -
"resource_group_name" " The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be c... any yes - -

Outputs

Name Description Sensitive Value
"id" "The ID of the API Management API." - azurerm_api_management_backend.apim.id

Sources

  • modules/apim/api_management_backend/main.tf
  • modules/apim/api_management_backend/module.tf
  • modules/apim/api_management_backend/outputs.tf
  • modules/apim/api_management_backend/variables.tf