Compartilhar via

SQL Audit Settings - Update SQL Audit Settings

Serviço:
SQLDatabase
Versão da API:
v1

Atualiza as configurações de auditoria no banco de dados SQL especificado.

Permissões

O chamador deve ter permissões de leitura e gravação para o banco de dados SQL.

Escopos delegados necessários

SQLDatabase.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identity Suporte
Usuário Sim
Entidade de serviço e identidades gerenciadas Sim

Interfase

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
sqlDatabaseId
 path True

string (uuid)

A ID do banco de dados SQL.
workspaceId
 path True

string (uuid)

O identificador do workspace.

Corpo da solicitação

Nome Tipo Description
auditActionsAndGroups

string[]

Ações e grupos de auditoria. Pela primeira vez, quando o estado é definido como Habilitado e essa propriedade não é fornecida, ações e grupos de auditoria padrão serão aplicados.
predicateExpression

string

A expressão de predicado usada para filtrar logs de auditoria. Pela primeira vez, quando o estado é definido como Habilitado e essa propriedade não é fornecida, nenhuma expressão de predicado será aplicada por padrão.
retentionDays

integer

Dias de retenção. Pela primeira vez, quando o estado estiver definido como Habilitado e essa propriedade não for fornecida, retentionDays será definido como 0 (período de retenção indefinido) por padrão.
state

SqlAuditSettingsState

Tipo de estado de configurações de auditoria.

Respostas

Nome Tipo Description
200 OK

SqlDatabaseAuditSettings

Solicitação concluída com êxito.
429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

Exemplos

Update SQL audit settings example

Solicitação de exemplo

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

Resposta de exemplo

Código de 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 ]%'"
}

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
SqlAuditSettingsState

Estado das configurações de Auditoria do Sql. Ao habilitar a política de auditoria pela primeira vez após a criação do banco de dados (definindo o estado como "Habilitado" sem outras propriedades), os valores padrão são aplicados. Para todas as operações de habilitação/desabilitação subsequentes, as configurações de política anteriores são preservadas. SqlAuditSettingsState adicional pode ser adicionado ao longo do tempo.
SqlDatabaseAuditSettings

O estado atual das configurações de auditoria para um banco de dados.
SqlDatabaseAuditSettingsUpdate

Solicitação de atualização de configurações de auditoria de banco de dados.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

SqlAuditSettingsState

Enumeração

Estado das configurações de Auditoria do Sql. Ao habilitar a política de auditoria pela primeira vez após a criação do banco de dados (definindo o estado como "Habilitado" sem outras propriedades), os valores padrão são aplicados. Para todas as operações de habilitação/desabilitação subsequentes, as configurações de política anteriores são preservadas. SqlAuditSettingsState adicional pode ser adicionado ao longo do tempo.

Valor Description
Enabled

Habilite a auditoria do SQL.
Disabled

Desabilite a auditoria do SQL.

SqlDatabaseAuditSettings

Objeto

O estado atual das configurações de auditoria para um banco de dados.

Nome Tipo Valor padrão Description
auditActionsAndGroups

string[]

[ "BATCH_COMPLETED_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP" ]

Ações e grupos de auditoria.
predicateExpression

string

A expressão de predicado usada para filtrar logs de auditoria.
retentionDays

integer

0

Dias de retenção. 0 indica o período de retenção indefinido.
state

SqlAuditSettingsState

Tipo de estado de configurações de auditoria.
storageEndpoint

string

O ponto de extremidade de armazenamento em que os logs de auditoria são armazenados.

SqlDatabaseAuditSettingsUpdate

Objeto

Solicitação de atualização de configurações de auditoria de banco de dados.

Nome Tipo Description
auditActionsAndGroups

string[]

Ações e grupos de auditoria. Pela primeira vez, quando o estado é definido como Habilitado e essa propriedade não é fornecida, ações e grupos de auditoria padrão serão aplicados.
predicateExpression

string

A expressão de predicado usada para filtrar logs de auditoria. Pela primeira vez, quando o estado é definido como Habilitado e essa propriedade não é fornecida, nenhuma expressão de predicado será aplicada por padrão.
retentionDays

integer

Dias de retenção. Pela primeira vez, quando o estado estiver definido como Habilitado e essa propriedade não for fornecida, retentionDays será definido como 0 (período de retenção indefinido) por padrão.
state

SqlAuditSettingsState

Tipo de estado de configurações de auditoria.