SQL Audit Settings - Update SQL Audit Settings

Usługa:

SQLDatabase

Wersja interfejsu API:

v1

Aktualizuje ustawienia inspekcji w określonej bazie danych SQL.

uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla bazy danych SQL.

Wymagane zakresy delegowane

SQLDatabase.ReadWrite.All lub Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Support
Użytkownik	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
sqlDatabaseId	path	True	string (uuid)	Identyfikator bazy danych SQL.
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Typ	Opis
auditActionsAndGroups	string[]	Przeprowadź inspekcję akcji i grup. Po raz pierwszy, gdy stan jest ustawiony na Włączone i ta właściwość nie jest podana, zostaną zastosowane domyślne akcje inspekcji i grupy.
predicateExpression	string	Wyrażenie predykatu używane do filtrowania dzienników inspekcji. Po raz pierwszy, gdy stan jest ustawiony na Włączone i ta właściwość nie jest podana, żadne wyrażenie predykatu nie zostanie zastosowane domyślnie.
retentionDays	integer	Dni przechowywania. Po raz pierwszy, gdy stan jest ustawiony na Włączone i ta właściwość nie jest podana, wartość retentionDays zostanie domyślnie ustawiona na 0 (nieokreślony okres przechowywania).
state	SqlAuditSettingsState	Typ stanu ustawień inspekcji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SqlDatabaseAuditSettings	Żądanie zostało ukończone pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony.

Przykłady

Update SQL audit settings example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
SqlAuditSettingsState	Stan ustawień inspekcji sql. Podczas włączania zasad inspekcji po raz pierwszy po utworzeniu bazy danych (ustawiając stan na "Włączone" bez innych właściwości), są stosowane wartości domyślne. Dla wszystkich kolejnych operacji włączania/wyłączania poprzednie ustawienia zasad są zachowywane. Dodatkowa wartość SqlAuditSettingsState może zostać dodana w czasie.
SqlDatabaseAuditSettings	Bieżący stan ustawień inspekcji bazy danych.
SqlDatabaseAuditSettingsUpdate	Żądanie aktualizacji ustawień inspekcji bazy danych.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

SqlAuditSettingsState

Wyliczenie

Stan ustawień inspekcji sql. Podczas włączania zasad inspekcji po raz pierwszy po utworzeniu bazy danych (ustawiając stan na "Włączone" bez innych właściwości), są stosowane wartości domyślne. Dla wszystkich kolejnych operacji włączania/wyłączania poprzednie ustawienia zasad są zachowywane. Dodatkowa wartość SqlAuditSettingsState może zostać dodana w czasie.

Wartość	Opis
Enabled	Włącz inspekcję SQL.
Disabled	Wyłącz inspekcję SQL.

SqlDatabaseAuditSettings

Objekt

Bieżący stan ustawień inspekcji bazy danych.

Nazwa	Typ	Domyślna wartość	Opis
auditActionsAndGroups	string[]	[ "BATCH_COMPLETED_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP" ]	Przeprowadź inspekcję akcji i grup.
predicateExpression	string		Wyrażenie predykatu używane do filtrowania dzienników inspekcji.
retentionDays	integer	0	Dni przechowywania. 0 wskazuje nieokreślony okres przechowywania.
state	SqlAuditSettingsState		Typ stanu ustawień inspekcji.
storageEndpoint	string		Punkt końcowy magazynu, w którym są przechowywane dzienniki inspekcji.

SqlDatabaseAuditSettingsUpdate

Objekt

Żądanie aktualizacji ustawień inspekcji bazy danych.

Nazwa	Typ	Opis
auditActionsAndGroups	string[]	Przeprowadź inspekcję akcji i grup. Po raz pierwszy, gdy stan jest ustawiony na Włączone i ta właściwość nie jest podana, zostaną zastosowane domyślne akcje inspekcji i grupy.
predicateExpression	string	Wyrażenie predykatu używane do filtrowania dzienników inspekcji. Po raz pierwszy, gdy stan jest ustawiony na Włączone i ta właściwość nie jest podana, żadne wyrażenie predykatu nie zostanie zastosowane domyślnie.
retentionDays	integer	Dni przechowywania. Po raz pierwszy, gdy stan jest ustawiony na Włączone i ta właściwość nie jest podana, wartość retentionDays zostanie domyślnie ustawiona na 0 (nieokreślony okres przechowywania).
state	SqlAuditSettingsState	Typ stanu ustawień inspekcji.