Служба Microsoft.ApiManagement/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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/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

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

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" "информация" "подробный"

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/diagnostics

Имя	Описание	Ценность
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 Pattern = ^[^*#&+:<>?]+$ (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: служба
свойства	Свойства контракта сущности диагностики.	DiagnosticContractProperties

PipelineDiagnosticSettings

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

ВыборкаSettings

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

Примеры краткого руководства

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

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

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.ApiManagement/service/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

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

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" "информация" "подробный"

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/diagnostics

Имя	Описание	Ценность
apiVersion	Версия API	'2020-12-01'
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 Pattern = ^[^*#&+:<>?]+$ (обязательно)
свойства	Свойства контракта сущности диагностики.	DiagnosticContractProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/diagnostics"

PipelineDiagnosticSettings

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

ВыборкаSettings

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/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

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

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" "информация" "подробный"

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/diagnostics

Имя	Описание	Ценность
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 Pattern = ^[^*#&+:<>?]+$ (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: службы
свойства	Свойства контракта сущности диагностики.	DiagnosticContractProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/diagnostics@2020-12-01"

PipelineDiagnosticSettings

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

ВыборкаSettings

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