Microsoft.ApiManagement service/loggers 2017-03-01
- Latest
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep resource definition
The service/loggers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2017-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
credentials: {
{customized property}: 'string'
}
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
LoggerContractProperties
| Name | Description | Value |
|---|---|---|
| credentials | The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. |
LoggerContractPropertiesCredentials (required) |
| description | Logger description. | string Constraints: Max length = |
| isBuffered | Whether records are buffered in the logger before publishing. Default is assumed to be true. | bool |
| loggerType | Logger type. | 'applicationInsights' 'azureEventHub' (required) |
| sampling | Sampling settings for an ApplicationInsights logger. | LoggerSamplingContract |
LoggerContractPropertiesCredentials
| Name | Description | Value |
|---|
LoggerSamplingContract
| Name | Description | Value |
|---|---|---|
| properties | Sampling settings entity contract properties. | 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' |
Microsoft.ApiManagement/service/loggers
| Name | Description | Value |
|---|---|---|
| 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 |
| properties | Logger entity contract properties. | LoggerContractProperties |
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:
- Resource groups - See resource group deployment commands
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": "2017-03-01",
"name": "string",
"properties": {
"credentials": {
"{customized property}": "string"
},
"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
LoggerContractProperties
| Name | Description | Value |
|---|---|---|
| credentials | The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. |
LoggerContractPropertiesCredentials (required) |
| description | Logger description. | string Constraints: Max length = |
| isBuffered | Whether records are buffered in the logger before publishing. Default is assumed to be true. | bool |
| loggerType | Logger type. | 'applicationInsights' 'azureEventHub' (required) |
| sampling | Sampling settings for an ApplicationInsights logger. | LoggerSamplingContract |
LoggerContractPropertiesCredentials
| Name | Description | Value |
|---|
LoggerSamplingContract
| Name | Description | Value |
|---|---|---|
| properties | Sampling settings entity contract properties. | 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' |
Microsoft.ApiManagement/service/loggers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-03-01' |
| name | The resource name | string Constraints: Max length = Pattern = ^[^*#&+:<>?]+$ (required) |
| properties | Logger entity contract properties. | LoggerContractProperties |
| 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 |
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. |
| Create Azure Front Door in front of Azure API Management |
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 |
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@2017-03-01"
name = "string"
body = jsonencode({
properties = {
credentials = {
{customized property} = "string"
}
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
LoggerContractProperties
| Name | Description | Value |
|---|---|---|
| credentials | The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger. |
LoggerContractPropertiesCredentials (required) |
| description | Logger description. | string Constraints: Max length = |
| isBuffered | Whether records are buffered in the logger before publishing. Default is assumed to be true. | bool |
| loggerType | Logger type. | 'applicationInsights' 'azureEventHub' (required) |
| sampling | Sampling settings for an ApplicationInsights logger. | LoggerSamplingContract |
LoggerContractPropertiesCredentials
| Name | Description | Value |
|---|
LoggerSamplingContract
| Name | Description | Value |
|---|---|---|
| properties | Sampling settings entity contract properties. | 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' |
Microsoft.ApiManagement/service/loggers
| Name | Description | Value |
|---|---|---|
| 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 |
| properties | Logger entity contract properties. | LoggerContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/loggers@2017-03-01" |