Partilhar via

SQL Audit Settings - Update SQL Audit Settings

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

Atualiza as definições de auditoria na base de dados SQL especificada.

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 suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Suporte
User Sim
Entidade de serviço e identidades geridas Sim

Interface

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

Parâmetros do URI

Name Em Necessário Tipo Description
sqlDatabaseId
 path True

string (uuid)

A ID do banco de dados SQL.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.

Corpo do Pedido

Name Tipo Description
auditActionsAndGroups

string[]

Ações e grupos de auditoria. Pela primeira vez, quando o estado está definido como Ativado e esta propriedade não é fornecida, serão aplicadas ações e grupos de auditoria por defeito.
predicateExpression

string

A expressão de predicado usada para filtrar registos de auditoria. Pela primeira vez, quando o estado está definido como Ativado e esta propriedade não é fornecida, nenhuma expressão de predicado será aplicada por defeito.
retentionDays

integer

Dias de retenção. Pela primeira vez, quando o estado está definido como Ativado e esta propriedade não é fornecida, os RetentionDays serão definidos para 0 (período de retenção indefinido) por defeito.
state

SqlAuditSettingsState

Tipo de estado das configurações de auditoria.

Respostas

Name Tipo Description
200 OK

SqlDatabaseAuditSettings

Pedido concluído com sucesso.
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos 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

Pedido de amostra

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 da amostra

Código de estado:
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

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
SqlAuditSettingsState

As definições de auditoria SQL indicam. Ao ativar a política de auditoria pela primeira vez após a criação da base de dados (definindo o estado para 'Ativado' sem outras propriedades), são aplicados valores padrão. Para todas as operações subsequentes de ativação/desativação, as definições anteriores da política são preservadas. O SqlAuditSettingsState adicional pode ser adicionado ao longo do tempo.
SqlDatabaseAuditSettings

O estado atual das definições de auditoria para uma base de dados.
SqlDatabaseAuditSettingsUpdate

Pedido de atualização das definições de auditoria da base de dados.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

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

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

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

string

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

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

SqlAuditSettingsState

Enumeração

As definições de auditoria SQL indicam. Ao ativar a política de auditoria pela primeira vez após a criação da base de dados (definindo o estado para 'Ativado' sem outras propriedades), são aplicados valores padrão. Para todas as operações subsequentes de ativação/desativação, as definições anteriores da política são preservadas. O SqlAuditSettingsState adicional pode ser adicionado ao longo do tempo.

Valor Description
Enabled

Habilite a auditoria SQL.
Disabled

Desative a auditoria SQL.

SqlDatabaseAuditSettings

Object

O estado atual das definições de auditoria para uma base de dados.

Name Tipo Default value 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 registos de auditoria.
retentionDays

integer

0

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

SqlAuditSettingsState

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

string

O endpoint de armazenamento onde os registos de auditoria são armazenados.

SqlDatabaseAuditSettingsUpdate

Object

Pedido de atualização das definições de auditoria da base de dados.

Name Tipo Description
auditActionsAndGroups

string[]

Ações e grupos de auditoria. Pela primeira vez, quando o estado está definido como Ativado e esta propriedade não é fornecida, serão aplicadas ações e grupos de auditoria por defeito.
predicateExpression

string

A expressão de predicado usada para filtrar registos de auditoria. Pela primeira vez, quando o estado está definido como Ativado e esta propriedade não é fornecida, nenhuma expressão de predicado será aplicada por defeito.
retentionDays

integer

Dias de retenção. Pela primeira vez, quando o estado está definido como Ativado e esta propriedade não é fornecida, os RetentionDays serão definidos para 0 (período de retenção indefinido) por defeito.
state

SqlAuditSettingsState

Tipo de estado das configurações de auditoria.