SQL Audit Settings - Get SQL Audit Settings

Dienst:: SQLEndpoint

API-Version:: v1

Gibt die Einstellungen zurück, die dem SQL-Endpunkt zugeordnet sind.

Erlaubnisse

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

Erforderliche delegierte Bereiche

SQLEndpoint.Read.All oder SQLEndpoint.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	Yes
Service Principal und Verwaltete Identitäten	Yes

Schnittstelle

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

Antworten

Name Typ Beschreibung

200 OK

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.

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

Get SQL Audit Settings

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "state": "Enabled",
  "retentionDays": 10,
  "auditActionsAndGroups": [
    "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
  ]
}

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.

AuditSettingsState

Enumeration

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

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

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.

SqlAuditSettings

Objekt

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.