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

Microsoft.Insights diagnosticSettings

  • 项目

Bicep 资源定义

diagnosticSettings 资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 Bicep 中设置扩展资源的范围。

可以使用面向以下操作部署 diagnosticSettings 资源类型：

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

注解

有关部署监视解决方案的指南，请参阅 使用 Bicep 创建监视资源。

资源格式

若要创建 Microsoft.Insights/diagnosticSettings 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Insights/diagnosticSettings@2021-05-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    eventHubAuthorizationRuleId: 'string'
    eventHubName: 'string'
    logAnalyticsDestinationType: 'string'
    logs: [
      {
        category: 'string'
        categoryGroup: 'string'
        enabled: bool
        retentionPolicy: {
          days: int
          enabled: bool
        }
      }
    ]
    marketplacePartnerId: 'string'
    metrics: [
      {
        category: 'string'
        enabled: bool
        retentionPolicy: {
          days: int
          enabled: bool
        }
        timeGrain: 'string'
      }
    ]
    serviceBusRuleId: 'string'
    storageAccountId: 'string'
    workspaceId: 'string'
  }
}

属性值

diagnosticSettings

名称 说明 值
name 资源名称 字符串 (必需)
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 Bicep，请将此属性设置为要应用 扩展资源的符号名称。
properties 诊断设置资源的属性。 DiagnosticSettings

DiagnosticSettings

名称 说明 值
eventHubAuthorizationRuleId 事件中心授权规则的资源 ID。 string
eventHubName 事件中心的名称。 如果未指定，则将选择默认事件中心。 字符串
logAnalyticsDestinationType 一个字符串，指示导出到 Log Analytics 是应使用默认目标类型（即 AzureDiagnostics），还是使用构造如下的目标类型：{规范化服务标识}_{规范化类别名称}。 可能的值为：Dedicated 和 null (null 为 default.) 字符串
日志 日志设置的列表。 LogSettings[]
marketplacePartnerId 要向其发送诊断日志的市场资源的完整 ARM 资源 ID。 字符串
指标 指标设置的列表。 MetricSettings[]
serviceBusRuleId 诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。 字符串
storageAccountId 要向其发送诊断日志的存储帐户的资源 ID。 字符串
workspaceId 要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 字符串

LogSettings

名称 说明 值
category 此设置应用于的资源类型的诊断日志类别的名称。 若要获取资源的诊断日志类别列表，请先执行 GET 诊断设置操作。 字符串
categoryGroup 应用此设置的资源类型的诊断日志类别组的名称。 若要获取资源的诊断日志类别列表，请先执行 GET 诊断设置操作。 string
enabled 一个值，该值指示是否启用此日志。 需要 bool ()
retentionPolicy 此日志的保留策略。 RetentionPolicy

RetentionPolicy

名称 说明 值
days 保留天数（以天为单位）。 值为 0 将无限期保留事件。 int (必需)

约束：
最小值 = 0
enabled 一个值，该值指示是否启用保留策略。 bool (必需)

MetricSettings

名称 说明 值
category 应用此设置的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表，请先执行 GET 诊断设置操作。 字符串
enabled 一个值，该值指示是否启用此类别。 bool (必需)
retentionPolicy 此类别的保留策略。 RetentionPolicy
timeGrain ISO8601格式的指标的 timegrain。 字符串

快速入门模板

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

模板 说明
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure		 此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，为入站连接部署应用程序网关。
创建具有公共 DNS 区域的专用 AKS 群集

部署到 Azure		 此示例演示如何部署具有公共 DNS 区域的专用 AKS 群集。
使用应用网关在内部 VNet 中创建API 管理

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

部署到 Azure		 此模板创建 Azure API 管理 服务和 Log Analytics 工作区的实例，并使用 Log Analytics 为API 管理服务设置监视
部署简单的 Azure Spring Apps 微服务应用程序

部署到 Azure		 此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。
创建 Azure Stack HCI 23H2 群集

部署到 Azure		 此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
使用模板创建 Redis 缓存

部署到 Azure		 此模板创建 Azure Redis 缓存，其中诊断数据保存在存储帐户中。
创建具有群集功能的高级 Redis 缓存

部署到 Azure		 此模板演示如何在高级 Azure Redis 缓存实例中配置聚类分析。
创建具有数据暂留的高级 Redis 缓存

部署到 Azure		 此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
具有 WAF 和 Microsoft 托管规则集的 Front Door Premium

部署到 Azure		 此模板创建一个 Front Door Premium，其中包含具有 Microsoft 托管的默认和机器人保护规则集的 Web 应用程序防火墙。
具有 WAF 和自定义规则的 Front Door 标准版/高级版

部署到 Azure		 此模板创建 Front Door 标准版/高级版，包括具有自定义规则的 Web 应用程序防火墙。
使用策略和诊断Azure 容器注册表

