Поделиться через

Microsoft.ApiManagement service/apis/diagnostics 2023-09-01-preview

  • Статья

Определение ресурсов Bicep

Тип ресурса службы/apis/diagnostics можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/apis/diagnostics, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    alwaysLog: 'allErrors'
    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: 'fixed'
    }
    verbosity: 'string'
  }
}

Значения свойств

service/apis/diagnostics

Имя Описание Ценность
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в Bicep.		 строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: API
свойства Свойства контракта сущности диагностики. DiagnosticContractProperties

DiagnosticContractProperties

Имя Описание Ценность
alwaysLog Указывает, какой тип параметров выборки сообщений не должен применяться. 'allErrors'
серверная часть Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть PipelineDiagnosticSettings
интерфейсный интерфейс Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз. PipelineDiagnosticSettings
httpCorrelationProtocol Задает протокол корреляции, используемый для диагностики Application Insights. "Устаревшая версия"
"Нет"
"W3C"
LogClientIp Зайдите в журнал clientIP. Значение по умолчанию — false. bool
loggerId Идентификатор ресурса целевого средства ведения журнала. строка (обязательно)
метрика Выдайте пользовательские метрики с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights. bool
operationNameFormat Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя. "Имя"
Url-адрес
выборка Параметры выборки для диагностики. выборкиSettings
многословие Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. "error"
"информация"
"подробный"

PipelineDiagnosticSettings

Имя Описание Ценность
просьба Параметры диагностики для запроса. HttpMessageDiagnostic
ответ Параметры диагностики для ответа. HttpMessageDiagnostic

HttpMessageDiagnostic

Имя Описание Ценность
тело Параметры ведения журнала тела. BodyDiagnosticSettings
dataMasking Параметры маскирования данных. DataMasking
Заголовки Массив заголовков HTTP в журнал. string[]

BodyDiagnosticSettings

Имя Описание Ценность
Байт Количество байтов текста запроса для журнала. int

Ограничения целостности:
Максимальное значение = 8192

DataMasking

Имя Описание Ценность
Заголовки Параметры маскирования заголовков DataMaskingEntity[]
queryParams Параметры маскирования для параметров запроса URL-адреса DataMaskingEntity[]

DataMaskingEntity

Имя Описание Ценность
режим Режим маскирования данных. "Скрыть"
"Маска"
ценность Имя сущности для маскирования (например, имя заголовка или параметра запроса). струна

ВыборкаSettings

Имя Описание Ценность
процент Частота выборки для выборки фиксированной частоты. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 100
выборкаType Тип выборки. "исправлено"

Определение ресурса шаблона ARM

Тип ресурса службы/apis/diagnostics можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/apis/diagnostics, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "allErrors",
    "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": "fixed"
    },
    "verbosity": "string"
  }
}

Значения свойств

service/apis/diagnostics

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/apis/diagnostics"
apiVersion Версия API ресурсов '2023-09-01-preview'
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.		 строка (обязательно)
свойства Свойства контракта сущности диагностики. DiagnosticContractProperties

DiagnosticContractProperties

Имя Описание Ценность
alwaysLog Указывает, какой тип параметров выборки сообщений не должен применяться. 'allErrors'
серверная часть Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть PipelineDiagnosticSettings
интерфейсный интерфейс Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз. PipelineDiagnosticSettings
httpCorrelationProtocol Задает протокол корреляции, используемый для диагностики Application Insights. "Устаревшая версия"
"Нет"
"W3C"
LogClientIp Зайдите в журнал clientIP. Значение по умолчанию — false. bool
loggerId Идентификатор ресурса целевого средства ведения журнала. строка (обязательно)
метрика Выдайте пользовательские метрики с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights. bool
operationNameFormat Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя. "Имя"
Url-адрес
выборка Параметры выборки для диагностики. выборкиSettings
многословие Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. "error"
"информация"
"подробный"

PipelineDiagnosticSettings

Имя Описание Ценность
просьба Параметры диагностики для запроса. HttpMessageDiagnostic
ответ Параметры диагностики для ответа. HttpMessageDiagnostic

HttpMessageDiagnostic

Имя Описание Ценность
тело Параметры ведения журнала тела. BodyDiagnosticSettings
dataMasking Параметры маскирования данных. DataMasking
Заголовки Массив заголовков HTTP в журнал. string[]

BodyDiagnosticSettings

Имя Описание Ценность
Байт Количество байтов текста запроса для журнала. int

Ограничения целостности:
Максимальное значение = 8192

DataMasking

Имя Описание Ценность
Заголовки Параметры маскирования заголовков DataMaskingEntity[]
queryParams Параметры маскирования для параметров запроса URL-адреса DataMaskingEntity[]

DataMaskingEntity

Имя Описание Ценность
режим Режим маскирования данных. "Скрыть"
"Маска"
ценность Имя сущности для маскирования (например, имя заголовка или параметра запроса). струна

ВыборкаSettings

Имя Описание Ценность
процент Частота выборки для выборки фиксированной частоты. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 100
выборкаType Тип выборки. "исправлено"

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса службы/apis/diagnostics можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/apis/diagnostics, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "allErrors"
      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 = "fixed"
      }
      verbosity = "string"
    }
  })
}

Значения свойств

service/apis/diagnostics

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/apis/diagnostics@2023-09-01-preview"
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: API
свойства Свойства контракта сущности диагностики. DiagnosticContractProperties

DiagnosticContractProperties

Имя Описание Ценность
alwaysLog Указывает, какой тип параметров выборки сообщений не должен применяться. "allErrors"
серверная часть Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть PipelineDiagnosticSettings
интерфейсный интерфейс Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз. PipelineDiagnosticSettings
httpCorrelationProtocol Задает протокол корреляции, используемый для диагностики Application Insights. "Устаревшая версия"
"Нет"
W3C
LogClientIp Зайдите в журнал clientIP. Значение по умолчанию — false. bool
loggerId Идентификатор ресурса целевого средства ведения журнала. строка (обязательно)
метрика Выдайте пользовательские метрики с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights. bool
operationNameFormat Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя. "Имя"
URL-адрес
выборка Параметры выборки для диагностики. выборкиSettings
многословие Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. "error"
"information"
"подробный"

PipelineDiagnosticSettings

Имя Описание Ценность
просьба Параметры диагностики для запроса. HttpMessageDiagnostic
ответ Параметры диагностики для ответа. HttpMessageDiagnostic

HttpMessageDiagnostic

Имя Описание Ценность
тело Параметры ведения журнала тела. BodyDiagnosticSettings
dataMasking Параметры маскирования данных. DataMasking
Заголовки Массив заголовков HTTP в журнал. string[]

BodyDiagnosticSettings

Имя Описание Ценность
Байт Количество байтов текста запроса для журнала. int

Ограничения целостности:
Максимальное значение = 8192

DataMasking

Имя Описание Ценность
Заголовки Параметры маскирования заголовков DataMaskingEntity[]
queryParams Параметры маскирования для параметров запроса URL-адреса DataMaskingEntity[]

DataMaskingEntity

Имя Описание Ценность
режим Режим маскирования данных. "Скрыть"
"Маска"
ценность Имя сущности для маскирования (например, имя заголовка или параметра запроса). струна

ВыборкаSettings

Имя Описание Ценность
процент Частота выборки для выборки фиксированной частоты. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 100
выборкаType Тип выборки. "исправлено"