Microsoft。Synapse workspaces/sqlPools/auditingSettings

Bicep 資源定義

workspaces/sqlPools/auditingSettings 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Synapse/workspaces/sqlPools/auditingSettings 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    auditActionsAndGroups: [
      'string'
    ]
    isAzureMonitorTargetEnabled: bool
    isStorageSecondaryKeyInUse: bool
    retentionDays: int
    state: 'string'
    storageAccountAccessKey: 'string'
    storageAccountSubscriptionId: 'string'
    storageEndpoint: 'string'
  }
}

屬性值

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

名字	描述	價值
名字	資源名稱	'default' （必要）
父代	在 Bicep 中，您可以指定子資源的父資源。只有在父資源外部宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型的資源符號名稱：workspaces/sqlPools
性能	資源屬性。	SqlPoolBlobAuditingPolicy属性

SqlPoolBlobAuditingPolicy属性

名字	描述	價值
auditActionsAnd組	指定要稽核的 Actions-Groups 和動作。建議使用的一組動作群組是下列組合 - 這會稽核針對資料庫執行的所有查詢和預存程式，以及成功和失敗的登入： BATCH_COMPLETED_GROUP， SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP， FAILED_DATABASE_AUTHENTICATION_GROUP。上述組合也是從 Azure 入口網站啟用稽核時預設設定的集合。要稽核的支援動作群組為（注意：僅選擇涵蓋稽核需求的特定群組。使用不必要的群組可能會導致大量稽核記錄）： APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP 資料庫驗證群組失敗 SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP 成功的資料庫驗證組 USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP 批次完成組這些群組涵蓋針對資料庫執行的所有 sql 語句和預存程式，且不應與其他群組搭配使用，因為這會導致重複的稽核記錄。如需詳細資訊，請參閱 Database-Level 稽核動作群組。針對資料庫稽核原則，也可以指定特定動作（請注意，無法為伺服器稽核原則指定動作）。要稽核的支援動作如下： SELECT 更新插入刪除執行收到引用定義要稽核之動作的一般窗體如下： {action}ON {object} BY {principal} 請注意，上述格式 <物件> 可以參考數據表、檢視或預存程式或整個資料庫或架構等物件。針對後者，會分別使用 DATABASE：：{db_name} 和 SCHEMA：：{schema_name} 窗體。例如：依公用的 dbo.myTable 上的 SELECT SELECT on DATABASE：：myDatabase by public SELECT on SCHEMA：：mySchema by public 如需詳細資訊，請參閱 Database-Level 稽核動作	字串[]
isAzureMonitorTargetEnabled	指定稽核事件是否傳送至 Azure 監視器。若要將事件傳送至 Azure 監視器，請將 'state' 指定為 'Enabled'，並將 'isAzureMonitorTargetEnabled' 指定為 true。使用 REST API 設定稽核時，也應該在資料庫上建立具有 'SQLSecurityAuditEvents' 診斷記錄類別的診斷設定。請注意，針對伺服器層級稽核，您應該使用 'master' 資料庫作為 {databaseName}。診斷設定 URI 格式：放 `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` 如需詳細資訊，請參閱診斷設定 REST API 或診斷設定PowerShell	布爾 (bool)
isStorageSecondaryKeyInUse	指定 storageAccountAccessKey 值是否為記憶體的次要密鑰。	布爾 (bool)
retention天數	指定要保留在記憶體帳戶稽核記錄中的天數。	整數 (int)
狀態	指定原則的狀態。如果狀態為 Enabled，則需要 storageEndpoint 或 isAzureMonitorTargetEnabled。	“已禁用” 'Enabled' （必要）
storageAccountAccessKey	指定稽核記憶體帳戶的標識碼金鑰。如果狀態為 Enabled 且指定 storageEndpoint，則需要 storageAccountAccessKey。	字串
storageAccountSubscriptionId	指定 Blob 記憶體訂用帳戶標識碼。	字串約束：最小長度 = 36 最大長度 = 36 圖案 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
storageEndpoint	指定 Blob 記憶體端點（例如 `https://MyAccount.blob.core.windows.net`）。如果狀態為 Enabled，則需要 storageEndpoint。	字串

ARM 樣本資源定義

workspaces/sqlPools/auditingSettings 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署指令關於每個 API 版本變更屬性的清單，請參見變更日誌。

使用範例

資源格式

