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/loggers 資源，請將下列 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
| 名字 | 描述 | 價值 |
|---|---|---|
| 憑據 | azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。 applicationInsights 記錄器檢測密鑰。 |
LoggerContractPropertiesCredentials （必要） |
| 描述 | 記錄器描述。 | 字串 約束： 最大長度 = |
| 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格式的持續時間之後，允許其增加取樣率。 | 字串 |
| samplingType | 取樣類型。 | 'adaptive' 'fixed' |
Microsoft.ApiManagement/service/loggers
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：服務 |
| 性能 | 記錄器實體合約屬性。 | LoggerContractProperties |
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 使用內部 API 管理和 Web 應用程式 |
應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）API 管理實例，此實例會服務裝載於 Azure Web 應用程式中的 Web API。 |
| 使用應用程式閘道在內部 VNet 中建立 API 管理 | 此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。 |
| Moesif API分析和獲利 | 此範本會將來自 Azure API 管理的 API 呼叫記錄至 Moesif API 分析和獲利平臺 |
ARM 樣本資源定義
服務/記錄器資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/loggers 資源，請將下列 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
| 名字 | 描述 | 價值 |
|---|---|---|
| 憑據 | azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。 applicationInsights 記錄器檢測密鑰。 |
LoggerContractPropertiesCredentials （必要） |
| 描述 | 記錄器描述。 | 字串 約束： 最大長度 = |
| 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格式的持續時間之後，允許其增加取樣率。 | 字串 |
| samplingType | 取樣類型。 | 'adaptive' 'fixed' |
Microsoft.ApiManagement/service/loggers
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2017-03-01' |
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| 性能 | 記錄器實體合約屬性。 | LoggerContractProperties |
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/loggers' |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
使用內部 API 管理和 Web 應用程式 
|
應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）API 管理實例，此實例會服務裝載於 Azure Web 應用程式中的 Web API。 |
|
使用應用程式閘道在內部 VNet 中建立 API 管理
|
此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。 |
|
在 Azure API 管理 前建立 Azure Front Door
|
此範例示範如何在 Azure API 管理前使用 Azure Front Door 作為全域負載平衡器。 |
|
Moesif API分析和獲利
|
此範本會將來自 Azure API 管理的 API 呼叫記錄至 Moesif API 分析和獲利平臺 |
Terraform （AzAPI 提供者） 資源定義
服務/記錄器資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/loggers 資源，請將下列 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
| 名字 | 描述 | 價值 |
|---|---|---|
| 憑據 | azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。 applicationInsights 記錄器檢測密鑰。 |
LoggerContractPropertiesCredentials （必要） |
| 描述 | 記錄器描述。 | 字串 約束： 最大長度 = |
| 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格式的持續時間之後，允許其增加取樣率。 | 字串 |
| samplingType | 取樣類型。 | 'adaptive' 'fixed' |
Microsoft.ApiManagement/service/loggers
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | 記錄器實體合約屬性。 | LoggerContractProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/loggers@2017-03-01” |