apim/api_management_logger¶
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_logger.apim["azurerm_api_management_logger.apim"]
azurerm_api_management_logger.apim --> azurecaf_name.apim
Module Reference¶
Category: apim
Path: modules/apim/api_management_logger
Azure Resources: azurecaf_name, azurerm_api_management_logger
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 an API Management logger. name is required. Optional settings include buffered (defaults ... | object({name = string, buffered = opt... |
yes | - |
"application_insights must not set both connection_string and instrumentation_key."; "application_insights.identity_client_id requires a connection_string source and cannot be used with instrumentation_key."; "eventhub must set at least one of connection_string or endpoint_uri."; "A logger must configure exactly one of application_insights or eventhub."; "application_insights must provide a telemetry source: key, connection_string or instrumentation_key." |
"remote_objects" |
"Application Insights resources and other objects used for logger references." | any |
no | {} |
- |
"base_tags" |
"Base tags inherited from the resource group." | map(any) |
no | {} |
- |
"resource_group_name" |
"The resource group containing the API Management service." | string |
yes | - |
- |
"api_management_name" |
"The API Management service name." | string |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
"The ID of the API Management Logger." | - | azurerm_api_management_logger.apim.id |
Sources¶
modules/apim/api_management_logger/locals.tfmodules/apim/api_management_logger/main.tfmodules/apim/api_management_logger/module.tfmodules/apim/api_management_logger/outputs.tfmodules/apim/api_management_logger/variables.tf