Microsoft.ApiManagement service/loggers 2017-03-01

Template format

To create a Microsoft.ApiManagement/service/loggers resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service/loggers",
  "apiVersion": "2017-03-01",
  "properties": {
    "loggerType": "string",
    "description": "string",
    "credentials": {},
    "isBuffered": "boolean",
    "sampling": {
      "properties": {
        "samplingType": "string",
        "percentage": "number",
        "maxTelemetryItemsPerSecond": "integer",
        "evaluationInterval": "string",
        "percentageDecreaseTimeout": "string",
        "percentageIncreaseTimeout": "string",
        "minPercentage": "number",
        "maxPercentage": "number",
        "movingAverageRatio": "number",
        "initialPercentage": "number"
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/loggers object

Name Type Required Value
name string Yes Logger identifier. Must be unique in the API Management service instance.
type enum Yes loggers
-or-
Microsoft.ApiManagement/service/loggers

See Set name and type for child resources.
apiVersion enum Yes 2017-03-01
properties object Yes Logger entity contract properties. - LoggerContractProperties object

LoggerContractProperties object

Name Type Required Value
loggerType enum Yes Logger type. - azureEventHub or applicationInsights
description string No Logger description.
credentials object Yes The name and SendRule connection string of the event hub for azureEventHub logger.Instrumentation key for applicationInsights logger.
isBuffered boolean No Whether records are buffered in the logger before publishing. Default is assumed to be true.
sampling object No Sampling settings for an ApplicationInsights logger. - LoggerSamplingContract object

LoggerSamplingContract object

Name Type Required Value
properties object No Sampling settings entity contract properties. - LoggerSamplingProperties object

LoggerSamplingProperties object

Name Type Required Value
samplingType enum No Sampling type. - fixed or adaptive
percentage number No Rate of sampling for fixed-rate sampling.
maxTelemetryItemsPerSecond integer No Target rate of telemetry items per second.
evaluationInterval string No Rate re-evaluation interval in ISO8601 format.
percentageDecreaseTimeout string No Duration in ISO8601 format after which it's allowed to lower the sampling rate.
percentageIncreaseTimeout string No Duration in ISO8601 format after which it's allowed to increase the sampling rate.
minPercentage number No Minimum allowed rate of sampling.
maxPercentage number No Maximum allowed rate of sampling.
movingAverageRatio number No Moving average ration assigned to most recent value.
initialPercentage number No Initial sampling rate.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities
Create Azure Front Door in front of Azure API Management

Deploy to Azure
This sample demonstrates how to use Azure Front Door as a global load balancer in front of Azure API Management.