Microsoft.Insights diagnosticSettings

發行項
10/19/2024

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

名字	描述	價值
名字	資源名稱	字串（必要）
範圍	在與部署範圍不同的範圍建立擴充資源時，請使用。	目標資源針對 Bicep，請將此屬性設定為資源的符號名稱，以套用擴充資源。
性能	診斷設定資源的屬性。	DiagnosticSettings

DiagnosticSettings

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

LogSettings

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

RetentionPolicy

名字	描述	價值
日	保留天數為天數。值為 0 會無限期地保留事件。	int （必要）約束：最小值 = 0
啟用	值，指出是否啟用保留原則。	布林（必要）

MetricSettings

名字	描述	價值
類別	套用此設定的資源類型診斷計量類別名稱。若要取得資源的診斷計量類別清單，請先執行 GET 診斷設定作業。	字串
啟用	值，指出是否啟用這個類別。	布林（必要）
retentionPolicy	此類別的保留原則。	RetentionPolicy
timeGrain	計量的時間根ISO8601格式。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
具有 NAT 閘道和應用程式閘道的 AKS 叢集	此範例示範如何使用 NAT 閘道部署 AKS 叢集以進行輸出連線，以及用於輸入連線的應用程式閘道。
使用公用 DNS 區域建立私人 AKS 叢集	此範例示範如何使用公用 DNS 區域部署私人 AKS 叢集。
使用應用程式閘道在內部 VNet 中建立 API 管理	此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。
建立和監視 API 管理實例	此範本會建立 Azure API 管理服務和 Log Analytics 工作區的實例，並使用 Log Analytics 設定 API 管理服務的監視
部署簡單的 Azure Spring Apps 微服務應用程式	此範本會部署簡單的 Azure Spring Apps 微服務應用程式，以在 Azure 上執行。
建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
建立 Azure Stack HCI 23H2 叢集	此範本會使用 ARM 範本建立 Azure Stack HCI 23H2 叢集，並使用自定義記憶體 IP
會在無交換器-雙鏈接網路模式中建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
會在 Switchless-SingleLink 網路模式中建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
使用範本建立 Redis 快取	此範本會建立 Azure Redis 快取，其中包含保留在記憶體帳戶中的診斷數據。
使用叢集建立進階 Redis 快取	此範本示範如何在進階 Azure Redis 快取實例中設定叢集。
使用數據持續性建立進階 Redis 快取	此範本示範如何在進階 Azure Redis 快取實例中設定持續性。
使用 WAF 和受Microsoft管理的規則集 Front Door Premium	此範本會建立 Front Door Premium，包括具有受Microsoft管理的預設和 Bot 保護規則集的 Web 應用程式防火牆。
使用 WAF 和自定義規則 Front Door Standard/Premium	此範本會建立 Front Door Standard/Premium，包括具有自定義規則的 Web 應用程式防火牆。
使用原則和診斷 Azure Container Registry	具有原則和診斷的 Azure Container Registry （bicep）
使用 Git 和受控 vnet 組態 Azure Data Factory	此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
使用解決方案和數據源 Log Analytics 工作區	使用指定的解決方案和數據源部署Log Analytics工作區
使用 VM Insights、Container Insights Log Analytics 工作區	使用 VM Insights、Container Insights 解決方案和診斷來部署 Log Analytics 工作區。
建立已啟用記錄功能的 Key Vault	此範本會建立用於記錄的 Azure Key Vault 和 Azure 記憶體帳戶。它選擇性地建立資源鎖定來保護您的 Key Vault 和記憶體資源。
使用應用程式閘道輸入控制器 AKS 叢集	此範例示範如何使用應用程式閘道、應用程式閘道輸入控制器、Azure Container Registry、Log Analytics 和 Key Vault 部署 AKS 叢集
使用 WAF 和防火牆原則應用程式閘道	此範本會建立已設定 WAF 以及防火牆原則的應用程式閘道
使用 Azure 防火牆作為中樞 & 輪輻拓撲中的 DNS Proxy	此範例示範如何使用 Azure 防火牆在 Azure 中部署中樞輪輻拓撲。中樞虛擬網路可作為透過虛擬網路對等互連連線到中樞虛擬網路之許多輪輻虛擬網路的中央點。
在 Azure API 管理前建立 Azure Front Door	此範例示範如何在 Azure API 管理前使用 Azure Front Door 作為全域負載平衡器。
使用診斷記錄網路安全組	此範本會建立具有診斷記錄和資源鎖定的網路安全組
使用診斷記錄虛擬網路	此範本會建立具有診斷記錄的虛擬網路，並允許將選擇性功能新增至每個子網
建立復原服務保存庫並啟用診斷	此範本會建立復原服務保存庫，並啟用 Azure 備份的診斷。這也會部署記憶體帳戶和 oms 工作區。
使用備份原則建立復原服務保存庫	此範本會建立具有備份原則的復原服務保存庫，並設定選擇性功能，例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄，以及刪除鎖定。
使用寫入事件中樞的稽核 Azure SQL Server	此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
使用寫入 Log Analytics 稽核的 Azure SQL Server	此樣本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics （OMS 工作區）
建立已設定傳送記錄和計量的 SQL MI	此範本可讓您部署用於儲存記錄和計量的 SQL MI 和其他資源（診斷工作區、記憶體帳戶、事件中樞）。
使用內部 API 管理和 Web 應用程式應用程式閘道	應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）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'
名字	資源名稱	字串（必要）
範圍	在與部署範圍不同的範圍建立擴充資源時，請使用。	目標資源針對 JSON，請將值設定為要套用擴充功能資源的資源完整名稱。
性能	診斷設定資源的屬性。	DiagnosticSettings

