SQL Audit Settings - Update SQL Audit Settings

Mit dem SQL-Endpunkt verknüpfte Einstellungen aktualisieren.

Erlaubnisse

Der Aufrufer muss über die Berechtigung "Überwachungselement " verfügen.

Erforderliche delegierte Bereiche

Item.Audit.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 Yes
Service Principal und Verwaltete Identitäten Yes

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
itemId
path True

string (uuid)

Die Element-ID.

workspaceId
path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
retentionDays

integer

Aufbewahrungstage.

state

AuditSettingsState

Statustyp der Überwachungseinstellungen.

Antworten

Name Typ Beschreibung
200 OK

SqlAuditSettings

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

Beispielanforderung

PATCH https://api.fabric.microsoft.com/v1/workspaces/a97f3e88-9f0a-4183-b1d9-31e6eb00e778/sqlEndpoints/70bcc992-a346-4f21-afe5-8b9ed1596a2b/settings/sqlAudit

{
  "state": "Enabled",
  "retentionDays": 10
}

Beispiel für eine Antwort

Definitionen

Name Beschreibung
AuditSettingsState

Status der Überwachungseinstellungen. Zusätzliche AuditSettingsState können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

ErrorResponse

Die Fehlerantwort.

ErrorResponseDetails

Die Fehlerantwortdetails.

SqlAuditSettings

Der aktuelle Status der Überwachungseinstellungen für ein Element.

SqlAuditSettingsUpdate

Aktualisierungsanforderung für Überwachungseinstellungen.

AuditSettingsState

Status der Überwachungseinstellungen. Zusätzliche AuditSettingsState können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Enabled

Aktivieren Sie die SQL-Überwachung.

Disabled

Deaktivieren Sie die SQL-Überwachung.

ErrorRelatedResource

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

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.

isRetriable

boolean

Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.

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

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.

SqlAuditSettings

Der aktuelle Status der Überwachungseinstellungen für ein Element.

Name Typ Beschreibung
auditActionsAndGroups

string[]

Überwachungsaktionen und -gruppen.

retentionDays

integer

Aufbewahrungstage. 0 gibt einen unbestimmten Aufbewahrungszeitraum an.

state

AuditSettingsState

Statustyp der Überwachungseinstellungen.

SqlAuditSettingsUpdate

Aktualisierungsanforderung für Überwachungseinstellungen.

Name Typ Standardwert Beschreibung
retentionDays

integer

0

Aufbewahrungstage.

state

AuditSettingsState

Statustyp der Überwachungseinstellungen.