Microsoft.ApiManagement service/loggers 2021-08-01

Bicep resource definition

The service/loggers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.ApiManagement/service/loggers@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    credentials: {
      {customized property}: 'string'
    }
    description: 'string'
    isBuffered: bool
    loggerType: 'string'
    resourceId: 'string'
  }
}

Property values

service/loggers

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: service
properties Logger entity contract properties. LoggerContractProperties

LoggerContractProperties

Name Description Value
credentials The name and SendRule connection string of the event hub for azureEventHub logger.
Instrumentation key for applicationInsights logger.
LoggerContractPropertiesCredentials
description Logger description. string

Constraints:
Max length = 256
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
loggerType Logger type. 'applicationInsights'
'azureEventHub'
'azureMonitor' (required)
resourceId Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). string

LoggerContractPropertiesCredentials

Name Description Value
{customized property} string

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.
Moesif API Analytics and Monetization

Deploy to Azure
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform
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.
Application Gateway with internal API Management and Web App

Deploy to Azure
Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.

ARM template resource definition

The service/loggers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/loggers",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "credentials": {
      "{customized property}": "string"
    },
    "description": "string",
    "isBuffered": "bool",
    "loggerType": "string",
    "resourceId": "string"
  }
}

Property values

service/loggers

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/loggers'
apiVersion The resource api version '2021-08-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
properties Logger entity contract properties. LoggerContractProperties

LoggerContractProperties

Name Description Value
credentials The name and SendRule connection string of the event hub for azureEventHub logger.
Instrumentation key for applicationInsights logger.
LoggerContractPropertiesCredentials
description Logger description. string

Constraints:
Max length = 256
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
loggerType Logger type. 'applicationInsights'
'azureEventHub'
'azureMonitor' (required)
resourceId Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). string

LoggerContractPropertiesCredentials

Name Description Value
{customized property} string

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.
Moesif API Analytics and Monetization

Deploy to Azure
The template will log API calls from Azure API Management to Moesif API analytics and monetization platform
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.
Application Gateway with internal API Management and Web App

Deploy to Azure
Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.

Terraform (AzAPI provider) resource definition

The service/loggers resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/loggers@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      credentials = {
        {customized property} = "string"
      }
      description = "string"
      isBuffered = bool
      loggerType = "string"
      resourceId = "string"
    }
  })
}

Property values

service/loggers

Name Description Value
type The resource type "Microsoft.ApiManagement/service/loggers@2021-08-01"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Logger entity contract properties. LoggerContractProperties

LoggerContractProperties

Name Description Value
credentials The name and SendRule connection string of the event hub for azureEventHub logger.
Instrumentation key for applicationInsights logger.
LoggerContractPropertiesCredentials
description Logger description. string

Constraints:
Max length = 256
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
loggerType Logger type. "applicationInsights"
"azureEventHub"
"azureMonitor" (required)
resourceId Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). string

LoggerContractPropertiesCredentials

Name Description Value
{customized property} string