SQL Audit Settings - Get SQL Audit Settings

Usługa:
SQLEndpoint
Wersja interfejsu API:
v1

Zwraca ustawienia skojarzone z punktem końcowym SQL.

Permissions

Obiekt wywołujący musi mieć uprawnienie czytelnika lub wyższego elementu.

Wymagane zakresy delegowane

SQLEndpoint.Read.All lub SQLEndpoint.ReadWrite.All lub Item.Read.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
User Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
itemId
 path True

string (uuid)

Identyfikator elementu.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Odpowiedzi

Nazwa Typ Opis
200 OK

SqlAuditSettings

Żą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

Get SQL Audit Settings

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AuditSettingsState

Stan ustawień inspekcji. Dodatkowa wartość AuditSettingsState może zostać dodana w czasie.
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
SqlAuditSettings

Bieżący stan ustawień inspekcji dla elementu.

AuditSettingsState

Wyliczenie

Stan ustawień inspekcji. Dodatkowa wartość AuditSettingsState może zostać dodana w czasie.

Wartość Opis
Enabled

Włącz inspekcję SQL.
Disabled

Wyłącz inspekcję SQL.

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

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
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.

SqlAuditSettings

Objekt

Bieżący stan ustawień inspekcji dla elementu.

Nazwa Typ Opis
auditActionsAndGroups

string[]

Przeprowadź inspekcję akcji i grup.
retentionDays

integer

Dni przechowywania. 0 wskazuje nieokreślony okres przechowywania.
state

AuditSettingsState

Typ stanu ustawień inspekcji.