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 資源名稱 需要字串 ()
範圍 在與部署範圍不同的範圍內建立擴充資源時，請使用 。 目標資源

針對 Bicep，請將此屬性設定為資源的符號名稱，以套用 延伸模組資源。
properties 診斷設定資源的屬性。 DiagnosticSettings

DiagnosticSettings

名稱 描述 值
eventHubAuthorizationRuleId 事件中樞授權規則的資源標識碼。 字串
eventHubName 事件中樞的名稱。 如果未指定任何專案，則會選取預設事件中樞。 字串
logAnalyticsDestinationType 字串，指出導出至Log Analytics是否應該使用預設目的地類型，亦即 AzureDiagnostics，或使用建構如下的目的地類型：{標準化服務識別}_{正規化類別名稱}。 可能的值為：Dedicated 和 null (null 是 default。) 字串
記錄 記錄設定的清單。 LogSettings[]
marketplacePartnerId 您要傳送診斷記錄之 Marketplace 資源的完整 ARM 資源識別碼。 字串
metrics 計量設定的清單。 MetricSettings[]
serviceBusRuleId 診斷設定的服務總線規則標識碼。 這是為了維持回溯相容性。 字串
storageAccountId 您要傳送診斷記錄的記憶體帳戶資源識別碼。 字串
workspaceId 要傳送診斷記錄之Log Analytics工作區的完整ARM資源識別碼。 範例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 字串

LogSettings

名稱 描述 值
category 套用此設定的資源類型診斷記錄類別名稱。 若要取得資源之診斷記錄類別的清單，請先執行 GET 診斷設定作業。 字串
categoryGroup 套用此設定的資源類型診斷記錄類別群組名稱。 若要取得資源之診斷記錄類別的清單，請先執行 GET 診斷設定作業。 字串
已啟用 值，指出是否啟用此記錄檔。 bool (必要)
retentionPolicy 此記錄檔的保留原則。 RetentionPolicy

RetentionPolicy

名稱 描述 值
days 保留天數的天數。 值為 0 會無限期地保留事件。 需要 int ()

約束：
最小值 = 0
已啟用 值，指出是否啟用保留原則。 bool (必要)

MetricSettings

名稱 描述 值
category 套用此設定的資源類型診斷計量類別名稱。 若要取得資源的診斷計量類別清單，請先執行 GET 診斷設定作業。 字串
已啟用 值，指出是否啟用此類別。 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 快取，其中包含保留在記憶體帳戶中的診斷數據。
建立具有叢集的 Premium Redis 快取

部署至 Azure		 此範本示範如何在進階 Azure Redis 快取實例中設定叢集。
建立具有資料永續性的 Premium Redis 快取

部署至 Azure		 此範本示範如何在進階 Azure Redis 快取實例中設定持續性。
具有 WAF 和 Microsoft 管理規則集的 Front Door Premium

部署至 Azure		 此範本會建立 Front Door Premium，包括具有 Microsoft 管理的預設和 Bot 保護規則集的 Web 應用程式防火牆。
具有 WAF 和自定義規則的 Front Door Standard/Premium

部署至 Azure		 此範本會建立 Front Door Standard/Premium，包括具有自定義規則的 Web 應用程式防火牆。
使用原則和診斷 Azure Container Registry

部署至 Azure		 Azure Container Registry 原則和診斷 (bicep)
使用 Git 和受控 vnet 設定 Azure Data Factory

部署至 Azure		 此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
具有解決方案和數據源的Log Analytics工作區

部署至 Azure		 使用指定的解決方案和數據源部署Log Analytics工作區
使用 VM Insights、Container Insights 的 Log Analytics 工作區

部署至 Azure		 使用 VM Insights、Container Insights 解決方案和診斷部署 Log Analytics 工作區。
建立已啟用記錄的 金鑰保存庫

