你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ApiManagement service/apis/diagnostics 2020-12-01

• 最新
• 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 资源定义

可以使用目标操作部署服务/apis/诊断资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/apis/diagnostics 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2020-12-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'
  }
}

属性值

BodyDiagnosticSettings

名字	描述	价值
字节	要记录的请求正文字节数。	int 约束： 最大值 = 8192

DataMasking

名字	描述	价值
头	标头的掩码设置	DataMaskingEntity[]
queryParams	Url 查询参数的掩码设置	DataMaskingEntity[]

DataMaskingEntity

名字	描述	价值
模式	数据掩码模式。	“隐藏” “Mask”
价值	要屏蔽的实体的名称（例如标头或查询参数的名称）。	字符串

DiagnosticContractProperties

名字	描述	价值
alwaysLog	指定不应应用哪种类型的消息采样设置。	“allErrors”
后端	传入/传出 HTTP 消息到后端的诊断设置	PipelineDiagnosticSettings
frontend	传入/传出 HTTP 消息到网关的诊断设置。	PipelineDiagnosticSettings
httpCorrelationProtocol	设置要用于 Application Insights 诊断的相关协议。	“Legacy” “None” “W3C”
logClientIp	记录 ClientIP。 默认值为 false。	bool
loggerId	目标记录器的资源 ID。	string （必需）
指标	通过发出指标策略发出自定义指标。 仅适用于 Application Insights 诊断设置。	bool
operationNameFormat	Application Insights 遥测的操作名称的格式。 默认值为 Name。	“Name” “Url”
采样	诊断的采样设置。	SamplingSettings
冗长	应用于跟踪策略发出的跟踪的详细级别。	“error” “information” “verbose”

HttpMessageDiagnostic

名字	描述	价值
身体	正文日志记录设置。	BodyDiagnosticSettings
dataMasking	数据掩码设置。	DataMasking
头	要记录的 HTTP 标头数组。	string[]

Microsoft.ApiManagement/service/apis/diagnostics

名字	描述	价值
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 80 模式 = ^[^*#&+:<>?]+$ （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：服务/apis
性能	诊断实体协定属性。	DiagnosticContractProperties

PipelineDiagnosticSettings

名字	描述	价值
请求	请求的诊断设置。	HttpMessageDiagnostic
响应	响应的诊断设置。	HttpMessageDiagnostic

SamplingSettings

名字	描述	价值
百分比	固定速率采样的采样率。	int 约束： 最小值 = 0 最大值 = 100
samplingType	采样类型。	“fixed”

ARM 模板资源定义

可以使用目标操作部署服务/apis/诊断资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/apis/diagnostics 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2020-12-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"
  }
}

属性值

BodyDiagnosticSettings

名字	描述	价值
字节	要记录的请求正文字节数。	int 约束： 最大值 = 8192

DataMasking

名字	描述	价值
头	标头的掩码设置	DataMaskingEntity[]
queryParams	Url 查询参数的掩码设置	DataMaskingEntity[]

DataMaskingEntity

名字	描述	价值
模式	数据掩码模式。	“隐藏” “Mask”
价值	要屏蔽的实体的名称（例如标头或查询参数的名称）。	字符串

DiagnosticContractProperties

名字	描述	价值
alwaysLog	指定不应应用哪种类型的消息采样设置。	“allErrors”
后端	传入/传出 HTTP 消息到后端的诊断设置	PipelineDiagnosticSettings
frontend	传入/传出 HTTP 消息到网关的诊断设置。	PipelineDiagnosticSettings
httpCorrelationProtocol	设置要用于 Application Insights 诊断的相关协议。	“Legacy” “None” “W3C”
logClientIp	记录 ClientIP。 默认值为 false。	bool
loggerId	目标记录器的资源 ID。	string （必需）
指标	通过发出指标策略发出自定义指标。 仅适用于 Application Insights 诊断设置。	bool
operationNameFormat	Application Insights 遥测的操作名称的格式。 默认值为 Name。	“Name” “Url”
采样	诊断的采样设置。	SamplingSettings
冗长	应用于跟踪策略发出的跟踪的详细级别。	“error” “information” “verbose”

HttpMessageDiagnostic

名字	描述	价值
身体	正文日志记录设置。	BodyDiagnosticSettings
dataMasking	数据掩码设置。	DataMasking
头	要记录的 HTTP 标头数组。	string[]

Microsoft.ApiManagement/service/apis/diagnostics

名字	描述	价值
apiVersion	API 版本	'2020-12-01'
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 80 模式 = ^[^*#&+:<>?]+$ （必需）
性能	诊断实体协定属性。	DiagnosticContractProperties
类型	资源类型	“Microsoft.ApiManagement/service/apis/diagnostics”

PipelineDiagnosticSettings

名字	描述	价值
请求	请求的诊断设置。	HttpMessageDiagnostic
响应	响应的诊断设置。	HttpMessageDiagnostic

SamplingSettings

名字	描述	价值
百分比	固定速率采样的采样率。	int 约束： 最小值 = 0 最大值 = 100
samplingType	采样类型。	“fixed”

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务/apis/诊断资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/apis/diagnostics 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2020-12-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"
    }
  })
}

属性值

BodyDiagnosticSettings

名字	描述	价值
字节	要记录的请求正文字节数。	int 约束： 最大值 = 8192

DataMasking

名字	描述	价值
头	标头的掩码设置	DataMaskingEntity[]
queryParams	Url 查询参数的掩码设置	DataMaskingEntity[]

DataMaskingEntity

名字	描述	价值
模式	数据掩码模式。	“隐藏” “Mask”
价值	要屏蔽的实体的名称（例如标头或查询参数的名称）。	字符串

DiagnosticContractProperties

名字	描述	价值
alwaysLog	指定不应应用哪种类型的消息采样设置。	“allErrors”
后端	传入/传出 HTTP 消息到后端的诊断设置	PipelineDiagnosticSettings
frontend	传入/传出 HTTP 消息到网关的诊断设置。	PipelineDiagnosticSettings
httpCorrelationProtocol	设置要用于 Application Insights 诊断的相关协议。	“Legacy” “None” “W3C”
logClientIp	记录 ClientIP。 默认值为 false。	bool
loggerId	目标记录器的资源 ID。	string （必需）
指标	通过发出指标策略发出自定义指标。 仅适用于 Application Insights 诊断设置。	bool
operationNameFormat	Application Insights 遥测的操作名称的格式。 默认值为 Name。	“Name” “Url”
采样	诊断的采样设置。	SamplingSettings
冗长	应用于跟踪策略发出的跟踪的详细级别。	“error” “information” “verbose”

HttpMessageDiagnostic

名字	描述	价值
身体	正文日志记录设置。	BodyDiagnosticSettings
dataMasking	数据掩码设置。	DataMasking
头	要记录的 HTTP 标头数组。	string[]

Microsoft.ApiManagement/service/apis/diagnostics

名字	描述	价值
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 80 模式 = ^[^*#&+:<>?]+$ （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：服务/apis
性能	诊断实体协定属性。	DiagnosticContractProperties
类型	资源类型	“Microsoft.ApiManagement/service/apis/diagnostics@2020-12-01”

PipelineDiagnosticSettings

名字	描述	价值
请求	请求的诊断设置。	HttpMessageDiagnostic
响应	响应的诊断设置。	HttpMessageDiagnostic

SamplingSettings

名字	描述	价值
百分比	固定速率采样的采样率。	int 约束： 最小值 = 0 最大值 = 100
samplingType	采样类型。	“fixed”