部署到 Azure		 使用策略和诊断 (bicep) Azure 容器注册表
使用 Git 和托管 vnet 配置Azure 数据工厂

部署到 Azure		 此模板使用 Git 配置和托管虚拟网络创建Azure 数据工厂。
包含解决方案和数据源的 Log Analytics 工作区

部署到 Azure		 部署具有指定解决方案和数据源的 Log Analytics 工作区
使用 VM 见解、容器见解的 Log Analytics 工作区

部署到 Azure		 使用 VM 见解、容器见解解决方案和诊断部署 Log Analytics 工作区。
创建启用了日志记录的密钥保管库

部署到 Azure		 此模板创建一个 Azure 密钥保管库和一个用于日志记录的 Azure 存储帐户。 可以选择创建资源锁来保护密钥保管库和存储资源。
具有 应用程序网关 入口控制器的 AKS 群集

部署到 Azure		 此示例演示如何使用 应用程序网关、应用程序网关 入口控制器、Azure 容器注册表、Log Analytics 和 密钥保管库 部署 AKS 群集
使用 WAF 和防火墙策略应用程序网关

部署到 Azure		 此模板创建一个应用程序网关，其中配置了 WAF 和防火墙策略
在中心 & 辐射型拓扑中使用 Azure 防火墙 作为 DNS 代理

部署到 Azure		 此示例演示如何使用 Azure 防火墙 在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当与通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心连接点。
在 Azure API 管理前面创建 Azure Front Door

部署到 Azure		 此示例演示如何在 Azure API 管理前面使用 Azure Front Door 作为全局负载均衡器。
包含诊断日志的网络安全组

部署到 Azure		 此模板创建包含诊断日志和资源锁的网络安全组
Azure 虚拟 WAN路由意向和策略

部署到 Azure		 此模板预配 Azure 虚拟 WAN，其中两个中心启用了路由意向和策略功能。
具有诊断日志的虚拟网络

部署到 Azure		 此模板创建包含诊断日志的虚拟网络，并允许将可选功能添加到每个子网
创建恢复服务保管库并启用诊断

部署到 Azure		 此模板创建恢复服务保管库，并为Azure 备份启用诊断。 这还会部署存储帐户和 oms 工作区。
使用备份策略创建恢复服务保管库

部署到 Azure		 此模板使用备份策略创建恢复服务保管库，并配置可选功能，例如系统标识、备份存储类型、跨区域还原和诊断日志和删除锁。
将审核写入事件中心的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入事件中心
将审核写入 Log Analytics 的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入 Log Analytics (OMS 工作区)
使用配置的日志和指标发送创建 SQL MI

部署到 Azure		 通过此模板，可以部署用于存储诊断工作区、存储帐户、事件中心) (日志和指标的 SQL MI 和其他资源。
使用内部API 管理和 Web 应用应用程序网关

部署到 Azure		 应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。

ARM 模板资源定义

diagnosticSettings 资源类型是 扩展资源，这意味着你可以将其应用于其他资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 ARM 模板中设置扩展资源的范围。

diagnosticSettings 资源类型可以使用面向以下对象的操作进行部署：

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

注解

有关部署监视解决方案的指南，请参阅 使用 Bicep 创建监视资源。

资源格式

若要创建 Microsoft.Insights/diagnosticSettings 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Insights/diagnosticSettings",
  "apiVersion": "2021-05-01-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "eventHubAuthorizationRuleId": "string",
    "eventHubName": "string",
    "logAnalyticsDestinationType": "string",
    "logs": [
      {
        "category": "string",
        "categoryGroup": "string",
        "enabled": "bool",
        "retentionPolicy": {
          "days": "int",
          "enabled": "bool"
        }
      }
    ],
    "marketplacePartnerId": "string",
    "metrics": [
      {
        "category": "string",
        "enabled": "bool",
        "retentionPolicy": {
          "days": "int",
          "enabled": "bool"
        },
        "timeGrain": "string"
      }
    ],
    "serviceBusRuleId": "string",
    "storageAccountId": "string",
    "workspaceId": "string"
  }
}

属性值

diagnosticSettings

名称 说明 Value
type 资源类型 “Microsoft.Insights/diagnosticSettings”
apiVersion 资源 API 版本 “2021-05-01-preview”
name 资源名称 字符串 (必需)
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 JSON，请将值设置为要向其应用 扩展资源 的资源的全名。
properties 诊断设置资源的属性。 DiagnosticSettings

DiagnosticSettings

