Skip to content

apim/api_management_api_diagnostic

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_api_diagnostic.apim["azurerm_api_management_api_diagnostic.apim"]

Module Reference

Category: apim
Path: modules/apim/api_management_api_diagnostic
Azure Resources: azurerm_api_management_api_diagnostic

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" "<<DESCRIPTION Settings for API Management API diagnostics. Required: identifier. Optional CAF references: api_manage... object({identifier = string, resource... yes - "identifier must be applicationinsights or azuremonitor."; "sampling_percentage must be between 0 and 100."; "verbosity must be verbose, information, or error."; "http_correlation_protocol must be None, Legacy, or W3C."; "operation_name_format must be Name or Url."
"remote_objects" "Remote objects used to resolve API Management dependencies." any no {} -
"base_tags" "Base tags for the resource to be inherited from the resource group." map(any) no {} -
"api_management_logger_id" "ID of the API Management diagnostics logger." string yes - -
"api_management_name" "Name of the API Management Service containing the API." string yes - -
"api_name" "Name of the API whose diagnostics are configured." string yes - -
"resource_group_name" "Name of the resource group containing the API Management Service." string yes - -

Outputs

Name Description Sensitive Value
"id" "The ID of the API Management Service API Diagnostics Logs." - azurerm_api_management_api_diagnostic.apim.id

Sources

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