Служба Microsoft.ApiManagement/apis/diagnostics 2018-06-01-preview

• последние
• 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/diagnostics можно развернуть с помощью операций, предназначенных для следующих операций:

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview' = {
  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'
        ]
      }
    }
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
  }
}

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

BodyDiagnosticSettings

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

DiagnosticContractProperties

Имя	Описание	Ценность
alwaysLog	Указывает, какой тип параметров выборки сообщений не должен применяться.	'allErrors'
серверная часть	Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Следует ли обрабатывать заголовки корреляции, поступающие в службу управления API. Применимо только к диагностике Application Insights. Значение по умолчанию — true.	bool
интерфейсный интерфейс	Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.	PipelineDiagnosticSettings
loggerId	Идентификатор ресурса целевого средства ведения журнала.	строка (обязательно)
выборка	Параметры выборки для диагностики.	выборкиSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

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

PipelineDiagnosticSettings

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

ВыборкаSettings

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

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2018-06-01-preview",
  "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" ]
      }
    },
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    }
  }
}

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

BodyDiagnosticSettings

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

DiagnosticContractProperties

Имя	Описание	Ценность
alwaysLog	Указывает, какой тип параметров выборки сообщений не должен применяться.	'allErrors'
серверная часть	Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Следует ли обрабатывать заголовки корреляции, поступающие в службу управления API. Применимо только к диагностике Application Insights. Значение по умолчанию — true.	bool
интерфейсный интерфейс	Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.	PipelineDiagnosticSettings
loggerId	Идентификатор ресурса целевого средства ведения журнала.	строка (обязательно)
выборка	Параметры выборки для диагностики.	выборкиSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

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

PipelineDiagnosticSettings

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

Выборка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@2018-06-01-preview"
  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"
          ]
        }
      }
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
    }
  })
}

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

BodyDiagnosticSettings

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

DiagnosticContractProperties

Имя	Описание	Ценность
alwaysLog	Указывает, какой тип параметров выборки сообщений не должен применяться.	'allErrors'
серверная часть	Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Следует ли обрабатывать заголовки корреляции, поступающие в службу управления API. Применимо только к диагностике Application Insights. Значение по умолчанию — true.	bool
интерфейсный интерфейс	Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.	PipelineDiagnosticSettings
loggerId	Идентификатор ресурса целевого средства ведения журнала.	строка (обязательно)
выборка	Параметры выборки для диагностики.	выборкиSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

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

PipelineDiagnosticSettings

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

ВыборкаSettings

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