Auditing REST API

The Auditing REST API enables you to configure, retrieve, and manage auditing settings for Azure SQL Database instances.

Operations

Method	URI	Description
GET	`/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/default`	Get current auditing settings.
PUT	`/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/default`	Create or update auditing settings.
DELETE	`/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/default`	Remove auditing configuration.

Request Example

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "auditActionsAndGroups": [
      "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP",
      "FAILED_DATABASE_AUTHENTICATION_GROUP"
    ],
    "retentionDays": 90
  }
}

Response Example

{
  "id": "/subscriptions/xxxx/resourceGroups/rg1/providers/Microsoft.Sql/servers/server1/databases/db1/auditingSettings/default",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/auditingSettings",
  "properties": {
    "state": "Enabled",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "auditActionsAndGroups": [
      "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP",
      "FAILED_DATABASE_AUTHENTICATION_GROUP"
    ],
    "retentionDays": 90,
    "creationTime": "2023-04-01T12:34:56Z"
  }
}

Notes

Both state and storageEndpoint are required for enabling auditing.
Retention period cannot exceed 730 days.
Auditing can also be configured at the server level – see the Server Auditing API.