若要建立 Microsoft.Synapse/workspaces/sqlPools/auditingSettings 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "auditActionsAndGroups": [ "string" ],
    "isAzureMonitorTargetEnabled": "bool",
    "isStorageSecondaryKeyInUse": "bool",
    "retentionDays": "int",
    "state": "string",
    "storageAccountAccessKey": "string",
    "storageAccountSubscriptionId": "string",
    "storageEndpoint": "string"
  }
}

屬性值

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

名字	描述	價值
apiVersion	API 版本	'2021-06-01'
名字	資源名稱	'default' （必要）
性能	資源屬性。	SqlPoolBlobAuditingPolicy属性
型別	資源類型	“Microsoft.Synapse/workspaces/sqlPools/auditingSettings”

SqlPoolBlobAuditingPolicy属性

名字	描述	價值
auditActionsAnd組	指定要稽核的 Actions-Groups 和動作。建議使用的一組動作群組是下列組合 - 這會稽核針對資料庫執行的所有查詢和預存程式，以及成功和失敗的登入： BATCH_COMPLETED_GROUP， SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP， FAILED_DATABASE_AUTHENTICATION_GROUP。上述組合也是從 Azure 入口網站啟用稽核時預設設定的集合。要稽核的支援動作群組為（注意：僅選擇涵蓋稽核需求的特定群組。使用不必要的群組可能會導致大量稽核記錄）： APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP 資料庫驗證群組失敗 SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP 成功的資料庫驗證組 USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP 批次完成組這些群組涵蓋針對資料庫執行的所有 sql 語句和預存程式，且不應與其他群組搭配使用，因為這會導致重複的稽核記錄。如需詳細資訊，請參閱 Database-Level 稽核動作群組。針對資料庫稽核原則，也可以指定特定動作（請注意，無法為伺服器稽核原則指定動作）。要稽核的支援動作如下： SELECT 更新插入刪除執行收到引用定義要稽核之動作的一般窗體如下： {action}ON {object} BY {principal} 請注意，上述格式 <物件> 可以參考數據表、檢視或預存程式或整個資料庫或架構等物件。針對後者，會分別使用 DATABASE：：{db_name} 和 SCHEMA：：{schema_name} 窗體。例如：依公用的 dbo.myTable 上的 SELECT SELECT on DATABASE：：myDatabase by public SELECT on SCHEMA：：mySchema by public 如需詳細資訊，請參閱 Database-Level 稽核動作	字串[]
isAzureMonitorTargetEnabled	指定稽核事件是否傳送至 Azure 監視器。若要將事件傳送至 Azure 監視器，請將 'state' 指定為 'Enabled'，並將 'isAzureMonitorTargetEnabled' 指定為 true。使用 REST API 設定稽核時，也應該在資料庫上建立具有 'SQLSecurityAuditEvents' 診斷記錄類別的診斷設定。請注意，針對伺服器層級稽核，您應該使用 'master' 資料庫作為 {databaseName}。診斷設定 URI 格式：放 `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` 如需詳細資訊，請參閱診斷設定 REST API 或診斷設定PowerShell	布爾 (bool)
isStorageSecondaryKeyInUse	指定 storageAccountAccessKey 值是否為記憶體的次要密鑰。	布爾 (bool)
retention天數	指定要保留在記憶體帳戶稽核記錄中的天數。	整數 (int)
狀態	指定原則的狀態。如果狀態為 Enabled，則需要 storageEndpoint 或 isAzureMonitorTargetEnabled。	“已禁用” 'Enabled' （必要）
storageAccountAccessKey	指定稽核記憶體帳戶的標識碼金鑰。如果狀態為 Enabled 且指定 storageEndpoint，則需要 storageAccountAccessKey。	字串
storageAccountSubscriptionId	指定 Blob 記憶體訂用帳戶標識碼。	字串約束：最小長度 = 36 最大長度 = 36 圖案 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
storageEndpoint	指定 Blob 記憶體端點（例如 `https://MyAccount.blob.core.windows.net`）。如果狀態為 Enabled，則需要 storageEndpoint。	字串

Terraform （AzAPI 提供者）資源定義

workspaces/sqlPools/auditingSettings 資源類型可以使用目標作業來部署：

資源團體 關於每個 API 版本變更屬性的清單，請參見變更日誌。

資源格式

