Microsoft.ApiManagement service/диагностика 2023-03-01-preview

Определение ресурса Bicep

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-03-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/диагностика

Имя Описание Значение
name имя ресурса.

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

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

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

DiagnosticContractProperties

Имя Описание Значение
alwaysLog Указывает, к какому типу параметров выборки сообщений не следует применять. 'allErrors'
серверная часть Параметры диагностики входящих и исходящих HTTP-сообщений в серверную часть PipelineDiagnosticSettings
Frontend Параметры диагностики входящих и исходящих HTTP-сообщений в шлюз. PipelineDiagnosticSettings
httpCorrelationProtocol Задает протокол корреляции, используемый для диагностика Application Insights. "Устаревшая версия"
"Нет"
"W3C"
logClientIp Зайдите в журнал ClientIP. Значение по умолчанию — false. bool
loggerId Идентификатор ресурса целевого средства ведения журнала. строка (обязательно)
Метрики Создание пользовательских метрик с помощью политики отправки метрик. Применимо только к параметрам диагностики Application Insights. bool
operationNameFormat Формат имени операции для телеметрии Application Insights. Значение по умолчанию — Name. 'Name'
Url
выборка Параметры выборки для диагностики. SamplingSettings
Детализации Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. "error"
"information"
"verbose"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

Имя Описание Значение
Байты Число байтов текста запроса для записи в журнал. INT

DataMasking

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

DataMaskingEntity

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

SamplingSettings

Имя Описание Значение
процент Частота выборки для выборки с фиксированной частотой. INT
samplingType Тип выборки. "fixed"

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание Управление API во внутренней виртуальной сети с помощью Шлюза приложений

Развертывание в Azure
В этом шаблоне показано, как создать экземпляр azure Управление API в частной сети, защищенной Шлюз приложений Azure.
Шлюз приложений с внутренним Управление API и веб-приложением

Развертывание в Azure
Шлюз приложений маршрутизации интернет-трафика в виртуальную сеть (внутренний режим) Управление API экземпляр, который обслуживает веб-API, размещенный в веб-приложении Azure.

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2023-03-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/диагностика

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service/диагностика
версия_API Версия API ресурсов '2023-03-01-preview'
name имя ресурса.

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

Ограничение символов: 1-80

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.
properties Свойства контракта диагностической сущности. Свойства DiagnosticContractProperties

Свойства DiagnosticContractProperties

Имя Описание Значение
alwaysLog Указывает, к какому типу сообщений не должны применяться параметры выборки. 'allErrors'
серверная часть Параметры диагностики входящих и исходящих HTTP-сообщений в серверную часть PipelineDiagnosticSettings
Frontend Параметры диагностики для входящих и исходящих HTTP-сообщений, поступающих в шлюз. PipelineDiagnosticSettings
httpCorrelationProtocol Задает протокол корреляции, используемый для диагностика Application Insights. "Устаревшая версия"
"Нет"
"W3C"
logClientIp Зайдите в журнал ClientIP. Значение по умолчанию — false. bool
loggerId Идентификатор ресурса целевого средства ведения журнала. строка (обязательно)
Метрики Создание пользовательских метрик с помощью политики отправки метрик. Применимо только к параметрам диагностики Application Insights. bool
operationNameFormat Формат имени операции для телеметрии Application Insights. Значение по умолчанию — Name. 'Name'
Url
выборка Параметры выборки для диагностики. SamplingSettings
Детализации Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. "error"
"information"
"verbose"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

Имя Описание Значение
Байты Число байтов текста запроса для записи в журнал. INT

DataMasking

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

DataMaskingEntity

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

SamplingSettings

Имя Описание Значение
процент Частота выборки для выборки с фиксированной частотой. INT
samplingType Тип выборки. "fixed"

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание Управление API во внутренней виртуальной сети с помощью Шлюза приложений

Развертывание в Azure
В этом шаблоне показано, как создать экземпляр azure Управление API в частной сети, защищенной Шлюз приложений Azure.
Шлюз приложений с внутренним Управление API и веб-приложением

Развертывание в Azure
Шлюз приложений маршрутизации интернет-трафика в виртуальную сеть (внутренний режим) Управление API экземпляр, который обслуживает веб-API, размещенный в веб-приложении Azure.

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

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

  • Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2023-03-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/диагностика

Имя Описание Значение
тип Тип ресурса "Microsoft.ApiManagement/service/диагностика@2023-03-01-preview"
name имя ресурса. string (обязательно)

Ограничение символов: 1-80

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: service
properties Свойства контракта диагностической сущности. Свойства DiagnosticContractProperties

Свойства DiagnosticContractProperties

Имя Описание Значение
alwaysLog Указывает, к какому типу сообщений не должны применяться параметры выборки. "allErrors"
серверная часть Параметры диагностики входящих и исходящих HTTP-сообщений в серверную часть PipelineDiagnosticSettings
Frontend Параметры диагностики для входящих и исходящих HTTP-сообщений, поступающих в шлюз. PipelineDiagnosticSettings
httpCorrelationProtocol Задает протокол корреляции, используемый для диагностика Application Insights. "Устаревшая версия"
"None"
"W3C"
logClientIp Зайдите в журнал ClientIP. Значение по умолчанию — false. bool
loggerId Идентификатор ресурса целевого средства ведения журнала. string (обязательно)
Метрики Создание пользовательских метрик с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights. bool
operationNameFormat Формат имени операции для телеметрии Application Insights. Значение по умолчанию — Name. "Name"
"Url"
выборка Параметры выборки для диагностики. SamplingSettings
Детализации Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. "error"
"information"
"подробно"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

Имя Описание Значение
Байты Число байтов текста запроса для записи в журнал. INT

DataMasking

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

DataMaskingEntity

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

SamplingSettings

Имя Описание Значение
процент Частота выборки для выборки с фиксированной частотой. INT
samplingType Тип выборки. "fixed"