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"]
remote:keyvault_certificate_requests["remote:keyvault_certificate_requests"]
remote:keyvault_certificates["remote:keyvault_certificates"]
remote:managed_identities["remote:managed_identities"]
azurerm_api_management_custom_domain.apim --> remote:keyvault_certificate_requests
azurerm_api_management_custom_domain.apim --> remote:keyvault_certificates
azurerm_api_management_custom_domain.apim --> remote:managed_identities
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" |
"<<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 the API Management custom-domain resource. api_management identifies the API Management s... | object({api_management = optional(obj... |
yes | - |
"Every legacy gateways or proxy entry must define host_name." |
"remote_objects" |
"Key Vault certificates, certificate requests, and managed identities used by endpoint settings." | any |
no | {} |
- |
"api_management_id" |
"The ID of the API Management service to configure." | string |
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/locals.tfmodules/apim/api_management_custom_domain/main.tfmodules/apim/api_management_custom_domain/module.tfmodules/apim/api_management_custom_domain/outputs.tfmodules/apim/api_management_custom_domain/variables.tf