Skip to content

apim/api_management_custom_domain

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_custom_domain.apim["azurerm_api_management_custom_domain.apim"]

Module Reference

Category: apim
Path: modules/apim/api_management_custom_domain
Azure Resources: azurerm_api_management_custom_domain

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_id The ID of the API Management service for which to configure Custom Domains. Changing this forces a new API Management... any yes - -

Outputs

Name Description Sensitive Value
id The ID of the API Management Custom Domain. - azurerm_api_management_custom_domain.apim.id

Sources

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