部署至 Azure		 此範本會建立用於記錄的 Azure 金鑰保存庫 和 Azure 記憶體帳戶。 它會選擇性地建立資源鎖定來保護 金鑰保存庫 和記憶體資源。
具有 應用程式閘道 輸入控制器的 AKS 叢集

部署至 Azure		 此範例示範如何使用 應用程式閘道、應用程式閘道 輸入控制器、Azure Container Registry、Log Analytics 和 金鑰保存庫 部署 AKS 叢集
使用 WAF 和防火牆原則 應用程式閘道

部署至 Azure		 此範本會建立 應用程式閘道，並設定WAF以及防火牆原則
使用 Azure 防火牆 作為中樞 & 輪輻拓撲中的 DNS Proxy

部署至 Azure		 此範例示範如何使用 Azure 防火牆 在 Azure 中部署中樞輪輻拓撲。 中樞虛擬網路可作為透過虛擬網路對等互連連線到中樞虛擬網路之許多輪輻虛擬網路的連線中心點。
在 Azure API 管理 前面建立 Azure Front Door

部署至 Azure		 此範例示範如何使用 Azure Front Door 作為 Azure API 管理 前面的全域負載平衡器。
具有診斷記錄的網路安全組

部署至 Azure		 此範本會建立具有診斷記錄和資源鎖定的網路安全組
Azure Virtual WAN 路由意圖和原則

部署至 Azure		 此範本會布建 Azure Virtual WAN，並啟用路由意圖和原則功能的兩個中樞。
具有診斷記錄的虛擬網路

部署至 Azure		 此範本會使用診斷記錄建立 虛擬網路，並允許將選擇性功能新增至每個子網
建立復原服務保存庫並啟用診斷

部署至 Azure		 此範本會建立復原服務保存庫，並啟用 Azure 備份 的診斷。 這也會部署記憶體帳戶和 oms 工作區。
使用備份原則建立復原服務保存庫

部署至 Azure		 此範本會建立具有備份原則的復原服務保存庫，並設定選擇性功能，例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄，以及刪除鎖定。
Azure SQL 寫入事件中樞的稽核伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
Azure SQL 寫入 Log Analytics 稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics (OMS 工作區)
使用已設定的記錄和計量傳送來建立 SQL MI

部署至 Azure		 此範本可讓您部署用來儲存記錄和計量的 SQL MI 和其他資源， (診斷工作區、記憶體帳戶、事件中樞) 。
使用內部 API 管理 和 Web 應用程式進行 應用程式閘道

部署至 Azure		 應用程式閘道 將因特網流量路由傳送至虛擬網路 (內部模式) 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'
NAME 資源名稱 字串 (必要)
範圍 在與部署範圍不同的範圍建立擴充資源時，請使用 。 目標資源

針對 JSON，請將值設定為要套用 擴充資源 的資源完整名稱。
properties 診斷設定資源的屬性。 DiagnosticSettings

DiagnosticSettings

名稱 描述 值
eventHubAuthorizationRuleId 事件中樞授權規則的資源標識碼。 字串
eventHubName 事件中樞的名稱。 如果未指定任何專案，則會選取預設事件中樞。 字串
logAnalyticsDestinationType 字串，指出導出至Log Analytics是否應該使用預設目的地類型，也就是 AzureDiagnostics，或使用建構的目的地類型，如下所示：{標準化服務識別}_{正規化類別名稱}。 可能的值為：Dedicated 和 null (null 為 default.) 字串
記錄 記錄設定的清單。 LogSettings[]
marketplacePartnerId 您要傳送診斷記錄之 Marketplace 資源的完整 ARM 資源識別碼。 字串
metrics 計量設定的清單。 MetricSettings[]
serviceBusRuleId 診斷設定的服務總線規則標識碼。 這是為了維持回溯相容性。 字串
storageAccountId 您想要傳送診斷記錄之記憶體帳戶的資源識別碼。 字串
workspaceId 您想要傳送診斷記錄之 Log Analytics 工作區的完整 ARM 資源識別碼。 範例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 字串

