Microsoft.ApiManagement service/loggers 2016-10-10

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@2016-10-10' = {
  parent: resourceSymbolicName
  credentials: {
    {customized property}: 'string'
  }
  description: 'string'
  isBuffered: bool
  name: 'string'
}

Property values

LoggerCreateParametersCredentials

Name Description Value

Microsoft.ApiManagement/service/loggers

Name Description Value
credentials The name and SendRule connection string of the event hub. LoggerCreateParametersCredentials (required)
description Logger description. string
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
name The resource name string

Constraints:
Max length =
Pattern = ^[^*#&+:<>?]+$ (required)
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

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Application Gateway with internal API Management and Web App 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.
Create API Management in Internal VNet with App Gateway 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 The template will log API calls from Azure API Management to Moesif API analytics and monetization platform

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": "2016-10-10",
  "name": "string",
  "credentials": {
    "{customized property}": "string"
  },
  "description": "string",
  "isBuffered": "bool"
}

Property values

LoggerCreateParametersCredentials

Name Description Value

Microsoft.ApiManagement/service/loggers

Name Description Value
apiVersion The api version '2016-10-10'
credentials The name and SendRule connection string of the event hub. LoggerCreateParametersCredentials (required)
description Logger description. string
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
name The resource name string

Constraints:
Max length =
Pattern = ^[^*#&+:<>?]+$ (required)
type The resource type 'Microsoft.ApiManagement/service/loggers'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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.
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.
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

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@2016-10-10"
  name = "string"
  credentials = {
    {customized property} = "string"
  }
  description = "string"
  isBuffered = bool
}

Property values

LoggerCreateParametersCredentials

Name Description Value

Microsoft.ApiManagement/service/loggers

Name Description Value
credentials The name and SendRule connection string of the event hub. LoggerCreateParametersCredentials (required)
description Logger description. string
isBuffered Whether records are buffered in the logger before publishing. Default is assumed to be true. bool
name The resource name string

Constraints:
Max length =
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
type The resource type "Microsoft.ApiManagement/service/loggers@2016-10-10"