Azure API Management API Diagnostic
This page shows how to write Terraform and Azure Resource Manager for API Management API Diagnostic and write them securely.
azurerm_api_management_api_diagnostic (Terraform)
The API Diagnostic in API Management can be configured in Terraform with the resource name azurerm_api_management_api_diagnostic
. The following sections describe 6 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "azurerm_api_management_api_diagnostic" "this" {
identifier = "applicationinsights"
resource_group_name = var.resource_group_name
api_management_name = var.api_management_name
api_name = var.api_name
api_management_logger_id = var.api_management_logger_id
resource "azurerm_api_management_api_diagnostic" "hmi_apim_diag" {
resource_group_name = azurerm_resource_group.hmi_apim_rg.name
api_management_name = azurerm_api_management.hmi_apim.name
api_name = azurerm_api_management_api.hmi_apim_api.name
api_management_logger_id = azurerm_api_management_logger.hmi_apim_logger.id
identifier = "applicationinsights"
resource "azurerm_api_management_api_diagnostic" "pip_apim_diag" {
resource_group_name = azurerm_resource_group.pip_apim_rg.name
api_management_name = azurerm_api_management.pip_apim.name
api_name = azurerm_api_management_api.pip_apim_api.name
api_management_logger_id = azurerm_api_management_logger.pip_apim_logger.id
identifier = "applicationinsights"
resource "azurerm_api_management_api_diagnostic" "api" {
identifier = "applicationinsights"
resource_group_name = var.context.resource_group_name
api_management_name = var.service_settings.endpoint_name
api_name = azurerm_api_management_api.api.name
resource "azurerm_api_management_api_diagnostic" "api_diagnostic" {
resource_group_name = var.resource_group_name
api_management_name = var.api_management_name
api_name = azurerm_api_management_api.api.name
api_management_logger_id = azurerm_api_management_logger.apim_logger.id
identifier = "applicationinsights"
resource "azurerm_api_management_api_diagnostic" "diagnostic" {
for_each = toset(var.api_names)
identifier = "applicationinsights"
resource_group_name = var.resource_group_name
api_management_name = var.api_management_name
api_name = each.key
Parameters
-
always_log_errors
optional computed - bool -
api_management_logger_id
required - string -
api_management_name
required - string -
api_name
required - string -
http_correlation_protocol
optional computed - string -
id
optional computed - string -
identifier
required - string -
log_client_ip
optional computed - bool -
resource_group_name
required - string -
sampling_percentage
optional computed - number -
verbosity
optional computed - string -
backend_request
list block-
body_bytes
optional - number -
headers_to_log
optional - set of string
-
-
backend_response
list block-
body_bytes
optional - number -
headers_to_log
optional - set of string
-
-
frontend_request
list block-
body_bytes
optional - number -
headers_to_log
optional - set of string
-
-
frontend_response
list block-
body_bytes
optional - number -
headers_to_log
optional - set of string
-
-
timeouts
single block
Explanation in Terraform Registry
Manages a API Management Service API Diagnostics Logs.
Microsoft.ApiManagement/service/apis/diagnostics (Azure Resource Manager)
The service/apis/diagnostics in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/apis/diagnostics
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
apiVersion
required - stringname
required - stringDiagnostic identifier. Must be unique in the current API Management service instance.
properties
requiredalwaysLog
optional - stringSpecifies for what type of messages sampling settings should not apply.
backend
optionalrequest
optionalbody
optionalbytes
optional - integerNumber of request body bytes to log.
dataMasking
optionalheaders
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
queryParams
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
headers
optional - arrayArray of HTTP Headers to log.
response
optionalbody
optionalbytes
optional - integerNumber of request body bytes to log.
dataMasking
optionalheaders
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
queryParams
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
headers
optional - arrayArray of HTTP Headers to log.
frontend
optionalrequest
optionalbody
optionalbytes
optional - integerNumber of request body bytes to log.
dataMasking
optionalheaders
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
queryParams
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
headers
optional - arrayArray of HTTP Headers to log.
response
optionalbody
optionalbytes
optional - integerNumber of request body bytes to log.
dataMasking
optionalheaders
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
queryParams
optional arraymode
optional - stringData masking mode.
value
optional - stringThe name of an entity to mask (e.g. a name of a header or a query parameter).
headers
optional - arrayArray of HTTP Headers to log.
httpCorrelationProtocol
optional - stringSets correlation protocol to use for Application Insights diagnostics.
logClientIp
optional - booleanLog the ClientIP. Default is false.
loggerId
required - stringResource Id of a target logger.
operationNameFormat
optional - stringThe format of the Operation Name for Application Insights telemetries. Default is Name.
sampling
optionalpercentage
optional - numberRate of sampling for fixed-rate sampling.
samplingType
optional - stringSampling type.
verbosity
optional - stringThe verbosity level applied to traces emitted by trace policies.
type
required - string
Frequently asked questions
What is Azure API Management API Diagnostic?
Azure API Management API Diagnostic is a resource for API Management of Microsoft Azure. Settings can be wrote in Terraform.
Where can I find the example code for the Azure API Management API Diagnostic?
For Terraform, the madsstorm/terraform-commercetools-azure-sample, hmcts/hmi-api-gateway-fh and hmcts/pip-api-gateway source code examples are useful. See the Terraform Example section for further details.