Microsoft.ApiManagement service/apis/diagnostics 2018-06-01-preview
- 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/apis/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/apis/diagnostics resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
alwaysLog: 'string'
backend: {
request: {
body: {
bytes: int
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
headers: [
'string'
]
}
}
enableHttpCorrelationHeaders: bool
frontend: {
request: {
body: {
bytes: int
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
headers: [
'string'
]
}
}
loggerId: 'string'
sampling: {
percentage: int
samplingType: 'string'
}
}
}
Property values
BodyDiagnosticSettings
| Name | Description | Value |
|---|---|---|
| bytes | Number of request body bytes to log. | int Constraints: Max value = 8192 |
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 |
| enableHttpCorrelationHeaders | Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. | bool |
| frontend | Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. | PipelineDiagnosticSettings |
| loggerId | Resource Id of a target logger. | string (required) |
| sampling | Sampling settings for Diagnostic. | SamplingSettings |
HttpMessageDiagnostic
| Name | Description | Value |
|---|---|---|
| body | Body logging settings. | BodyDiagnosticSettings |
| headers | Array of HTTP Headers to log. | string[] |
Microsoft.ApiManagement/service/apis/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/apis |
| 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' |
ARM template resource definition
The service/apis/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/apis/diagnostics resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/apis/diagnostics",
"apiVersion": "2018-06-01-preview",
"name": "string",
"properties": {
"alwaysLog": "string",
"backend": {
"request": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
}
},
"enableHttpCorrelationHeaders": "bool",
"frontend": {
"request": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
}
},
"loggerId": "string",
"sampling": {
"percentage": "int",
"samplingType": "string"
}
}
}
Property values
BodyDiagnosticSettings
| Name | Description | Value |
|---|---|---|
| bytes | Number of request body bytes to log. | int Constraints: Max value = 8192 |
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 |
| enableHttpCorrelationHeaders | Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. | bool |
| frontend | Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. | PipelineDiagnosticSettings |
| loggerId | Resource Id of a target logger. | string (required) |
| sampling | Sampling settings for Diagnostic. | SamplingSettings |
HttpMessageDiagnostic
| Name | Description | Value |
|---|---|---|
| body | Body logging settings. | BodyDiagnosticSettings |
| headers | Array of HTTP Headers to log. | string[] |
Microsoft.ApiManagement/service/apis/diagnostics
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-06-01-preview' |
| 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/apis/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' |
Terraform (AzAPI provider) resource definition
The service/apis/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/apis/diagnostics resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"
name = "string"
body = jsonencode({
properties = {
alwaysLog = "string"
backend = {
request = {
body = {
bytes = int
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
headers = [
"string"
]
}
}
enableHttpCorrelationHeaders = bool
frontend = {
request = {
body = {
bytes = int
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
headers = [
"string"
]
}
}
loggerId = "string"
sampling = {
percentage = int
samplingType = "string"
}
}
})
}
Property values
BodyDiagnosticSettings
| Name | Description | Value |
|---|---|---|
| bytes | Number of request body bytes to log. | int Constraints: Max value = 8192 |
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 |
| enableHttpCorrelationHeaders | Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. | bool |
| frontend | Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. | PipelineDiagnosticSettings |
| loggerId | Resource Id of a target logger. | string (required) |
| sampling | Sampling settings for Diagnostic. | SamplingSettings |
HttpMessageDiagnostic
| Name | Description | Value |
|---|---|---|
| body | Body logging settings. | BodyDiagnosticSettings |
| headers | Array of HTTP Headers to log. | string[] |
Microsoft.ApiManagement/service/apis/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/apis |
| properties | Diagnostic entity contract properties. | DiagnosticContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview" |
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' |