Служба Microsoft.ApiManagement и средства ведения журнала 2017-03-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
- 2016-10-10
- 2016-07-07
Определение ресурсов Bicep
Тип ресурса службы или средства ведения журнала можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/logers, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/loggers@2017-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
credentials: {
{customized property}: 'string'
}
description: 'string'
isBuffered: bool
loggerType: 'string'
sampling: {
properties: {
evaluationInterval: 'string'
initialPercentage: int
maxPercentage: int
maxTelemetryItemsPerSecond: int
minPercentage: int
movingAverageRatio: int
percentage: int
percentageDecreaseTimeout: 'string'
percentageIncreaseTimeout: 'string'
samplingType: 'string'
}
}
}
}
Значения свойств
LoggerContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| верительные грамоты | Имя и строка подключения SendRule концентратора событий для средства ведения журнала AzureEventHub. Ключ инструментирования для средства ведения журнала applicationInsights. |
LoggerContractPropertiesCredentials (обязательно) |
| описание | Описание средства ведения журнала. | струна Ограничения целостности: Максимальная длина = 256 |
| isBuffered | Следует ли буферизать записи в средстве ведения журнала перед публикацией. Предполагается, что значение по умолчанию имеет значение true. | bool |
| loggerType | Тип средства ведения журнала. | ApplicationInsights AzureEventHub (обязательно) |
| выборка | Параметры выборки для средства ведения журнала ApplicationInsights. | LoggerSamplingContract |
LoggerContractPropertiesCredentials
| Имя | Описание | Ценность |
|---|
LoggerSamplingContract
| Имя | Описание | Ценность |
|---|---|---|
| свойства | Свойства контракта сущности параметров выборки. | LoggerSamplingProperties |
LoggerSamplingProperties
| Имя | Описание | Ценность |
|---|---|---|
| evaluationInterval | Интервал переоценки скорости в формате ISO8601. | струна |
| InitialPercentage | Начальная частота выборки. | int |
| maxPercentage | Максимальная допустимая частота выборки. | int |
| maxTelemetryItemsPerSecond | Целевая скорость элементов телеметрии в секунду. | int |
| minPercentage | Минимальная допустимая частота выборки. | int |
| movingAverageRatio | Скользящее среднее значение, назначенное последнему значению. | int |
| процент | Частота выборки для выборки фиксированной частоты. | int |
| percentageDecreaseTimeout | Длительность в ISO8601 формате, после которой разрешено снизить частоту выборки. | струна |
| percentageIncreaseTimeout | Длительность в ISO8601 формате, после которой разрешено увеличить частоту выборки. | струна |
| выборкаType | Тип выборки. | "адаптивный" "исправлено" |
Microsoft.ApiManagement/service/logers
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Свойства контракта сущности средства ведения журнала. | LoggerContractProperties |
Примеры использования
Примеры быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.
| Bicep-файл | Описание |
|---|---|
| Шлюз приложений с внутренним управлением API и веб-приложения | Шлюз приложений маршрутизации трафика Интернета в экземпляр управления API виртуальной сети (внутренний режим), который обслуживает веб-API, размещенный в веб-приложении Azure. |
| создание управления API в внутренней виртуальной сети с шлюза приложений | В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" в частной сети, защищенной шлюзом приложений Azure. |
| Аналитика API Moesif и монетизация | Шаблон регистрирует вызовы API из службы "Управление API Azure" в аналитику API Moesif и платформу монетизации |
Определение ресурса шаблона ARM
Тип ресурса службы или средства ведения журнала можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/logers, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/loggers",
"apiVersion": "2017-03-01",
"name": "string",
"properties": {
"credentials": {
"{customized property}": "string"
},
"description": "string",
"isBuffered": "bool",
"loggerType": "string",
"sampling": {
"properties": {
"evaluationInterval": "string",
"initialPercentage": "int",
"maxPercentage": "int",
"maxTelemetryItemsPerSecond": "int",
"minPercentage": "int",
"movingAverageRatio": "int",
"percentage": "int",
"percentageDecreaseTimeout": "string",
"percentageIncreaseTimeout": "string",
"samplingType": "string"
}
}
}
}
Значения свойств
LoggerContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| верительные грамоты | Имя и строка подключения SendRule концентратора событий для средства ведения журнала AzureEventHub. Ключ инструментирования для средства ведения журнала applicationInsights. |
LoggerContractPropertiesCredentials (обязательно) |
| описание | Описание средства ведения журнала. | струна Ограничения целостности: Максимальная длина = 256 |
| isBuffered | Следует ли буферизать записи в средстве ведения журнала перед публикацией. Предполагается, что значение по умолчанию имеет значение true. | bool |
| loggerType | Тип средства ведения журнала. | ApplicationInsights AzureEventHub (обязательно) |
| выборка | Параметры выборки для средства ведения журнала ApplicationInsights. | LoggerSamplingContract |
LoggerContractPropertiesCredentials
| Имя | Описание | Ценность |
|---|
LoggerSamplingContract
| Имя | Описание | Ценность |
|---|---|---|
| свойства | Свойства контракта сущности параметров выборки. | LoggerSamplingProperties |
LoggerSamplingProperties
| Имя | Описание | Ценность |
|---|---|---|
| evaluationInterval | Интервал переоценки скорости в формате ISO8601. | струна |
| InitialPercentage | Начальная частота выборки. | int |
| maxPercentage | Максимальная допустимая частота выборки. | int |
| maxTelemetryItemsPerSecond | Целевая скорость элементов телеметрии в секунду. | int |
| minPercentage | Минимальная допустимая частота выборки. | int |
| movingAverageRatio | Скользящее среднее значение, назначенное последнему значению. | int |
| процент | Частота выборки для выборки фиксированной частоты. | int |
| percentageDecreaseTimeout | Длительность в ISO8601 формате, после которой разрешено снизить частоту выборки. | струна |
| percentageIncreaseTimeout | Длительность в ISO8601 формате, после которой разрешено увеличить частоту выборки. | струна |
| выборкаType | Тип выборки. | "адаптивный" "исправлено" |
Microsoft.ApiManagement/service/logers
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2017-03-01' |
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| свойства | Свойства контракта сущности средства ведения журнала. | LoggerContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/logers" |
Примеры использования
Шаблоны быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Шлюз приложений с внутренним управлением API и веб-приложения развертывание  |
Шлюз приложений маршрутизации трафика Интернета в экземпляр управления API виртуальной сети (внутренний режим), который обслуживает веб-API, размещенный в веб-приложении Azure. |
|
создание управления API в внутренней виртуальной сети с шлюза приложений развертывание |
В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" в частной сети, защищенной шлюзом приложений Azure. |
|
создание Azure Front Door перед управления API Azure развертывание |
В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед управлением API Azure. |
|
Аналитика API Moesif и монетизация развертывание |
Шаблон регистрирует вызовы API из службы "Управление API Azure" в аналитику API Moesif и платформу монетизации |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса службы или средства ведения журнала можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/logers, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/loggers@2017-03-01"
name = "string"
body = jsonencode({
properties = {
credentials = {
{customized property} = "string"
}
description = "string"
isBuffered = bool
loggerType = "string"
sampling = {
properties = {
evaluationInterval = "string"
initialPercentage = int
maxPercentage = int
maxTelemetryItemsPerSecond = int
minPercentage = int
movingAverageRatio = int
percentage = int
percentageDecreaseTimeout = "string"
percentageIncreaseTimeout = "string"
samplingType = "string"
}
}
}
})
}
Значения свойств
LoggerContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| верительные грамоты | Имя и строка подключения SendRule концентратора событий для средства ведения журнала AzureEventHub. Ключ инструментирования для средства ведения журнала applicationInsights. |
LoggerContractPropertiesCredentials (обязательно) |
| описание | Описание средства ведения журнала. | струна Ограничения целостности: Максимальная длина = 256 |
| isBuffered | Следует ли буферизать записи в средстве ведения журнала перед публикацией. Предполагается, что значение по умолчанию имеет значение true. | bool |
| loggerType | Тип средства ведения журнала. | ApplicationInsights AzureEventHub (обязательно) |
| выборка | Параметры выборки для средства ведения журнала ApplicationInsights. | LoggerSamplingContract |
LoggerContractPropertiesCredentials
| Имя | Описание | Ценность |
|---|
LoggerSamplingContract
| Имя | Описание | Ценность |
|---|---|---|
| свойства | Свойства контракта сущности параметров выборки. | LoggerSamplingProperties |
LoggerSamplingProperties
| Имя | Описание | Ценность |
|---|---|---|
| evaluationInterval | Интервал переоценки скорости в формате ISO8601. | струна |
| InitialPercentage | Начальная частота выборки. | int |
| maxPercentage | Максимальная допустимая частота выборки. | int |
| maxTelemetryItemsPerSecond | Целевая скорость элементов телеметрии в секунду. | int |
| minPercentage | Минимальная допустимая частота выборки. | int |
| movingAverageRatio | Скользящее среднее значение, назначенное последнему значению. | int |
| процент | Частота выборки для выборки фиксированной частоты. | int |
| percentageDecreaseTimeout | Длительность в ISO8601 формате, после которой разрешено снизить частоту выборки. | струна |
| percentageIncreaseTimeout | Длительность в ISO8601 формате, после которой разрешено увеличить частоту выборки. | струна |
| выборкаType | Тип выборки. | "адаптивный" "исправлено" |
Microsoft.ApiManagement/service/logers
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Свойства контракта сущности средства ведения журнала. | LoggerContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/loggers@2017-03-01" |