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

Microsoft.ApiManagement service/loggers 2021-04-01-preview

Bicep 资源定义

可以使用面向以下操作部署服务/记录器资源类型:

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

资源格式

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

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

属性值

service/loggers

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)

字符限制:1-80

有效字符:
字母数字和连字符。

以字母开头且以字母数字结尾。
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

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

LoggerContractProperties

名称 说明
凭据 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。
applicationInsights 记录器检测密钥。
LoggerContractPropertiesCredentials
description 记录器说明。 字符串
isBuffered 发布前是否在记录器中缓冲记录。 默认值假定为 true。 bool
loggerType 记录器类型。 “applicationInsights”
“azureEventHub”
需要“azureMonitor” ()
ResourceId 日志目标的 Azure 资源 ID (Azure 事件中心资源或 Azure 应用程序 Insights 资源) 。 字符串

LoggerContractPropertiesCredentials

名称 说明
{customized property} 字符串

快速入门模板

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

模板 说明
使用模板创建 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
应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例,该实例为 Azure Web 应用中托管的 Web API 提供服务。

ARM 模板资源定义

可以使用面向以下操作部署服务/记录器资源类型:

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

资源格式

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

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

属性值

service/loggers

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/loggers”
apiVersion 资源 API 版本 “2021-04-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-80

有效字符:
字母数字和连字符。

以字母开头且以字母数字结尾。
properties 记录器实体协定属性。 LoggerContractProperties

LoggerContractProperties

名称 说明
凭据 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。
applicationInsights 记录器检测密钥。
LoggerContractPropertiesCredentials
description 记录器说明。 字符串
isBuffered 发布前记录是否在记录器中缓冲。 假定默认值为 true。 bool
loggerType 记录器类型。 “applicationInsights”
“azureEventHub”
“azureMonitor” (必需)
ResourceId 日志目标的 Azure 资源 ID (Azure 事件中心资源或 Azure 应用程序 Insights 资源) 。 字符串

LoggerContractPropertiesCredentials

名称 说明
{customized property} 字符串

快速入门模板

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

模板 说明
使用模板创建 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
应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例,该实例为 Azure Web 应用中托管的 Web API 提供服务。

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

服务/记录器资源类型可以通过针对以下操作进行部署:

  • 资源组

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

资源格式

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

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

属性值

service/loggers

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/loggers@2021-04-01-preview”
name 资源名称 字符串 (必需)

字符限制:1-80

有效字符:
字母数字和连字符。

以字母开头且以字母数字结尾。
parent_id 此资源的父资源 ID。 类型为“服务”的资源的 ID
properties 记录器实体协定属性。 LoggerContractProperties

LoggerContractProperties

名称 说明
凭据 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。
applicationInsights 记录器检测密钥。
LoggerContractPropertiesCredentials
description 记录器说明。 字符串
isBuffered 发布前记录是否在记录器中缓冲。 假定默认值为 true。 bool
loggerType 记录器类型。 “applicationInsights”
“azureEventHub”
“azureMonitor” (必需)
ResourceId 日志目标的 Azure 资源 ID (Azure 事件中心资源或 Azure 应用程序 Insights 资源) 。 字符串

LoggerContractPropertiesCredentials

名称 说明
{customized property} 字符串