Microsoft.Insights diagnosticSettings

發行項
12/21/2024

言論

如需部署監視解決方案的指引，請參閱使用 Bicep建立監視資源。

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'
  }
}

屬性值

DiagnosticSettings

名字	描述	價值
eventHubAuthorizationRuleId	事件中樞授權規則的資源標識碼。	字串
eventHubName	事件中樞的名稱。如果未指定任何專案，則會選取預設事件中樞。	字串
logAnalyticsDestinationType	字串，指出導出至Log Analytics是否應該使用預設目的地類型，也就是 AzureDiagnostics，或使用建構如下的目的地類型：<標準化服務識別>_<正規化類別名稱>。可能的值為：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

MetricSettings

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

Microsoft.Insights/diagnosticSettings

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

RetentionPolicy

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

快速入門範例

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

Bicep 檔案	描述
具有 NAT 閘道和應用程式閘道的 AKS 叢集	此範例示範如何使用 NAT 閘道部署 AKS 叢集以進行輸出連線，以及用於輸入連線的應用程式閘道。
使用應用程式閘道輸入控制器 AKS 叢集	此範例示範如何使用應用程式閘道、應用程式閘道輸入控制器、Azure Container Registry、Log Analytics 和 Key Vault 部署 AKS 叢集
使用內部 API 管理和 Web 應用程式應用程式閘道	應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）API 管理實例，此實例會服務裝載於 Azure Web 應用程式中的 Web API。
使用 WAF 和防火牆原則應用程式閘道	此範本會建立已設定 WAF 以及防火牆原則的應用程式閘道
使用原則和診斷 Azure Container Registry	具有原則和診斷的 Azure Container Registry （bicep）
使用 Git 和受控 vnet 組態 Azure Data Factory	此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
Azure Game 開發人員虛擬機	Azure 遊戲開發人員虛擬機包含 Unreal 等授權引擎。
使用寫入 Log Analytics 稽核的 Azure SQL Server	此樣本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 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 工作區。
使用備份原則建立復原服務保存庫	此範本會建立具有備份原則的復原服務保存庫，並設定選擇性功能，例如系統身分識別、備份記憶體類型、跨區域還原和診斷記錄，以及刪除鎖定。
部署簡單的 Azure Spring Apps 微服務應用程式	此範本會部署簡單的 Azure Spring Apps 微服務應用程式，以在 Azure 上執行。
使用受控虛擬網路部署安全的 Azure AI Studio	此範本會建立安全的 Azure AI Studio 環境，並具有健全的網路和身分識別安全性限制。
使用 WAF 和受Microsoft管理的規則集 Front Door Premium	此範本會建立 Front Door Premium，包括具有受Microsoft管理的預設和 Bot 保護規則集的 Web 應用程式防火牆。
使用 WAF 和自定義規則 Front Door Standard/Premium	此範本會建立 Front Door Standard/Premium，包括具有自定義規則的 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 Proxy	此範例示範如何使用 Azure 防火牆在 Azure 中部署中樞輪輻拓撲。中樞虛擬網路可作為透過虛擬網路對等互連連線到中樞虛擬網路之許多輪輻虛擬網路的中央點。
使用診斷記錄虛擬網路	此範本會建立具有診斷記錄的虛擬網路，並允許將選擇性功能新增至每個子網

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"
  }
}

屬性值

DiagnosticSettings

名字	描述	價值
eventHubAuthorizationRuleId	事件中樞授權規則的資源標識碼。	字串
eventHubName	事件中樞的名稱。如果未指定任何專案，則會選取預設事件中樞。	字串
logAnalyticsDestinationType	字串，指出導出至Log Analytics是否應該使用預設目的地類型，也就是 AzureDiagnostics，或使用建構如下的目的地類型：<標準化服務識別>_<正規化類別名稱>。可能的值為：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

MetricSettings

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

Microsoft.Insights/diagnosticSettings

名字	描述	價值
apiVersion	API 版本	'2021-05-01-preview'
名字	資源名稱	字串（必要）
性能	診斷設定資源的屬性。	DiagnosticSettings
類型	資源類型	'Microsoft.Insights/diagnosticSettings'

RetentionPolicy

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

快速入門範本

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

範本	描述
具有 NAT 閘道和應用程式閘道的 AKS 叢集	此範例示範如何使用 NAT 閘道部署 AKS 叢集以進行輸出連線，以及用於輸入連線的應用程式閘道。
使用應用程式閘道輸入控制器 AKS 叢集	此範例示範如何使用應用程式閘道、應用程式閘道輸入控制器、Azure Container Registry、Log Analytics 和 Key Vault 部署 AKS 叢集
使用內部 API 管理和 Web 應用程式應用程式閘道	應用程式閘道會將因特網流量路由傳送至虛擬網路（內部模式）API 管理實例，此實例會服務裝載於 Azure Web 應用程式中的 Web API。
使用 WAF 和防火牆原則應用程式閘道	此範本會建立已設定 WAF 以及防火牆原則的應用程式閘道
使用原則和診斷 Azure Container Registry	具有原則和診斷的 Azure Container Registry （bicep）
使用 Git 和受控 vnet 組態 Azure Data Factory	此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
Azure Game 開發人員虛擬機	Azure 遊戲開發人員虛擬機包含 Unreal 等授權引擎。
使用寫入 Log Analytics 稽核的 Azure SQL Server	此樣本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入 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 上執行。
使用受控虛擬網路部署安全的 Azure AI Studio	此範本會建立安全的 Azure AI Studio 環境，並具有健全的網路和身分識別安全性限制。
使用 WAF 和受Microsoft管理的規則集 Front Door Premium	此範本會建立 Front Door Premium，包括具有受Microsoft管理的預設和 Bot 保護規則集的 Web 應用程式防火牆。
使用 WAF 和自定義規則 Front Door Standard/Premium	此範本會建立 Front Door Standard/Premium，包括具有自定義規則的 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 Proxy	此範例示範如何使用 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 = 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

名字	描述	價值
eventHubAuthorizationRuleId	事件中樞授權規則的資源標識碼。	字串
eventHubName	事件中樞的名稱。如果未指定任何專案，則會選取預設事件中樞。	字串
logAnalyticsDestinationType	字串，指出導出至Log Analytics是否應該使用預設目的地類型，也就是 AzureDiagnostics，或使用建構如下的目的地類型：<標準化服務識別>_<正規化類別名稱>。可能的值為：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

MetricSettings

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

Microsoft.Insights/diagnosticSettings

名字	描述	價值
名字	資源名稱	字串（必要）
parent_id	要套用此延伸模組資源之資源的標識碼。	字串（必要）
性能	診斷設定資源的屬性。	DiagnosticSettings
類型	資源類型	“Microsoft.Insights/diagnosticSettings@2021-05-01-preview”

RetentionPolicy

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

共用方式為

Microsoft.Insights diagnosticSettings

言論

Bicep 資源定義

資源格式

屬性值

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

快速入門範本

Terraform （AzAPI 提供者）資源定義

資源格式

屬性值

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

意見反應

其他資源

共用方式為

Microsoft.Insights diagnosticSettings

言論

Bicep 資源定義

資源格式

屬性值

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義