SQL Audit Settings - Get SQL Audit Settings

Dienst:

SQLDatabase

API-Version:

v1

Ruft die Überwachungseinstellungen für die angegebene SQL-Datenbank ab.

Erlaubnisse

Der Aufrufer muss über Leseberechtigungen oder höhere Elementberechtigungen verfügen.

Erforderliche delegierte Bereiche

SQLDatabase.Read.All oder SQLDatabase.ReadWrite.All oder Item.Read.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

GET 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.

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

Get SQL audit settings example

Beispielanforderung

HTTP

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

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.

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.