apim/api_management_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_diagnostic.apim["azurerm_api_management_diagnostic.apim"]
Module Reference¶
Category: apim
Path: modules/apim/api_management_diagnostic
Azure Resources: azurerm_api_management_diagnostic
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 diagnostic. identifier is required and accepts applicationinsights or ... | object({identifier = string, always_l... |
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."; "body_bytes must be between 0 and 8192."; "Query parameter masking mode must be Mask or Hide; header masking mode must be Mask." |
"remote_objects" |
"API Management services, resource groups, and loggers used for root dependency resolution." | any |
no | {} |
- |
"base_tags" |
"Base tags inherited from the resource group." | map(any) |
no | {} |
- |
"api_management_name" |
"The name of the API Management service." | string |
yes | - |
- |
"resource_group_name" |
"The resource group containing the API Management service." | string |
yes | - |
- |
"api_management_logger_id" |
"The ID of the API Management logger receiving diagnostic data." | string |
yes | - |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"id" |
"The ID of the API Management Diagnostic." | - | azurerm_api_management_diagnostic.apim.id |
Sources¶
modules/apim/api_management_diagnostic/main.tfmodules/apim/api_management_diagnostic/module.tfmodules/apim/api_management_diagnostic/outputs.tfmodules/apim/api_management_diagnostic/variables.tf