SQL Audit Settings - Update SQL Audit Settings

Layanan:: SQLDatabase

Versi API:: v1

Memperbarui pengaturan audit pada database SQL yang ditentukan.

Permissions

Pemanggil harus memiliki izin baca dan tulis untuk database SQL.

Cakupan yang Didelegasikan yang Diperlukan

SQLDatabase.ReadWrite.All atau Item.ReadWrite.All

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Support
Pengguna	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Antarmuka

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
sqlDatabaseId	path	True	string (uuid)	ID database SQL.
workspaceId	path	True	string (uuid)	Pengidentifikasi ruang kerja.

Isi Permintaan

Nama	Jenis	Deskripsi
auditActionsAndGroups	string[]	Mengaudit tindakan dan grup. Untuk pertama kalinya, ketika status diatur ke Diaktifkan dan properti ini tidak disediakan, tindakan dan grup audit default akan diterapkan.
predicateExpression	string	Ekspresi predikat yang digunakan untuk memfilter log audit. Untuk pertama kalinya, ketika status diatur ke Diaktifkan dan properti ini tidak disediakan, tidak ada ekspresi predikat yang akan diterapkan secara default.
retentionDays	integer	Hari retensi. Untuk pertama kalinya, ketika status diatur ke Diaktifkan dan properti ini tidak disediakan, retentionDays akan diatur ke 0 (periode retensi yang tidak terbatas) secara default.
state	SqlAuditSettingsState	Jenis status pengaturan audit.

Respons

Nama Jenis Deskripsi

200 OK

Nama	Jenis	Deskripsi
200 OK	SqlDatabaseAuditSettings	Permintaan berhasil diselesaikan.
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang `Retry-After` menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: ItemNotFound - Item yang diminta tidak ditemukan.

SqlDatabaseAuditSettings

Permintaan berhasil diselesaikan.

429 Too Many Requests

ErrorResponse

Batas tarif layanan terlampaui. Server mengembalikan header yang Retry-After menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Kode kesalahan umum:

ItemNotFound - Item yang diminta tidak ditemukan.

Contoh

Update SQL audit settings example

Permintaan sampel

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

Respon sampel

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

Definisi

Nama	Deskripsi
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
SqlAuditSettingsState	Status pengaturan Audit Sql. Saat mengaktifkan kebijakan audit untuk pertama kalinya setelah pembuatan database (dengan mengatur status ke 'Diaktifkan' tanpa properti lain), nilai default diterapkan. Untuk semua operasi aktifkan/nonaktifkan berikutnya, pengaturan kebijakan sebelumnya dipertahankan. SqlAuditSettingsState tambahan dapat ditambahkan dari waktu ke waktu.
SqlDatabaseAuditSettings	Status pengaturan audit saat ini untuk database.
SqlDatabaseAuditSettingsUpdate	Permintaan pembaruan pengaturan audit database.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. `Retry-After` Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

SqlAuditSettingsState

Enumerasi

Status pengaturan Audit Sql. Saat mengaktifkan kebijakan audit untuk pertama kalinya setelah pembuatan database (dengan mengatur status ke 'Diaktifkan' tanpa properti lain), nilai default diterapkan. Untuk semua operasi aktifkan/nonaktifkan berikutnya, pengaturan kebijakan sebelumnya dipertahankan. SqlAuditSettingsState tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Enabled	Aktifkan audit SQL.
Disabled	Nonaktifkan audit SQL.

SqlDatabaseAuditSettings

Objek

Status pengaturan audit saat ini untuk database.

Nama	Jenis	Nilai default	Deskripsi
auditActionsAndGroups	string[]	[ "BATCH_COMPLETED_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP" ]	Mengaudit tindakan dan grup.
predicateExpression	string		Ekspresi predikat yang digunakan untuk memfilter log audit.
retentionDays	integer	0	Hari retensi. 0 menunjukkan periode retensi yang tidak terbatas.
state	SqlAuditSettingsState		Jenis status pengaturan audit.
storageEndpoint	string		Titik akhir penyimpanan tempat log audit disimpan.

SqlDatabaseAuditSettingsUpdate

Objek

Permintaan pembaruan pengaturan audit database.

Nama	Jenis	Deskripsi
auditActionsAndGroups	string[]	Mengaudit tindakan dan grup. Untuk pertama kalinya, ketika status diatur ke Diaktifkan dan properti ini tidak disediakan, tindakan dan grup audit default akan diterapkan.
predicateExpression	string	Ekspresi predikat yang digunakan untuk memfilter log audit. Untuk pertama kalinya, ketika status diatur ke Diaktifkan dan properti ini tidak disediakan, tidak ada ekspresi predikat yang akan diterapkan secara default.
retentionDays	integer	Hari retensi. Untuk pertama kalinya, ketika status diatur ke Diaktifkan dan properti ini tidak disediakan, retentionDays akan diatur ke 0 (periode retensi yang tidak terbatas) secara default.
state	SqlAuditSettingsState	Jenis status pengaturan audit.