SQL Audit Settings - Update SQL Audit Settings

Servizio:

SQLDatabase

Versione API:

v1

Aggiorna le impostazioni di controllo nel database SQL specificato.

Autorizzazioni

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per il database SQL.

Ambiti delegati obbligatori

SQLDatabase.ReadWrite.All o Item.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
sqlDatabaseId	path	True	string (uuid)	ID del database SQL.
workspaceId	path	True	string (uuid)	Identificatore dell'area di lavoro.

Corpo della richiesta

Nome	Tipo	Descrizione
auditActionsAndGroups	string[]	Controlla azioni e gruppi. Per la prima volta, quando lo stato è impostato su Abilitato e questa proprietà non viene specificata, verranno applicate le azioni di controllo e i gruppi predefiniti.
predicateExpression	string	Espressione del predicato utilizzata per filtrare i log di controllo. Per la prima volta, quando lo stato è impostato su Enabled e questa proprietà non viene specificata, per impostazione predefinita non verrà applicata alcuna espressione di predicato.
retentionDays	integer	Giorni di conservazione. Per la prima volta, quando lo stato è impostato su Enabled e questa proprietà non viene specificata, retentionDays verrà impostato su 0 (periodo di conservazione indefinito) per impostazione predefinita.
state	SqlAuditSettingsState	Tipo di stato delle impostazioni di controllo.

Risposte

Nome	Tipo	Descrizione
200 OK	SqlDatabaseAuditSettings	Richiesta completata correttamente.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: ItemNotFound: l'elemento richiesto non è stato trovato.

Esempio

Update SQL audit settings example

Esempio di richiesta

HTTP

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 ]%'"
}

Risposta di esempio

Codice di stato:

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 ]%'"
}

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
SqlAuditSettingsState	Stato delle impostazioni di Sql Audit. Quando si abilitano i criteri di controllo per la prima volta dopo la creazione del database (impostando lo stato su "Abilitato" senza altre proprietà), vengono applicati valori predefiniti. Per tutte le operazioni di abilitazione/disabilitazione successive, le impostazioni dei criteri precedenti vengono mantenute. È possibile aggiungere altre proprietà SqlAuditSettingsState nel tempo.
SqlDatabaseAuditSettings	Stato corrente delle impostazioni di controllo per un database.
SqlDatabaseAuditSettingsUpdate	Richiesta di aggiornamento delle impostazioni di controllo del database.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

SqlAuditSettingsState

Enumerazione

Stato delle impostazioni di Sql Audit. Quando si abilitano i criteri di controllo per la prima volta dopo la creazione del database (impostando lo stato su "Abilitato" senza altre proprietà), vengono applicati valori predefiniti. Per tutte le operazioni di abilitazione/disabilitazione successive, le impostazioni dei criteri precedenti vengono mantenute. È possibile aggiungere altre proprietà SqlAuditSettingsState nel tempo.

Valore	Descrizione
Enabled	Abilitare il controllo SQL.
Disabled	Disabilitare il controllo SQL.

SqlDatabaseAuditSettings

Oggetto

Stato corrente delle impostazioni di controllo per un database.

Nome	Tipo	Valore predefinito	Descrizione
auditActionsAndGroups	string[]	[ "BATCH_COMPLETED_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP" ]	Controlla azioni e gruppi.
predicateExpression	string		Espressione del predicato utilizzata per filtrare i log di controllo.
retentionDays	integer	0	Giorni di conservazione. 0 indica un periodo di conservazione illimitato.
state	SqlAuditSettingsState		Tipo di stato delle impostazioni di controllo.
storageEndpoint	string		Endpoint di archiviazione in cui vengono archiviati i log di controllo.

SqlDatabaseAuditSettingsUpdate

Oggetto

Richiesta di aggiornamento delle impostazioni di controllo del database.

Nome	Tipo	Descrizione
auditActionsAndGroups	string[]	Controlla azioni e gruppi. Per la prima volta, quando lo stato è impostato su Abilitato e questa proprietà non viene specificata, verranno applicate le azioni di controllo e i gruppi predefiniti.
predicateExpression	string	Espressione del predicato utilizzata per filtrare i log di controllo. Per la prima volta, quando lo stato è impostato su Enabled e questa proprietà non viene specificata, per impostazione predefinita non verrà applicata alcuna espressione di predicato.
retentionDays	integer	Giorni di conservazione. Per la prima volta, quando lo stato è impostato su Enabled e questa proprietà non viene specificata, retentionDays verrà impostato su 0 (periodo di conservazione indefinito) per impostazione predefinita.
state	SqlAuditSettingsState	Tipo di stato delle impostazioni di controllo.