名称 说明 值
eventHubAuthorizationRuleId 事件中心授权规则的资源 ID。 字符串
eventHubName 事件中心的名称。 如果未指定任何内容，则将选择默认事件中心。 string
logAnalyticsDestinationType 一个字符串，指示导出到 Log Analytics 是应使用默认目标类型（即 AzureDiagnostics），还是使用构造如下的目标类型：{规范化服务标识}_{规范化类别名称}。 可能的值为：Dedicated 和 null (null 为 default。) 字符串
日志 日志设置的列表。 LogSettings[]
marketplacePartnerId 要向其发送诊断日志的市场资源的完整 ARM 资源 ID。 字符串
指标 指标设置列表。 MetricSettings[]
serviceBusRuleId 诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。 字符串
storageAccountId 要向其发送诊断日志的存储帐户的资源 ID。 string
workspaceId 要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 字符串

LogSettings

名称 说明 值
category 应用此设置的资源类型的诊断日志类别的名称。 若要获取资源的诊断日志类别列表，请先执行 GET 诊断设置操作。 string
categoryGroup 应用此设置的资源类型的诊断日志类别组的名称。 若要获取资源的诊断日志类别列表，请先执行 GET 诊断设置操作。 字符串
enabled 一个值，该值指示是否启用此日志。 bool (必需)
retentionPolicy 此日志的保留策略。 RetentionPolicy

RetentionPolicy

名称 说明 值
days 保留天数（以天为单位）。 值为 0 将无限期保留事件。 int (必需)

约束：
最小值 = 0
enabled 一个值，该值指示是否启用保留策略。 bool (必需)

MetricSettings

名称 说明 值
category 应用此设置的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表，请先执行 GET 诊断设置操作。 字符串
enabled 一个值，该值指示是否启用此类别。 bool (必需)
retentionPolicy 此类别的保留策略。 RetentionPolicy
timeGrain ISO8601格式的指标的 timegrain。 字符串

快速入门模板

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

模板 说明
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure		 此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，为入站连接部署应用程序网关。
创建具有公共 DNS 区域的专用 AKS 群集

部署到 Azure		 此示例演示如何部署具有公共 DNS 区域的专用 AKS 群集。
使用应用网关在内部 VNet 中创建API 管理

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

部署到 Azure		 此模板创建 Azure API 管理 服务和 Log Analytics 工作区的实例，并使用 Log Analytics 为API 管理服务设置监视
部署简单的 Azure Spring Apps 微服务应用程序

部署到 Azure		 此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。
创建 Azure Stack HCI 23H2 群集

部署到 Azure		 此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
使用模板创建 Redis 缓存

部署到 Azure		 此模板创建 Azure Redis 缓存，其中诊断数据保存在存储帐户中。
创建具有群集功能的高级 Redis 缓存

部署到 Azure		 此模板演示如何在高级 Azure Redis 缓存实例中配置聚类分析。
创建具有数据暂留的高级 Redis 缓存

部署到 Azure		 此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
具有 WAF 和 Microsoft 托管规则集的 Front Door Premium

部署到 Azure		 此模板创建一个 Front Door Premium，其中包含具有 Microsoft 托管的默认和机器人保护规则集的 Web 应用程序防火墙。
具有 WAF 和自定义规则的 Front Door 标准版/高级版

部署到 Azure		 此模板创建 Front Door 标准版/高级版，包括具有自定义规则的 Web 应用程序防火墙。
使用策略和诊断Azure 容器注册表

部署到 Azure		 使用策略和诊断 (bicep) Azure 容器注册表
使用 Git 和托管 vnet 配置Azure 数据工厂

部署到 Azure		 此模板使用 Git 配置和托管虚拟网络创建Azure 数据工厂。
包含解决方案和数据源的 Log Analytics 工作区

部署到 Azure		 部署具有指定解决方案和数据源的 Log Analytics 工作区
使用 VM 见解、容器见解的 Log Analytics 工作区

部署到 Azure		 使用 VM 见解、容器见解解决方案和诊断部署 Log Analytics 工作区。
创建启用了日志记录的密钥保管库

部署到 Azure		 此模板创建一个 Azure 密钥保管库和一个用于日志记录的 Azure 存储帐户。 可以选择创建资源锁来保护密钥保管库和存储资源。
具有 应用程序网关 入口控制器的 AKS 群集

部署到 Azure		 此示例演示如何使用 应用程序网关、应用程序网关 入口控制器、Azure 容器注册表、Log Analytics 和 密钥保管库 部署 AKS 群集
使用 WAF 和防火墙策略应用程序网关

部署到 Azure		 此模板创建一个应用程序网关，其中配置了 WAF 和防火墙策略
在中心 & 辐射型拓扑中使用 Azure 防火墙 作为 DNS 代理

部署到 Azure		 此示例演示如何使用 Azure 防火墙 在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当与通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心连接点。
在 Azure API 管理前面创建 Azure Front Door