DiagnosticSettings

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

LogSettings

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

RetentionPolicy

名字	描述	價值
日	保留天數為天數。值為 0 會無限期地保留事件。	int （必要）約束：最小值 = 0
啟用	值，指出是否啟用保留原則。	布林（必要）

MetricSettings

名字	描述	價值
類別	套用此設定的資源類型診斷計量類別名稱。若要取得資源的診斷計量類別清單，請先執行 GET 診斷設定作業。	字串
啟用	值，指出是否啟用這個類別。	布林（必要）
retentionPolicy	此類別的保留原則。	RetentionPolicy
timeGrain	計量的時間根ISO8601格式。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
具有 NAT 閘道和應用程式閘道的 AKS 叢集	此範例示範如何使用 NAT 閘道部署 AKS 叢集以進行輸出連線，以及用於輸入連線的應用程式閘道。
使用公用 DNS 區域建立私人 AKS 叢集	此範例示範如何使用公用 DNS 區域部署私人 AKS 叢集。
使用應用程式閘道在內部 VNet 中建立 API 管理	此範本示範如何在受 Azure 應用程式閘道保護的專用網上建立 Azure API 管理的實例。
建立和監視 API 管理實例	此範本會建立 Azure API 管理服務和 Log Analytics 工作區的實例，並使用 Log Analytics 設定 API 管理服務的監視
部署簡單的 Azure Spring Apps 微服務應用程式	此範本會部署簡單的 Azure Spring Apps 微服務應用程式，以在 Azure 上執行。
建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
建立 Azure Stack HCI 23H2 叢集	此範本會使用 ARM 範本建立 Azure Stack HCI 23H2 叢集，並使用自定義記憶體 IP
會在無交換器-雙鏈接網路模式中建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
會在 Switchless-SingleLink 網路模式中建立 Azure Stack HCI 23H2 叢集	此範本會使用ARM樣本建立 Azure Stack HCI 23H2 叢集。
使用範本建立 Redis 快取	此範本會建立 Azure Redis 快取，其中包含保留在記憶體帳戶中的診斷數據。
使用叢集建立進階 Redis 快取	此範本示範如何在進階 Azure Redis 快取實例中設定叢集。
使用數據持續性建立進階 Redis 快取	此範本示範如何在進階 Azure Redis 快取實例中設定持續性。
使用 WAF 和受Microsoft管理的規則集 Front Door Premium	此範本會建立 Front Door Premium，包括具有受Microsoft管理的預設和 Bot 保護規則集的 Web 應用程式防火牆。
使用 WAF 和自定義規則 Front Door Standard/Premium	此範本會建立 Front Door Standard/Premium，包括具有自定義規則的 Web 應用程式防火牆。
使用原則和診斷 Azure Container Registry	具有原則和診斷的 Azure Container Registry （bicep）
使用 Git 和受控 vnet 組態 Azure Data Factory	此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
使用解決方案和數據源 Log Analytics 工作區	使用指定的解決方案和數據源部署Log Analytics工作區
使用 VM Insights、Container Insights Log Analytics 工作區	使用 VM Insights、Container Insights 解決方案和診斷來部署 Log Analytics 工作區。
建立已啟用記錄功能的 Key Vault	此範本會建立用於記錄的 Azure Key Vault 和 Azure 記憶體帳戶。它選擇性地建立資源鎖定來保護您的 Key Vault 和記憶體資源。
使用應用程式閘道輸入控制器 AKS 叢集	此範例示範如何使用應用程式閘道、應用程式閘道輸入控制器、Azure Container Registry、Log Analytics 和 Key Vault 部署 AKS 叢集
使用 WAF 和防火牆原則應用程式閘道	此範本會建立已設定 WAF 以及防火牆原則的應用程式閘道
使用 Azure 防火牆作為中樞 & 輪輻拓撲中的 DNS Proxy	此範例示範如何使用 Azure 防火牆在 Azure 中部署中樞輪輻拓撲。中樞虛擬網路可作為透過虛擬網路對等互連連線到中樞虛擬網路之許多輪輻虛擬網路的中央點。
在 Azure API 管理前建立 Azure Front Door	此範例示範如何在 Azure API 管理前使用 Azure Front Door 作為全域負載平衡器。
使用診斷記錄網路安全組	此範本會建立具有診斷記錄和資源鎖定的網路安全組
使用診斷記錄虛擬網路	此範本會建立具有診斷記錄的虛擬網路，並允許將選擇性功能新增至每個子網
建立復原服務保存庫並啟用診斷	此範本會建立復原服務保存庫，並啟用 Azure 備份的診斷。這也會部署記憶體帳戶和 oms 工作區。
使用備份原則建立復原服務保存庫	此範本會建立具有備份原則的復原服務保存庫，並設定選擇性功能，例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄，以及刪除鎖定。
使用寫入事件中樞的稽核 Azure SQL Server	此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
使用寫入 Log Analytics 稽核的 Azure SQL Server	此樣本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 Log Analytics （OMS 工作區）
建立已設定傳送記錄和計量的 SQL MI	此範本可讓您部署用於儲存記錄和計量的 SQL MI 和其他資源（診斷工作區、記憶體帳戶、事件中樞）。
使用內部 API 管理和 Web 應用程式應用程式閘道	應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）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”
名字	資源名稱	字串（必要）
parent_id	要套用此延伸模組資源之資源的標識碼。	字串（必要）
性能	診斷設定資源的屬性。	DiagnosticSettings