若要建立 Microsoft.Synapse/workspaces/sqlPools/auditingSettings 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      auditActionsAndGroups = [
        "string"
      ]
      isAzureMonitorTargetEnabled = bool
      isStorageSecondaryKeyInUse = bool
      retentionDays = int
      state = "string"
      storageAccountAccessKey = "string"
      storageAccountSubscriptionId = "string"
      storageEndpoint = "string"
    }
  }
}

屬性值

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

名字	描述	價值
名字	資源名稱	'default' （必要）
父項識別碼	此資源為父系之資源的標識碼。	類型資源的標識碼：workspaces/sqlPools
性能	資源屬性。	SqlPoolBlobAuditingPolicy属性
型別	資源類型	“Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01”

SqlPoolBlobAuditingPolicy属性

名字	描述	價值
auditActionsAnd組	指定要稽核的 Actions-Groups 和動作。建議使用的一組動作群組是下列組合 - 這會稽核針對資料庫執行的所有查詢和預存程式，以及成功和失敗的登入： BATCH_COMPLETED_GROUP， SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP， FAILED_DATABASE_AUTHENTICATION_GROUP。上述組合也是從 Azure 入口網站啟用稽核時預設設定的集合。要稽核的支援動作群組為（注意：僅選擇涵蓋稽核需求的特定群組。使用不必要的群組可能會導致大量稽核記錄）： APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP 資料庫驗證群組失敗 SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP 成功的資料庫驗證組 USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP 批次完成組這些群組涵蓋針對資料庫執行的所有 sql 語句和預存程式，且不應與其他群組搭配使用，因為這會導致重複的稽核記錄。如需詳細資訊，請參閱 Database-Level 稽核動作群組。針對資料庫稽核原則，也可以指定特定動作（請注意，無法為伺服器稽核原則指定動作）。要稽核的支援動作如下： SELECT 更新插入刪除執行收到引用定義要稽核之動作的一般窗體如下： {action}ON {object} BY {principal} 請注意，上述格式 <物件> 可以參考數據表、檢視或預存程式或整個資料庫或架構等物件。針對後者，會分別使用 DATABASE：：{db_name} 和 SCHEMA：：{schema_name} 窗體。例如：依公用的 dbo.myTable 上的 SELECT SELECT on DATABASE：：myDatabase by public SELECT on SCHEMA：：mySchema by public 如需詳細資訊，請參閱 Database-Level 稽核動作	字串[]
isAzureMonitorTargetEnabled	指定稽核事件是否傳送至 Azure 監視器。若要將事件傳送至 Azure 監視器，請將 'state' 指定為 'Enabled'，並將 'isAzureMonitorTargetEnabled' 指定為 true。使用 REST API 設定稽核時，也應該在資料庫上建立具有 'SQLSecurityAuditEvents' 診斷記錄類別的診斷設定。請注意，針對伺服器層級稽核，您應該使用 'master' 資料庫作為 {databaseName}。診斷設定 URI 格式：放 `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` 如需詳細資訊，請參閱診斷設定 REST API 或診斷設定PowerShell	布爾 (bool)
isStorageSecondaryKeyInUse	指定 storageAccountAccessKey 值是否為記憶體的次要密鑰。	布爾 (bool)
retention天數	指定要保留在記憶體帳戶稽核記錄中的天數。	整數 (int)
狀態	指定原則的狀態。如果狀態為 Enabled，則需要 storageEndpoint 或 isAzureMonitorTargetEnabled。	“已禁用” 'Enabled' （必要）
storageAccountAccessKey	指定稽核記憶體帳戶的標識碼金鑰。如果狀態為 Enabled 且指定 storageEndpoint，則需要 storageAccountAccessKey。	字串
storageAccountSubscriptionId	指定 Blob 記憶體訂用帳戶標識碼。	字串約束：最小長度 = 36 最大長度 = 36 圖案 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
storageEndpoint	指定 Blob 記憶體端點（例如 `https://MyAccount.blob.core.windows.net`）。如果狀態為 Enabled，則需要 storageEndpoint。	字串

意見反應

此頁面對您有幫助嗎？

上次更新時間： 2026-07-21

Microsoft。Synapse workspaces/sqlPools/auditingSettings

Bicep 資源定義

資源格式

屬性值

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

SqlPoolBlobAuditingPolicy属性

ARM 樣本資源定義

使用範例

資源格式

屬性值

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

SqlPoolBlobAuditingPolicy属性

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

SqlPoolBlobAuditingPolicy属性

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義