Microsoft.Insights diagnosticSettings

Bicep 资源定义

可以使用目标操作部署 diagnosticSettings 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.Insights/diagnosticSettings@2021-05-01-preview' = {
  scope: resourceSymbolicName or scope
  name: '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'
  }
}

属性值

Microsoft.Insights/diagnosticSettings

DiagnosticSettings

日志设置

MetricSettings

RetentionPolicy （保留策略）

用法示例

Azure 验证模块

以下 Azure 验证模块 可用于部署此资源类型。

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

ARM 模板资源定义

可以使用目标操作部署 diagnosticSettings 资源类型：

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

资源格式

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

{
  "type": "Microsoft.Insights/diagnosticSettings",
  "apiVersion": "2021-05-01-preview",
  "name": "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"
  }
}

属性值

Microsoft.Insights/diagnosticSettings

DiagnosticSettings

日志设置

MetricSettings

RetentionPolicy （保留策略）

用法示例

Azure 快速入门模板

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

模板	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
使用应用程序网关入口控制器 AKS 群集	此示例演示如何使用应用程序网关、应用程序网关入口控制器、Azure 容器注册表、Log Analytics 和 Key Vault 部署 AKS 群集
使用内部 API 管理和 Web 应用 应用程序网关	应用程序网关将 Internet 流量路由到虚拟网络（内部模式）API 管理实例，该实例服务 Azure Web 应用中托管的 Web API。
使用 WAF 和防火墙策略 应用程序网关	此模板创建配置了 WAF 的应用程序网关以及防火墙策略
使用策略和诊断 Azure 容器注册表	具有策略和诊断的 Azure 容器注册表 （bicep）
使用 Git 和托管 vnet 配置 Azure 数据工厂	此模板使用 Git 配置和托管虚拟网络创建 Azure 数据工厂。
Azure 游戏开发人员虚拟机	Azure 游戏开发人员虚拟机包括 Unreal 等授权引擎。
Azure SQL Server，其中审核写入到 Log Analytics	使用此模板，可以部署启用了审核的 Azure SQL Server，以便将审核日志写入 Log Analytics （OMS 工作区）
创建具有群集 的高级 Redis 缓存	此模板演示如何在高级 Azure Redis 缓存实例中配置群集。
使用模板创建 Redis 缓存	此模板创建一个 Azure Redis 缓存，其中包含保存在存储帐户中的诊断数据。
使用应用网关在内部 VNet 中创建 API 管理	此模板演示如何在受 Azure 应用程序网关保护的专用网络上创建 Azure API 管理的实例。
创建启用了日志记录的 Key Vault	此模板创建用于日志记录的 Azure Key Vault 和 Azure 存储帐户。 它可以选择创建资源锁来保护 Key Vault 和存储资源。
创建具有数据持久性的高级 Redis 缓存	此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
创建恢复服务保管库并启用诊断	此模板创建恢复服务保管库，并为 Azure 备份启用诊断。 这还会部署存储帐户和 oms 工作区。
使用备份策略创建恢复服务保管库	此模板创建包含备份策略的恢复服务保管库，并配置系统标识、备份存储类型、跨区域还原和诊断日志和删除锁等可选功能。
创建配置了日志和指标发送的 SQL MI	使用此模板可以部署用于存储日志和指标的 SQL MI 和其他资源（诊断工作区、存储帐户、事件中心）。
部署简单的 Azure Spring Apps 微服务应用程序	此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。
使用托管虚拟网络部署 Secure AI Foundry	此模板创建具有强大网络和标识安全限制的安全 Azure AI Foundry 环境。
使用 WAF 和Microsoft托管的规则集 Front Door Premium	此模板创建一个 Front Door Premium，其中包括具有Microsoft托管的默认和机器人保护规则集的 Web 应用程序防火墙。
使用 WAF 和自定义规则 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版，包括具有自定义规则的 Web 应用程序防火墙。
使用 WAF、域和日志将 FrontDoor CDN EventHub	此模板创建新的 Azure FrontDoor cdn 配置文件。 使用自定义和托管规则、cdn 路由、源和组与 WAF 和路由关联创建 WAF，配置自定义域，创建事件中心和诊断设置，以便使用事件中心发送 CDN 访问日志。
使用解决方案和数据源 Log Analytics 工作区	部署具有指定解决方案和数据源的 Log Analytics 工作区
使用 VM Insights、Container Insights Log Analytics 工作区	使用 VM Insights、Container Insights 解决方案和诊断部署 Log Analytics 工作区。
使用诊断日志 网络安全组	此模板创建一个网络安全组，其中包含诊断日志和资源锁
使用 Azure 防火墙作为中心 & 辐射型拓扑中的 DNS 代理	此示例演示如何使用 Azure 防火墙在 Azure 中部署中心辐射型拓扑。 中心虚拟网络充当通过虚拟网络对等互连连接到中心虚拟网络的许多辐射虚拟网络的中心点。
使用诊断日志 虚拟网络	此模板创建包含诊断日志的虚拟网络，并允许将可选功能添加到每个子网

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 diagnosticSettings 资源类型：

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/diagnosticSettings@2021-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
    }
  }
}

属性值

Microsoft.Insights/diagnosticSettings

DiagnosticSettings

日志设置

MetricSettings

RetentionPolicy （保留策略）

用法示例

Terraform 示例

部署 Insights 诊断设置的基本示例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "vault" {
  type      = "Microsoft.KeyVault/vaults@2021-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      accessPolicies = [
      ]
      createMode                   = "default"
      enableRbacAuthorization      = false
      enableSoftDelete             = true
      enabledForDeployment         = false
      enabledForDiskEncryption     = false
      enabledForTemplateDeployment = false
      publicNetworkAccess          = "Enabled"
      sku = {
        family = "A"
        name   = "standard"
      }
      tenantId = data.azurerm_client_config.current.tenant_id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.EventHub/namespaces@2022-01-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      disableLocalAuth     = false
      isAutoInflateEnabled = false
      publicNetworkAccess  = "Enabled"
      zoneRedundant        = false
    }
    sku = {
      capacity = 1
      name     = "Basic"
      tier     = "Basic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "authorizationRule" {
  type      = "Microsoft.EventHub/namespaces/authorizationRules@2021-11-01"
  parent_id = azapi_resource.namespace.id
  name      = "example"
  body = {
    properties = {
      rights = [
        "Listen",
        "Send",
        "Manage",
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "diagnosticSetting" {
  type      = "Microsoft.Insights/diagnosticSettings@2021-05-01-preview"
  parent_id = azapi_resource.vault.id
  name      = var.resource_name
  body = {
    properties = {
      eventHubAuthorizationRuleId = azapi_resource.authorizationRule.id
      eventHubName                = azapi_resource.namespace.name
      logs = [
        {
          categoryGroup = "Audit"
          enabled       = true
          retentionPolicy = {
            days    = 0
            enabled = false
          }
        },
      ]
      metrics = [
        {
          category = "AllMetrics"
          enabled  = true
          retentionPolicy = {
            days    = 0
            enabled = false
          }
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}