通过

你当前正在访问 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

名字 描述 价值
名字 资源名称 string （必需）
范围 在与部署范围不同的范围内创建扩展资源时使用。 目标资源

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

DiagnosticSettings

名字 描述 价值
eventHubAuthorizationRuleId 事件中心授权规则的资源 ID。 字符串
eventHubName 事件中心的名称。 如果未指定任何事件，则会选择默认事件中心。 字符串
logAnalyticsDestinationType 一个字符串，指示导出到 Log Analytics 是否应使用默认目标类型，即 AzureDiagnostics，或使用构造的目标类型，如下所示：{normalized service identity}_{normalized category name}。 可能的值为：专用值和 null（默认值为 null）。 字符串
原木 日志设置的列表。 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

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

RetentionPolicy

名字 描述 价值
日 保留天数（以天为单位）。 值为 0 将无限期保留事件。 int （必需）

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

MetricSettings

名字 描述 价值
类别 此设置应用于的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表，请先执行 GET 诊断设置操作。 字符串
启用 一个值，该值指示是否启用此类别。 bool （必需）
retentionPolicy 此类别的保留策略。 RetentionPolicy
timeGrain ISO8601格式的指标的时间根。 字符串

快速入门模板

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

模板 描述
使用 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 群集。
创建 Azure Stack HCI 23H2 群集

部署到 Azure 		此模板使用 ARM 模板（使用自定义存储 IP）创建 Azure Stack HCI 23H2 群集
在无交换机-双链路网络模式下创建 Azure Stack HCI 23H2 群集

部署到 Azure 		此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
在 Switchless-SingleLink 网络模式下创建 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 		具有策略和诊断的 Azure 容器注册表 （bicep）
使用 Git 和托管 vnet 配置 Azure 数据工厂

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

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

部署到 Azure 		使用 VM Insights、Container Insights 解决方案和诊断部署 Log Analytics 工作区。
创建启用了日志记录的 Key Vault

部署到 Azure 		此模板创建用于日志记录的 Azure Key Vault 和 Azure 存储帐户。 它可以选择创建资源锁来保护 Key Vault 和存储资源。
使用应用程序网关入口控制器 AKS 群集

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

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

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

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

部署到 Azure 		此模板创建一个网络安全组，其中包含诊断日志和资源锁
使用诊断日志 虚拟网络

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

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

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

部署到 Azure 		使用此模板可以部署启用了审核的 Azure SQL Server，以便将审核日志写入事件中心
Azure SQL Server，其中审核写入到 Log Analytics

部署到 Azure 		使用此模板，可以部署启用了审核的 Azure SQL Server，以便将审核日志写入 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

名字 描述 价值
类型 资源类型 “Microsoft.Insights/diagnosticSettings”
apiVersion 资源 API 版本 '2021-05-01-preview'
名字 资源名称 string （必需）
范围 在与部署范围不同的范围内创建扩展资源时使用。 目标资源

对于 JSON，请将该值设置为资源全名，以将 扩展资源 应用到该资源。
性能 诊断设置资源的属性。 DiagnosticSettings

DiagnosticSettings

名字 描述 价值
eventHubAuthorizationRuleId 事件中心授权规则的资源 ID。 字符串
eventHubName 事件中心的名称。 如果未指定任何事件，则会选择默认事件中心。 字符串
logAnalyticsDestinationType 一个字符串，指示导出到 Log Analytics 是否应使用默认目标类型，即 AzureDiagnostics，或使用构造的目标类型，如下所示：{normalized service identity}_{normalized category name}。 可能的值为：专用值和 null（默认值为 null）。 字符串
原木 日志设置的列表。 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

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

RetentionPolicy

名字 描述 价值
日 保留天数（以天为单位）。 值为 0 将无限期保留事件。 int （必需）

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

MetricSettings

名字 描述 价值
类别 此设置应用于的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表，请先执行 GET 诊断设置操作。 字符串
启用 一个值，该值指示是否启用此类别。 bool （必需）
retentionPolicy 此类别的保留策略。 RetentionPolicy
timeGrain ISO8601格式的指标的时间根。 字符串

快速入门模板

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

模板 描述
使用 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 群集。
创建 Azure Stack HCI 23H2 群集

部署到 Azure 		此模板使用 ARM 模板（使用自定义存储 IP）创建 Azure Stack HCI 23H2 群集
在无交换机-双链路网络模式下创建 Azure Stack HCI 23H2 群集

部署到 Azure 		此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
在 Switchless-SingleLink 网络模式下创建 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 		具有策略和诊断的 Azure 容器注册表 （bicep）
使用 Git 和托管 vnet 配置 Azure 数据工厂

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

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

部署到 Azure 		使用 VM Insights、Container Insights 解决方案和诊断部署 Log Analytics 工作区。
创建启用了日志记录的 Key Vault

部署到 Azure 		此模板创建用于日志记录的 Azure Key Vault 和 Azure 存储帐户。 它可以选择创建资源锁来保护 Key Vault 和存储资源。
使用应用程序网关入口控制器 AKS 群集

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

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

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

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

部署到 Azure 		此模板创建一个网络安全组，其中包含诊断日志和资源锁
使用诊断日志 虚拟网络

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

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

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

部署到 Azure 		使用此模板可以部署启用了审核的 Azure SQL Server，以便将审核日志写入事件中心
Azure SQL Server，其中审核写入到 Log Analytics

部署到 Azure 		使用此模板，可以部署启用了审核的 Azure SQL Server，以便将审核日志写入 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

名字 描述 价值
类型 资源类型 “Microsoft.Insights/diagnosticSettings@2021-05-01-preview”
名字 资源名称 string （必需）
parent_id 要向其应用此扩展资源的资源的 ID。 string （必需）
性能 诊断设置资源的属性。 DiagnosticSettings

DiagnosticSettings

名字 描述 价值
eventHubAuthorizationRuleId 事件中心授权规则的资源 ID。 字符串
eventHubName 事件中心的名称。 如果未指定任何事件，则会选择默认事件中心。 字符串
logAnalyticsDestinationType 一个字符串，指示导出到 Log Analytics 是否应使用默认目标类型，即 AzureDiagnostics，或使用构造的目标类型，如下所示：{normalized service identity}_{normalized category name}。 可能的值为：专用值和 null（默认值为 null）。 字符串
原木 日志设置的列表。 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

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

RetentionPolicy

名字 描述 价值
日 保留天数（以天为单位）。 值为 0 将无限期保留事件。 int （必需）

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

MetricSettings

名字 描述 价值
类别 此设置应用于的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表，请先执行 GET 诊断设置操作。 字符串
启用 一个值，该值指示是否启用此类别。 bool （必需）
retentionPolicy 此类别的保留策略。 RetentionPolicy
timeGrain ISO8601格式的指标的时间根。 字符串