Freigeben über

SQL Audit Settings - Update SQL Audit Settings

Dienst:
SQLDatabase
API-Version:
v1

Aktualisiert die Überwachungseinstellungen für die angegebene SQL-Datenbank.

Erlaubnisse

Der Aufrufer muss Über Lese- und Schreibberechtigungen für die SQL-Datenbank verfügen.

Erforderliche delegierte Bereiche

SQLDatabase.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Support
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
sqlDatabaseId
 path True

string (uuid)

Die SQL-Datenbank-ID.
workspaceId
 path True

string (uuid)

Der Arbeitsbereichsbezeichner.

Anforderungstext

Name Typ Beschreibung
auditActionsAndGroups

string[]

Überwachungsaktionen und -gruppen. Wenn der Zustand zum ersten Mal auf "Aktiviert" festgelegt ist und diese Eigenschaft nicht bereitgestellt wird, werden standardüberwachungsaktionen und -gruppen angewendet.
predicateExpression

string

Der Prädikatausdruck, der zum Filtern von Überwachungsprotokollen verwendet wird. Wenn der Zustand zum ersten Mal auf "Enabled" festgelegt ist und diese Eigenschaft nicht angegeben wird, wird standardmäßig kein Prädikatausdruck angewendet.
retentionDays

integer

Aufbewahrungstage. Wenn der Status zum ersten Mal auf "Aktiviert" festgelegt ist und diese Eigenschaft nicht angegeben wird, wird "retentionDays" standardmäßig auf 0 (unbestimmte Aufbewahrungsfrist) festgelegt.
state

SqlAuditSettingsState

Statustyp der Überwachungseinstellungen.

Antworten

Name Typ Beschreibung
200 OK

SqlDatabaseAuditSettings

Die Anforderung wurde erfolgreich abgeschlossen.
429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

Beispiele

Update SQL audit settings example

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
SqlAuditSettingsState

Status der SQL-Überwachungseinstellungen. Beim erstmaligen Aktivieren der Überwachungsrichtlinie nach der Datenbankerstellung (durch Festlegen des Status auf "Aktiviert" ohne andere Eigenschaften) werden Standardwerte angewendet. Für alle nachfolgenden Aktivierungs-/Deaktivaktionen bleiben die vorherigen Richtlinieneinstellungen erhalten. Zusätzliche SqlAuditSettingsState können im Laufe der Zeit hinzugefügt werden.
SqlDatabaseAuditSettings

Der aktuelle Status der Überwachungseinstellungen für eine Datenbank.
SqlDatabaseAuditSettingsUpdate

Aktualisierungsanforderung für Datenbanküberwachungseinstellungen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string (uuid)

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

SqlAuditSettingsState

Enumeration

Status der SQL-Überwachungseinstellungen. Beim erstmaligen Aktivieren der Überwachungsrichtlinie nach der Datenbankerstellung (durch Festlegen des Status auf "Aktiviert" ohne andere Eigenschaften) werden Standardwerte angewendet. Für alle nachfolgenden Aktivierungs-/Deaktivaktionen bleiben die vorherigen Richtlinieneinstellungen erhalten. Zusätzliche SqlAuditSettingsState können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Enabled

Aktivieren Sie die SQL-Überwachung.
Disabled

Deaktivieren Sie die SQL-Überwachung.

SqlDatabaseAuditSettings

Objekt

Der aktuelle Status der Überwachungseinstellungen für eine Datenbank.

Name Typ Standardwert Beschreibung
auditActionsAndGroups

string[]

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

Überwachungsaktionen und -gruppen.
predicateExpression

string

Der Prädikatausdruck, der zum Filtern von Überwachungsprotokollen verwendet wird.
retentionDays

integer

0

Aufbewahrungstage. 0 gibt einen unbestimmten Aufbewahrungszeitraum an.
state

SqlAuditSettingsState

Statustyp der Überwachungseinstellungen.
storageEndpoint

string

Der Speicherendpunkt, an dem Überwachungsprotokolle gespeichert werden.

SqlDatabaseAuditSettingsUpdate

Objekt

Aktualisierungsanforderung für Datenbanküberwachungseinstellungen.

Name Typ Beschreibung
auditActionsAndGroups

string[]

Überwachungsaktionen und -gruppen. Wenn der Zustand zum ersten Mal auf "Aktiviert" festgelegt ist und diese Eigenschaft nicht bereitgestellt wird, werden standardüberwachungsaktionen und -gruppen angewendet.
predicateExpression

string

Der Prädikatausdruck, der zum Filtern von Überwachungsprotokollen verwendet wird. Wenn der Zustand zum ersten Mal auf "Enabled" festgelegt ist und diese Eigenschaft nicht angegeben wird, wird standardmäßig kein Prädikatausdruck angewendet.
retentionDays

integer

Aufbewahrungstage. Wenn der Status zum ersten Mal auf "Aktiviert" festgelegt ist und diese Eigenschaft nicht angegeben wird, wird "retentionDays" standardmäßig auf 0 (unbestimmte Aufbewahrungsfrist) festgelegt.
state

SqlAuditSettingsState

Statustyp der Überwachungseinstellungen.