LogSettings

名稱 描述 值
category 套用此設定的資源類型診斷記錄類別名稱。 若要取得資源之診斷記錄類別的清單，請先執行 GET 診斷設定作業。 字串
categoryGroup 套用此設定的資源類型診斷記錄類別群組名稱。 若要取得資源之診斷記錄類別的清單，請先執行 GET 診斷設定作業。 字串
已啟用 值，指出是否啟用此記錄檔。 bool (必要)
retentionPolicy 此記錄的保留原則。 RetentionPolicy

RetentionPolicy

名稱 描述 值
days 保留天數。 值為 0 會無限期地保留事件。 int (必要)

約束：
最小值 = 0
已啟用 值，指出是否啟用保留原則。 bool (必要)

MetricSettings

名稱 描述 值
category 套用此設定的資源類型診斷計量類別名稱。 若要取得資源的診斷計量類別清單，請先執行 GET 診斷設定作業。 字串
已啟用 值，指出是否啟用此類別。 bool (必要)
retentionPolicy 此類別的保留原則。 RetentionPolicy
timeGrain 計量的 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 叢集。
使用範本建立 Redis 快取

部署至 Azure		 此範本會建立 Azure Redis 快取，其中包含在記憶體帳戶中保留的診斷數據。
建立具有叢集的 Premium Redis 快取

部署至 Azure		 此範本示範如何在進階 Azure Redis 快取實例中設定叢集。
建立具有資料永續性的 Premium Redis 快取

部署至 Azure		 此範本示範如何在進階 Azure Redis 快取實例中設定持續性。
具有 WAF 和 Microsoft 管理規則集的 Front Door Premium

部署至 Azure		 此範本會建立 Front Door Premium，包括具有 Microsoft 管理的預設和 Bot 保護規則集的 Web 應用程式防火牆。
具有 WAF 和自定義規則的 Front Door Standard/Premium

部署至 Azure		 此範本會建立 Front Door Standard/Premium，包括具有自定義規則的 Web 應用程式防火牆。
使用原則和診斷 Azure Container Registry

部署至 Azure		 Azure Container Registry 原則和診斷 (bicep)
使用 Git 和受控 vnet 設定 Azure Data Factory

部署至 Azure		 此範本會使用 Git 組態和受控虛擬網路建立 Azure Data Factory。
具有解決方案和數據源的Log Analytics工作區

部署至 Azure		 使用指定的解決方案和數據源部署Log Analytics工作區
具有 VM Insights、Container Insights 的 Log Analytics 工作區

部署至 Azure		 使用 VM Insights、Container Insights 解決方案和診斷部署 Log Analytics 工作區。
建立已啟用記錄的 金鑰保存庫

部署至 Azure		 此範本會建立用於記錄的 Azure 金鑰保存庫 和 Azure 記憶體帳戶。 它會選擇性地建立資源鎖定，以保護您的 金鑰保存庫 和記憶體資源。
具有 應用程式閘道 輸入控制器的 AKS 叢集

部署至 Azure		 此範例示範如何使用 應用程式閘道、應用程式閘道 輸入控制器、Azure Container Registry、Log Analytics 和 金鑰保存庫 部署 AKS 叢集
使用 WAF 和防火牆原則 應用程式閘道

部署至 Azure		 此範本會建立 應用程式閘道，並設定WAF以及防火牆原則
使用 Azure 防火牆 作為中樞 & 輪輻拓撲中的 DNS Proxy

部署至 Azure		 此範例示範如何使用 Azure 防火牆 在 Azure 中部署中樞輪輻拓撲。 中樞虛擬網路可作為透過虛擬網路對等互連連線到中樞虛擬網路的許多輪輻虛擬網路的中央點。
在 Azure API 管理 前面建立 Azure Front Door

部署至 Azure		 此範例示範如何使用 Azure Front Door 作為 Azure API 管理 前面的全域負載平衡器。
具有診斷記錄的網路安全組

