Microsoft.ApiManagement service/apis/diagnostics 2019-01-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@2019-01-01' = {
  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'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

屬性值

BodyDiagnosticSettings

名字	描述	價值
位元組	要記錄的要求本文字節數目。	int 約束： 最大值 = 8192

DiagnosticContractProperties

名字	描述	價值
alwaysLog	指定不應該套用何種類型的訊息取樣設定。	'allErrors'
backend	傳入/傳出 HTTP 訊息至後端的診斷設定	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	是否要處理傳入 Api 管理服務的相互關聯標頭。 僅適用於 Application Insights 診斷。 默認值為 true。	bool
前端	傳入/傳出 HTTP 訊息至閘道的診斷設定。	PipelineDiagnosticSettings
httpCorrelationProtocol	設定要用於Application Insights診斷的相互關聯通訊協定。	'Legacy' 'None' 'W3C'
loggerId	目標記錄器的資源識別碼。	字串 （必要）
採樣	診斷的取樣設定。	SamplingSettings
冗長	套用至追蹤原則所發出之追蹤的詳細資訊層級。	'error' 'information' 'verbose'

HttpMessageDiagnostic

名字	描述	價值
身體	本文記錄設定。	BodyDiagnosticSettings
頭	要記錄的 HTTP 標頭陣列。	string[]

Microsoft.ApiManagement/service/apis/diagnostics

名字	描述	價值
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[^*#&+:<>?]+$ （必要）
父母	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型的資源符號名稱：service/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": "2019-01-01",
  "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" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

屬性值

BodyDiagnosticSettings

名字	描述	價值
位元組	要記錄的要求本文字節數目。	int 約束： 最大值 = 8192

DiagnosticContractProperties

名字	描述	價值
alwaysLog	指定不應該套用何種類型的訊息取樣設定。	'allErrors'
backend	傳入/傳出 HTTP 訊息至後端的診斷設定	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	是否要處理傳入 Api 管理服務的相互關聯標頭。 僅適用於 Application Insights 診斷。 默認值為 true。	bool
前端	傳入/傳出 HTTP 訊息至閘道的診斷設定。	PipelineDiagnosticSettings
httpCorrelationProtocol	設定要用於Application Insights診斷的相互關聯通訊協定。	'Legacy' 'None' 'W3C'
loggerId	目標記錄器的資源識別碼。	字串 （必要）
採樣	診斷的取樣設定。	SamplingSettings
冗長	套用至追蹤原則所發出之追蹤的詳細資訊層級。	'error' 'information' 'verbose'

HttpMessageDiagnostic

名字	描述	價值
身體	本文記錄設定。	BodyDiagnosticSettings
頭	要記錄的 HTTP 標頭陣列。	string[]

Microsoft.ApiManagement/service/apis/diagnostics

名字	描述	價值
apiVersion	API 版本	'2019-01-01'
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[^*#&+:<>?]+$ （必要）
性能	診斷實體合約屬性。	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@2019-01-01"
  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"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

屬性值

BodyDiagnosticSettings

名字	描述	價值
位元組	要記錄的要求本文字節數目。	int 約束： 最大值 = 8192

DiagnosticContractProperties

名字	描述	價值
alwaysLog	指定不應該套用何種類型的訊息取樣設定。	'allErrors'
backend	傳入/傳出 HTTP 訊息至後端的診斷設定	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	是否要處理傳入 Api 管理服務的相互關聯標頭。 僅適用於 Application Insights 診斷。 默認值為 true。	bool
前端	傳入/傳出 HTTP 訊息至閘道的診斷設定。	PipelineDiagnosticSettings
httpCorrelationProtocol	設定要用於Application Insights診斷的相互關聯通訊協定。	'Legacy' 'None' 'W3C'
loggerId	目標記錄器的資源識別碼。	字串 （必要）
採樣	診斷的取樣設定。	SamplingSettings
冗長	套用至追蹤原則所發出之追蹤的詳細資訊層級。	'error' 'information' 'verbose'

HttpMessageDiagnostic

名字	描述	價值
身體	本文記錄設定。	BodyDiagnosticSettings
頭	要記錄的 HTTP 標頭陣列。	string[]

Microsoft.ApiManagement/service/apis/diagnostics

名字	描述	價值
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[^*#&+:<>?]+$ （必要）
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：服務/apis
性能	診斷實體合約屬性。	DiagnosticContractProperties
類型	資源類型	“Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01”

PipelineDiagnosticSettings

名字	描述	價值
請求	要求的診斷設定。	HttpMessageDiagnostic
回應	回應的診斷設定。	HttpMessageDiagnostic

SamplingSettings

名字	描述	價值
百分比	固定速率取樣的取樣率。	int 約束： 最小值 = 0 最大值 = 100
samplingType	取樣類型。	'fixed'