你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.ApiManagement 服务/记录器 2023-03-01-preview

Bicep 资源定义

可以使用目标操作部署服务/记录器资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.ApiManagement/service/loggers 资源,请将以下 Bicep 添加到模板。

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

属性值

LoggerContractProperties

名字 描述 价值
凭据 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。
applicationInsights 记录器检测密钥。
LoggerContractPropertiesCredentials
描述 记录器说明。 字符串

约束:
最大长度 = 256
isBuffered 是否在发布前缓冲记录器中的记录。 默认值假定为 true。 bool
loggerType 记录器类型。 “applicationInsights”
“azureEventHub”
“azureMonitor”(必需)
resourceId 日志目标的 Azure 资源 ID(Azure 事件中心资源或 Azure Application Insights 资源)。 字符串

LoggerContractPropertiesCredentials

名字 描述 价值

Microsoft.ApiManagement/service/loggers

名字 描述 价值
名字 资源名称 字符串

约束:
最大长度 = 256
模式 = ^[^*#&+:<>?]+$ (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:服务
性能 记录器实体协定属性。 LoggerContractProperties

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
使用内部 API 管理和 Web 应用 应用程序网关 应用程序网关将 Internet 流量路由到虚拟网络(内部模式)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": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "credentials": {
      "{customized property}": "string"
    },
    "description": "string",
    "isBuffered": "bool",
    "loggerType": "string",
    "resourceId": "string"
  }
}

属性值

LoggerContractProperties

名字 描述 价值
凭据 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。
applicationInsights 记录器检测密钥。
LoggerContractPropertiesCredentials
描述 记录器说明。 字符串

约束:
最大长度 = 256
isBuffered 是否在发布前缓冲记录器中的记录。 默认值假定为 true。 bool
loggerType 记录器类型。 “applicationInsights”
“azureEventHub”
“azureMonitor”(必需)
resourceId 日志目标的 Azure 资源 ID(Azure 事件中心资源或 Azure Application Insights 资源)。 字符串

LoggerContractPropertiesCredentials

名字 描述 价值

Microsoft.ApiManagement/service/loggers

名字 描述 价值
apiVersion API 版本 '2023-03-01-preview'
名字 资源名称 字符串

约束:
最大长度 = 256
模式 = ^[^*#&+:<>?]+$ (必需)
性能 记录器实体协定属性。 LoggerContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/loggers”

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用内部 API 管理和 Web 应用 应用程序网关

部署到 Azure
应用程序网关将 Internet 流量路由到虚拟网络(内部模式)API 管理实例,该实例服务 Azure Web 应用中托管的 Web API。
使用应用网关在内部 VNet 中创建 API 管理

部署到 Azure
此模板演示如何在受 Azure 应用程序网关保护的专用网络上创建 Azure API 管理的实例。
在 Azure API 管理 前创建 Azure Front Door

部署到 Azure
此示例演示如何在 Azure API 管理之前将 Azure Front Door 用作全局负载均衡器。
Moesif API 分析和货币化

部署到 Azure
该模板会将来自 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署服务/记录器资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.ApiManagement/service/loggers 资源,请将以下 Terraform 添加到模板。

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

属性值

LoggerContractProperties

名字 描述 价值
凭据 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。
applicationInsights 记录器检测密钥。
LoggerContractPropertiesCredentials
描述 记录器说明。 字符串

约束:
最大长度 = 256
isBuffered 是否在发布前缓冲记录器中的记录。 默认值假定为 true。 bool
loggerType 记录器类型。 “applicationInsights”
“azureEventHub”
“azureMonitor”(必需)
resourceId 日志目标的 Azure 资源 ID(Azure 事件中心资源或 Azure Application Insights 资源)。 字符串

LoggerContractPropertiesCredentials

名字 描述 价值

Microsoft.ApiManagement/service/loggers

名字 描述 价值
名字 资源名称 字符串

约束:
最大长度 = 256
模式 = ^[^*#&+:<>?]+$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:服务
性能 记录器实体协定属性。 LoggerContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/loggers@2023-03-01-preview”