Microsoft.ApiManagement service/loggers 2017-03-01

The service/loggers resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ApiManagement/service/loggers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ApiManagement/service/loggers@2017-03-01' = {
  name: 'string'
  properties: {
    credentials: {}
    description: 'string'
    isBuffered: bool
    loggerType: 'string'
    sampling: {
      properties: {
        evaluationInterval: 'string'
        initialPercentage: int
        maxPercentage: int
        maxTelemetryItemsPerSecond: int
        minPercentage: int
        movingAverageRatio: int
        percentage: int
        percentageDecreaseTimeout: 'string'
        percentageIncreaseTimeout: 'string'
        samplingType: 'string'
      }
    }
  }
}

Property values

service/loggers

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/loggers'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-03-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs. LoggerContractProperties

LoggerContractProperties

Name Description Value
credentials The name and SendRule connection string of the event hub for azureEventHub logger.
Instrumentation key for applicationInsights logger.
object (required)
description Logger description. string
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
loggerType Logger type. 'applicationInsights'
'azureEventHub'
sampling Sampling settings contract. LoggerSamplingContract

LoggerSamplingContract

Name Description Value
properties Sampling settings for an ApplicationInsights logger. LoggerSamplingProperties

LoggerSamplingProperties

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

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 API Management in Internal VNet with App Gateway

Deploy to Azure
This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway.
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.