SQL Audit Settings - Update SQL Audit Settings

服務:
SQLDatabase
API 版本:
v1

更新指定 SQL 資料庫的稽核設定。

許可

呼叫端必須具有 SQL 資料庫的 讀取和寫入 許可權。

必要的委派範圍

SQLDatabase.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

身分識別 支援
User 是的
服務主體 和 受控識別 是的

介面

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/settings/sqlAudit

URI 參數

名稱 位於 必要 類型 Description
sqlDatabaseId
 path True

string (uuid)

SQL 資料庫標識碼。
workspaceId
 path True

string (uuid)

工作區標識碼。

要求本文

名稱 類型 Description
auditActionsAndGroups

string[]

稽核動作和群組。 這是首次，當狀態被設定為啟用且未提供此屬性時，將套用預設的審計動作與群組。
predicateExpression

string

用於過濾稽核日誌的謂詞表達式。 這是首次，當狀態設為啟用且未提供此屬性時，預設不會套用謂詞表達式。
retentionDays

integer

保留天數。 首次，當狀態被設定為啟用且未提供此屬性時，retentionDays 預設會設為 0（無限期保留期）。
state

SqlAuditSettingsState

稽核設定狀態類型。

回覆

名稱 類型 Description
200 OK

SqlDatabaseAuditSettings

要求成功完成。
429 Too Many Requests

ErrorResponse

服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。

標題

Retry-After: integer
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • ItemNotFound - 找不到要求的專案。

範例

Update SQL audit settings example

範例要求

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/settings/sqlAudit

{
  "state": "Enabled",
  "retentionDays": 10,
  "predicateExpression": "statement not like '[select ]%'"
}

範例回覆

狀態碼:
200 
{
  "state": "Enabled",
  "storageEndpoint": "https://onelake.blob.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/Audit/",
  "retentionDays": 10,
  "auditActionsAndGroups": [
    "BATCH_COMPLETED_GROUP",
    "FAILED_DATABASE_AUTHENTICATION_GROUP",
    "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
  ],
  "predicateExpression": "statement not like '[select ]%'"
}

定義

名稱 Description
ErrorParameter

一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
SqlAuditSettingsState

SQL Audit 設定說明。 在資料庫建立後首次啟用稽核政策（將狀態設為「啟用」且未保留其他屬性）時，會套用預設值。 在所有後續啟用/停用操作中，先前的政策設定都會被保留。 隨著時間推移，可能會新增額外的 SqlAuditSettingsState。
SqlDatabaseAuditSettings

資料庫審計設定的現況。
SqlDatabaseAuditSettingsUpdate

資料庫稽核設定更新請求。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱 類型 Description
message

string

一個人類可讀的參數意義描述。
name

string

參數識別碼。
value

string

這是參數值。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable

boolean

若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string (uuid)

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

SqlAuditSettingsState

列舉型別

SQL Audit 設定說明。 在資料庫建立後首次啟用稽核政策（將狀態設為「啟用」且未保留其他屬性）時，會套用預設值。 在所有後續啟用/停用操作中，先前的政策設定都會被保留。 隨著時間推移，可能會新增額外的 SqlAuditSettingsState。

值 Description
Enabled

啟用 SQL 稽核。
Disabled

停用 SQL 稽核。

SqlDatabaseAuditSettings

Object

資料庫審計設定的現況。

名稱 類型 預設值 Description
auditActionsAndGroups

string[]

[ "BATCH_COMPLETED_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP" ]

稽核動作和群組。
predicateExpression

string

用於過濾稽核日誌的謂詞表達式。
retentionDays

integer

0

保留天數。 0 表示無限期保留期間。
state

SqlAuditSettingsState

稽核設定狀態類型。
storageEndpoint

string

儲存端點，存放稽核日誌。

SqlDatabaseAuditSettingsUpdate

Object

資料庫稽核設定更新請求。

名稱 類型 Description
auditActionsAndGroups

string[]

稽核動作和群組。 這是首次，當狀態被設定為啟用且未提供此屬性時，將套用預設的審計動作與群組。
predicateExpression

string

用於過濾稽核日誌的謂詞表達式。 這是首次，當狀態設為啟用且未提供此屬性時，預設不會套用謂詞表達式。
retentionDays

integer

保留天數。 首次，當狀態被設定為啟用且未提供此屬性時，retentionDays 預設會設為 0（無限期保留期）。
state

SqlAuditSettingsState

稽核設定狀態類型。