部署至 Azure		 此範本會建立具有診斷記錄和資源鎖定的網路安全組
Azure Virtual WAN 路由意圖和原則

部署至 Azure		 此範本會布建具有兩個已啟用路由意圖和原則功能的中樞的 Azure Virtual WAN。
具有診斷記錄的虛擬網路

部署至 Azure		 此範本會建立具有診斷記錄的 虛擬網路，並允許將選擇性功能新增至每個子網
建立復原服務保存庫並啟用診斷

部署至 Azure		 此範本會建立復原服務保存庫，並啟用 Azure 備份 的診斷。 這也會部署記憶體帳戶和 oms 工作區。
使用備份原則建立復原服務保存庫

部署至 Azure		 此範本會建立具有備份原則的復原服務保存庫，並設定選擇性功能，例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄，以及刪除鎖定。
Azure SQL 寫入事件中樞的稽核伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
Azure SQL 寫入 Log Analytics 稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics (OMS 工作區)
使用已設定的記錄和計量傳送來建立 SQL MI

部署至 Azure		 此範本可讓您部署用來儲存記錄和計量的 SQL MI 和其他資源， (診斷工作區、記憶體帳戶、事件中樞) 。
使用內部 API 管理 和 Web 應用程式進行 應用程式閘道

部署至 Azure		 應用程式閘道 將因特網流量路由傳送至虛擬網路， (內部模式) 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”
NAME 資源名稱 字串 (必要)
parent_id 要套用此延伸模組資源的資源標識碼。 字串 (必要)
properties 診斷設定資源的屬性。 DiagnosticSettings

DiagnosticSettings

名稱 描述 值
eventHubAuthorizationRuleId 事件中樞授權規則的資源標識碼。 字串
eventHubName 事件中樞的名稱。 如果未指定任何專案，則會選取預設事件中樞。 字串
logAnalyticsDestinationType 字串，指出導出至Log Analytics是否應該使用預設目的地類型，也就是 AzureDiagnostics，或使用建構的目的地類型，如下所示：{標準化服務識別}_{正規化類別名稱}。 可能的值為：Dedicated 和 null (null 為 default.) 字串
記錄 記錄設定的清單。 LogSettings[]
marketplacePartnerId 您要傳送診斷記錄之 Marketplace 資源的完整 ARM 資源識別碼。 字串
metrics 計量設定的清單。 MetricSettings[]
serviceBusRuleId 診斷設定的服務總線規則標識碼。 這是為了維持回溯相容性。 字串
storageAccountId 您想要傳送診斷記錄之記憶體帳戶的資源識別碼。 字串
workspaceId 您想要傳送診斷記錄之 Log Analytics 工作區的完整 ARM 資源識別碼。 範例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 字串

LogSettings

名稱 描述 值
category 套用此設定的資源類型診斷記錄類別名稱。 若要取得資源之診斷記錄類別的清單，請先執行 GET 診斷設定作業。 字串
categoryGroup 套用此設定的資源類型診斷記錄類別群組名稱。 若要取得資源之診斷記錄類別的清單，請先執行 GET 診斷設定作業。 字串
已啟用 值，指出是否啟用此記錄檔。 bool (必要)
retentionPolicy 此記錄的保留原則。 RetentionPolicy

RetentionPolicy

名稱 描述 值
days 保留天數。 值為 0 會無限期地保留事件。 int (必要)

約束：
最小值 = 0
已啟用 值，指出是否啟用保留原則。 bool (必要)

MetricSettings

名稱 描述 值
category 套用此設定的資源類型診斷計量類別名稱。 若要取得資源的診斷計量類別清單，請先執行 GET 診斷設定作業。 字串
已啟用 值，指出是否啟用此類別。 bool (必要)
retentionPolicy 此類別的保留原則。 RetentionPolicy
timeGrain 計量的 timegrain 格式為 ISO8601。 字串