部署到 Azure		 此示例演示如何在 Azure API 管理前面使用 Azure Front Door 作为全局负载均衡器。
包含诊断日志的网络安全组

部署到 Azure		 此模板创建包含诊断日志和资源锁的网络安全组
Azure 虚拟 WAN路由意向和策略

部署到 Azure		 此模板预配 Azure 虚拟 WAN，其中两个中心启用了路由意向和策略功能。
具有诊断日志的虚拟网络

部署到 Azure		 此模板创建包含诊断日志的虚拟网络，并允许将可选功能添加到每个子网
创建恢复服务保管库并启用诊断

部署到 Azure		 此模板创建恢复服务保管库并为Azure 备份启用诊断。 这还会部署存储帐户和 oms 工作区。
使用备份策略创建恢复服务保管库

部署到 Azure		 此模板使用备份策略创建恢复服务保管库，并配置可选功能，例如系统标识、备份存储类型、跨区域还原和诊断日志和删除锁。
将审核写入事件中心的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的 Azure SQL 服务器，以便将审核日志写入事件中心
将审核写入 Log Analytics 的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的 Azure SQL 服务器，以便将审核日志写入 Log Analytics (OMS 工作区)
创建配置了日志和指标发送的 SQL MI

部署到 Azure		 此模板允许部署 SQL MI 和其他资源，用于存储诊断工作区、存储帐户、事件中心) (日志和指标。
使用内部API 管理和 Web 应用应用程序网关

部署到 Azure		 应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。

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

diagnosticSettings 资源类型是 扩展资源，这意味着你可以将其应用于另一个资源。

parent_id使用此资源上的 属性可设置此资源的作用域。

可以使用面向以下操作部署 diagnosticSettings 资源类型：

  • 资源组

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

资源格式

若要创建 Microsoft.Insights/diagnosticSettings 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/diagnosticSettings@2021-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      eventHubAuthorizationRuleId = "string"
      eventHubName = "string"
      logAnalyticsDestinationType = "string"
      logs = [
        {
          category = "string"
          categoryGroup = "string"
          enabled = bool
          retentionPolicy = {
            days = int
            enabled = bool
          }
        }
      ]
      marketplacePartnerId = "string"
      metrics = [
        {
          category = "string"
          enabled = bool
          retentionPolicy = {
            days = int
            enabled = bool
          }
          timeGrain = "string"
        }
      ]
      serviceBusRuleId = "string"
      storageAccountId = "string"
      workspaceId = "string"
    }
  })
}

属性值

diagnosticSettings

名称 说明 Value
type 资源类型 “Microsoft.Insights/diagnosticSettings@2021-05-01-preview”
name 资源名称 字符串 (必需)
parent_id 要应用此扩展资源的资源的 ID。 字符串 (必需)
properties 诊断设置资源的属性。 DiagnosticSettings

DiagnosticSettings

名称 说明 值
eventHubAuthorizationRuleId 事件中心授权规则的资源 ID。 字符串
eventHubName 事件中心的名称。 如果未指定，则将选择默认事件中心。 string
logAnalyticsDestinationType 一个字符串，指示导出到 Log Analytics 是应使用默认目标类型（即 AzureDiagnostics），还是使用构造如下的目标类型：{规范化服务标识}_{规范化类别名称}。 可能的值为：Dedicated 和 null (null 为 default.) 字符串
日志 日志设置的列表。 LogSettings[]
marketplacePartnerId 要向其发送诊断日志的市场资源的完整 ARM 资源 ID。 string
指标 指标设置的列表。 MetricSettings[]
serviceBusRuleId 诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。 字符串
storageAccountId 要向其发送诊断日志的存储帐户的资源 ID。 string
workspaceId 要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 字符串

LogSettings

名称 说明 值
category 此设置应用于的资源类型的诊断日志类别的名称。 若要获取资源的诊断日志类别列表，请先执行 GET 诊断设置操作。 string
categoryGroup 应用此设置的资源类型的诊断日志类别组的名称。 若要获取资源的诊断日志类别列表，请先执行 GET 诊断设置操作。 string
enabled 一个值，该值指示是否启用此日志。 需要 bool ()
retentionPolicy 此日志的保留策略。 RetentionPolicy

RetentionPolicy

名称 说明 值
days 保留天数（以天为单位）。 值为 0 将无限期保留事件。 int (必需)

约束：
最小值 = 0
enabled 指示是否启用保留策略的值。 需要 bool ()

MetricSettings

名称 说明 值
category 应用此设置的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表，请先执行 GET 诊断设置操作。 字符串
enabled 一个值，该值指示是否启用此类别。 需要 bool ()
retentionPolicy 此类别的保留策略。 RetentionPolicy
timeGrain 指标的时间基元，采用ISO8601格式。 字符串