Microsoft.ApiManagement 服務/記錄器 2022-08-01

Bicep 資源定義

服務/記錄器資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.ApiManagement/service/loggers 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.ApiManagement/service/loggers@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    credentials: {
      {customized property}: 'string'
    }
    description: 'string'
    isBuffered: bool
    loggerType: 'string'
    resourceId: 'string'
  }
}

屬性值

服務/記錄器

名字 描述 價值
名字 資源名稱

請參閱如何在 Bicep 中設定子資源的名稱和類型。
字串 (必要)

字元限制:1-80

合法字元:
英數位元和連字元。

以字母開頭,並以英數位元結尾。
父母 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型的資源符號名稱:服務
性能 記錄器實體合約屬性。 LoggerContractProperties

LoggerContractProperties

名字 描述 價值
憑據 azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。
applicationInsights 記錄器檢測密鑰。
LoggerContractPropertiesCredentials
描述 記錄器描述。 字串

約束:
最大長度 = 256
isBuffered 在發佈之前,記錄是否會在記錄器中緩衝處理。 默認值假設為 true。 bool
loggerType 記錄器類型。 'applicationInsights'
'azureEventHub'
'azureMonitor' (必要)
resourceId 記錄目標的 Azure 資源識別碼(Azure 事件中樞資源或 Azure Application Insights 資源)。 字串

LoggerContractPropertiesCredentials

名字 描述 價值
{自定義屬性} 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用範本 建立 API 管理實例和所有子資源

部署至 Azure
此範本示範如何建立 API 管理服務及設定子實體
使用應用程式閘道在內部 VNet 中建立 API 管理

部署至 Azure
此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。
Moesif API分析和獲利

部署至 Azure
此範本會將來自 Azure API 管理的 API 呼叫記錄至 Moesif API 分析和獲利平臺
在 Azure API 管理 前建立 Azure Front Door

部署至 Azure
此範例示範如何在 Azure API 管理前使用 Azure Front Door 作為全域負載平衡器。
使用內部 API 管理和 Web 應用程式 應用程式閘道

部署至 Azure
應用程式閘道會將因特網流量路由傳送至虛擬網路(內部模式)API 管理實例,此實例會服務裝載於 Azure Web 應用程式中的 Web API。

ARM 樣本資源定義

服務/記錄器資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.ApiManagement/service/loggers 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.ApiManagement/service/loggers",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "credentials": {
      "{customized property}": "string"
    },
    "description": "string",
    "isBuffered": "bool",
    "loggerType": "string",
    "resourceId": "string"
  }
}

屬性值

服務/記錄器

名字 描述 價值
類型 資源類型 'Microsoft.ApiManagement/service/loggers'
apiVersion 資源 API 版本 '2022-08-01'
名字 資源名稱

請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。
字串 (必要)

字元限制:1-80

合法字元:
英數位元和連字元。

以字母開頭,並以英數位元結尾。
性能 記錄器實體合約屬性。 LoggerContractProperties

LoggerContractProperties

名字 描述 價值
憑據 azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。
applicationInsights 記錄器檢測密鑰。
LoggerContractPropertiesCredentials
描述 記錄器描述。 字串

約束:
最大長度 = 256
isBuffered 在發佈之前,記錄是否會在記錄器中緩衝處理。 默認值假設為 true。 bool
loggerType 記錄器類型。 'applicationInsights'
'azureEventHub'
'azureMonitor' (必要)
resourceId 記錄目標的 Azure 資源識別碼(Azure 事件中樞資源或 Azure Application Insights 資源)。 字串

LoggerContractPropertiesCredentials

名字 描述 價值
{自定義屬性} 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用範本 建立 API 管理實例和所有子資源

部署至 Azure
此範本示範如何建立 API 管理服務及設定子實體
使用應用程式閘道在內部 VNet 中建立 API 管理

部署至 Azure
此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。
Moesif API分析和獲利

部署至 Azure
此範本會將來自 Azure API 管理的 API 呼叫記錄至 Moesif API 分析和獲利平臺
在 Azure API 管理 前建立 Azure Front Door

部署至 Azure
此範例示範如何在 Azure API 管理前使用 Azure Front Door 作為全域負載平衡器。
使用內部 API 管理和 Web 應用程式 應用程式閘道

部署至 Azure
應用程式閘道會將因特網流量路由傳送至虛擬網路(內部模式)API 管理實例,此實例會服務裝載於 Azure Web 應用程式中的 Web API。

Terraform (AzAPI 提供者) 資源定義

服務/記錄器資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.ApiManagement/service/loggers 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/loggers@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      credentials = {
        {customized property} = "string"
      }
      description = "string"
      isBuffered = bool
      loggerType = "string"
      resourceId = "string"
    }
  })
}

屬性值

服務/記錄器

名字 描述 價值
類型 資源類型 “Microsoft.ApiManagement/service/loggers@2022-08-01”
名字 資源名稱 字串 (必要)

字元限制:1-80

合法字元:
英數位元和連字元。

以字母開頭,並以英數位元結尾。
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼:服務
性能 記錄器實體合約屬性。 LoggerContractProperties

LoggerContractProperties

名字 描述 價值
憑據 azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。
applicationInsights 記錄器檢測密鑰。
LoggerContractPropertiesCredentials
描述 記錄器描述。 字串

約束:
最大長度 = 256
isBuffered 在發佈之前,記錄是否會在記錄器中緩衝處理。 默認值假設為 true。 bool
loggerType 記錄器類型。 “applicationInsights”
“azureEventHub”
“azureMonitor” (必要)
resourceId 記錄目標的 Azure 資源識別碼(Azure 事件中樞資源或 Azure Application Insights 資源)。 字串

LoggerContractPropertiesCredentials

名字 描述 價值
{自定義屬性} 字串