Microsoft.ApiManagement service/diagnostics 2021-08-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
Bicep resource definition
The service/diagnostics 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/diagnostics resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2021-08-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
alwaysLog: 'string'
backend: {
request: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
}
frontend: {
request: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
}
httpCorrelationProtocol: 'string'
logClientIp: bool
loggerId: 'string'
metrics: bool
operationNameFormat: 'string'
sampling: {
percentage: int
samplingType: 'string'
}
verbosity: 'string'
}
}
Property values
BodyDiagnosticSettings
Name | Description | Value |
---|---|---|
bytes | Number of request body bytes to log. | int Constraints: Max value = 8192 |
DataMasking
Name | Description | Value |
---|---|---|
headers | Masking settings for headers | DataMaskingEntity[] |
queryParams | Masking settings for Url query parameters | DataMaskingEntity[] |
DataMaskingEntity
Name | Description | Value |
---|---|---|
mode | Data masking mode. | 'Hide' 'Mask' |
value | The name of an entity to mask (e.g. a name of a header or a query parameter). | string |
DiagnosticContractProperties
Name | Description | Value |
---|---|---|
alwaysLog | Specifies for what type of messages sampling settings should not apply. | 'allErrors' |
backend | Diagnostic settings for incoming/outgoing HTTP messages to the Backend | PipelineDiagnosticSettings |
frontend | Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. | PipelineDiagnosticSettings |
httpCorrelationProtocol | Sets correlation protocol to use for Application Insights diagnostics. | 'Legacy' 'None' 'W3C' |
logClientIp | Log the ClientIP. Default is false. | bool |
loggerId | Resource Id of a target logger. | string (required) |
metrics | Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. | bool |
operationNameFormat | The format of the Operation Name for Application Insights telemetries. Default is Name. | 'Name' 'Url' |
sampling | Sampling settings for Diagnostic. | SamplingSettings |
verbosity | The verbosity level applied to traces emitted by trace policies. | 'error' 'information' 'verbose' |
HttpMessageDiagnostic
Name | Description | Value |
---|---|---|
body | Body logging settings. | BodyDiagnosticSettings |
dataMasking | Data masking settings. | DataMasking |
headers | Array of HTTP Headers to log. | string[] |
Microsoft.ApiManagement/service/diagnostics
Name | Description | Value |
---|---|---|
name | The resource name | string Constraints: Min length = 1 Max length = 1 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 | Diagnostic entity contract properties. | DiagnosticContractProperties |
PipelineDiagnosticSettings
Name | Description | Value |
---|---|---|
request | Diagnostic settings for request. | HttpMessageDiagnostic |
response | Diagnostic settings for response. | HttpMessageDiagnostic |
SamplingSettings
Name | Description | Value |
---|---|---|
percentage | Rate of sampling for fixed-rate sampling. | int Constraints: Min value = 0 Max value = 100 |
samplingType | Sampling type. | 'fixed' |
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. |
ARM template resource definition
The service/diagnostics 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/diagnostics resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/diagnostics",
"apiVersion": "2021-08-01",
"name": "string",
"properties": {
"alwaysLog": "string",
"backend": {
"request": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
}
},
"frontend": {
"request": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
}
},
"httpCorrelationProtocol": "string",
"logClientIp": "bool",
"loggerId": "string",
"metrics": "bool",
"operationNameFormat": "string",
"sampling": {
"percentage": "int",
"samplingType": "string"
},
"verbosity": "string"
}
}
Property values
BodyDiagnosticSettings
Name | Description | Value |
---|---|---|
bytes | Number of request body bytes to log. | int Constraints: Max value = 8192 |
DataMasking
Name | Description | Value |
---|---|---|
headers | Masking settings for headers | DataMaskingEntity[] |
queryParams | Masking settings for Url query parameters | DataMaskingEntity[] |
DataMaskingEntity
Name | Description | Value |
---|---|---|
mode | Data masking mode. | 'Hide' 'Mask' |
value | The name of an entity to mask (e.g. a name of a header or a query parameter). | string |
DiagnosticContractProperties
Name | Description | Value |
---|---|---|
alwaysLog | Specifies for what type of messages sampling settings should not apply. | 'allErrors' |
backend | Diagnostic settings for incoming/outgoing HTTP messages to the Backend | PipelineDiagnosticSettings |
frontend | Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. | PipelineDiagnosticSettings |
httpCorrelationProtocol | Sets correlation protocol to use for Application Insights diagnostics. | 'Legacy' 'None' 'W3C' |
logClientIp | Log the ClientIP. Default is false. | bool |
loggerId | Resource Id of a target logger. | string (required) |
metrics | Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. | bool |
operationNameFormat | The format of the Operation Name for Application Insights telemetries. Default is Name. | 'Name' 'Url' |
sampling | Sampling settings for Diagnostic. | SamplingSettings |
verbosity | The verbosity level applied to traces emitted by trace policies. | 'error' 'information' 'verbose' |
HttpMessageDiagnostic
Name | Description | Value |
---|---|---|
body | Body logging settings. | BodyDiagnosticSettings |
dataMasking | Data masking settings. | DataMasking |
headers | Array of HTTP Headers to log. | string[] |
Microsoft.ApiManagement/service/diagnostics
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2021-08-01' |
name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[^*#&+:<>?]+$ (required) |
properties | Diagnostic entity contract properties. | DiagnosticContractProperties |
type | The resource type | 'Microsoft.ApiManagement/service/diagnostics' |
PipelineDiagnosticSettings
Name | Description | Value |
---|---|---|
request | Diagnostic settings for request. | HttpMessageDiagnostic |
response | Diagnostic settings for response. | HttpMessageDiagnostic |
SamplingSettings
Name | Description | Value |
---|---|---|
percentage | Rate of sampling for fixed-rate sampling. | int Constraints: Min value = 0 Max value = 100 |
samplingType | Sampling type. | 'fixed' |
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. |
Terraform (AzAPI provider) resource definition
The service/diagnostics 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/diagnostics resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/diagnostics@2021-08-01"
name = "string"
body = jsonencode({
properties = {
alwaysLog = "string"
backend = {
request = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
}
frontend = {
request = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
}
httpCorrelationProtocol = "string"
logClientIp = bool
loggerId = "string"
metrics = bool
operationNameFormat = "string"
sampling = {
percentage = int
samplingType = "string"
}
verbosity = "string"
}
})
}
Property values
BodyDiagnosticSettings
Name | Description | Value |
---|---|---|
bytes | Number of request body bytes to log. | int Constraints: Max value = 8192 |
DataMasking
Name | Description | Value |
---|---|---|
headers | Masking settings for headers | DataMaskingEntity[] |
queryParams | Masking settings for Url query parameters | DataMaskingEntity[] |
DataMaskingEntity
Name | Description | Value |
---|---|---|
mode | Data masking mode. | 'Hide' 'Mask' |
value | The name of an entity to mask (e.g. a name of a header or a query parameter). | string |
DiagnosticContractProperties
Name | Description | Value |
---|---|---|
alwaysLog | Specifies for what type of messages sampling settings should not apply. | 'allErrors' |
backend | Diagnostic settings for incoming/outgoing HTTP messages to the Backend | PipelineDiagnosticSettings |
frontend | Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. | PipelineDiagnosticSettings |
httpCorrelationProtocol | Sets correlation protocol to use for Application Insights diagnostics. | 'Legacy' 'None' 'W3C' |
logClientIp | Log the ClientIP. Default is false. | bool |
loggerId | Resource Id of a target logger. | string (required) |
metrics | Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. | bool |
operationNameFormat | The format of the Operation Name for Application Insights telemetries. Default is Name. | 'Name' 'Url' |
sampling | Sampling settings for Diagnostic. | SamplingSettings |
verbosity | The verbosity level applied to traces emitted by trace policies. | 'error' 'information' 'verbose' |
HttpMessageDiagnostic
Name | Description | Value |
---|---|---|
body | Body logging settings. | BodyDiagnosticSettings |
dataMasking | Data masking settings. | DataMasking |
headers | Array of HTTP Headers to log. | string[] |
Microsoft.ApiManagement/service/diagnostics
Name | Description | Value |
---|---|---|
name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[^*#&+:<>?]+$ (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
properties | Diagnostic entity contract properties. | DiagnosticContractProperties |
type | The resource type | "Microsoft.ApiManagement/service/diagnostics@2021-08-01" |
PipelineDiagnosticSettings
Name | Description | Value |
---|---|---|
request | Diagnostic settings for request. | HttpMessageDiagnostic |
response | Diagnostic settings for response. | HttpMessageDiagnostic |
SamplingSettings
Name | Description | Value |
---|---|---|
percentage | Rate of sampling for fixed-rate sampling. | int Constraints: Min value = 0 Max value = 100 |
samplingType | Sampling type. | 'fixed' |