SQL Audit Settings - Update SQL Audit Settings

Servicio:: SQLEndpoint

Versión de la API:: v1

Actualice la configuración asociada al punto de conexión de SQL.

Permissions

El autor de la llamada debe tener permiso de elemento de auditoría .

Ámbitos delegados necesarios

Item.Audit.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Support
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
itemId	path	True	string (uuid)	Identificador del elemento.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Tipo	Description
retentionDays	integer	Días de retención.
state	AuditSettingsState	Tipo de estado de configuración de auditoría.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	SqlAuditSettings	Solicitud completada correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado.

SqlAuditSettings

Solicitud completada correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

ItemNotFound: no se encontró el elemento solicitado.

Ejemplos

Update SQL Audit Settings

Solicitud de ejemplo

HTTP

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

{
  "state": "Enabled",
  "retentionDays": 10
}

Respuesta de muestra

status code:: 200

Definiciones

Nombre	Description
AuditSettingsState	Estado de configuración de auditoría. Se puede agregar AuditSettingsState adicional a lo largo del tiempo.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
SqlAuditSettings	Estado actual de la configuración de auditoría de un elemento.
SqlAuditSettingsUpdate	Solicitud de actualización de la configuración de auditoría.

AuditSettingsState

Enumeración

Estado de configuración de auditoría. Se puede agregar AuditSettingsState adicional a lo largo del tiempo.

Valor	Description
Enabled	Habilite la auditoría de SQL.
Disabled	Deshabilite la auditoría de SQL.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.