DiagnosticSettings

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

LogSettings

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

RetentionPolicy

名字	描述	價值
日	保留天數為天數。值為 0 會無限期地保留事件。	int （必要）約束：最小值 = 0
啟用	值，指出是否啟用保留原則。	布林（必要）

MetricSettings

名字	描述	價值
類別	套用此設定的資源類型診斷計量類別名稱。若要取得資源的診斷計量類別清單，請先執行 GET 診斷設定作業。	字串
啟用	值，指出是否啟用這個類別。	布林（必要）
retentionPolicy	此類別的保留原則。	RetentionPolicy
timeGrain	計量的時間根ISO8601格式。	字串

共用方式為

Microsoft.Insights diagnosticSettings

Bicep 資源定義

言論

資源格式

屬性值

diagnosticSettings

DiagnosticSettings

LogSettings

RetentionPolicy

MetricSettings

快速入門範本

ARM 樣本資源定義

言論

資源格式

屬性值

diagnosticSettings

DiagnosticSettings

LogSettings

RetentionPolicy

MetricSettings

快速入門範本

Terraform （AzAPI 提供者）資源定義

資源格式

屬性值

diagnosticSettings

DiagnosticSettings

LogSettings

RetentionPolicy

MetricSettings

意見反應

其他資源

共用方式為

Microsoft.Insights diagnosticSettings

Bicep 資源定義

言論

資源格式

屬性值

diagnosticSettings

DiagnosticSettings

LogSettings

RetentionPolicy

MetricSettings

快速入門範本

ARM 樣本資源定義

言論

資源格式

屬性值

diagnosticSettings

DiagnosticSettings

LogSettings

RetentionPolicy

MetricSettings

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

diagnosticSettings

DiagnosticSettings

LogSettings

RetentionPolicy

MetricSettings

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義