Workspaces/sqlPools/auditingSettings do Microsoft.Synapse

Definição de recurso do Bicep

O tipo de recurso workspaces/sqlPools/auditingSettings pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/sqlPools/auditingSettings, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    auditActionsAndGroups: [
      'string'
    ]
    isAzureMonitorTargetEnabled: bool
    isStorageSecondaryKeyInUse: bool
    retentionDays: int
    state: 'string'
    storageAccountAccessKey: 'string'
    storageAccountSubscriptionId: 'string'
    storageEndpoint: 'string'
  }
}

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Nome	Descrição	Valor
nome	O nome do recurso	'default' (obrigatório)
pai	No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai.	Nome simbólico para o recurso do tipo: workspaces/sqlPools
Propriedades	Propriedades do recurso.	sqlPoolBlobAuditingPolicyProperties

SqlPoolBlobAuditingPolicyProperties

Nome	Descrição	Valor
auditActionsAndGroups	Especifica o Actions-Groups e as Ações a serem auditádas. O conjunto recomendado de grupos de ações a ser usado é a seguinte combinação: isso auditará todas as consultas e procedimentos armazenados executados no banco de dados, bem como logons bem-sucedidos e com falha: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. Essa combinação acima também é o conjunto configurado por padrão ao habilitar a auditoria do portal do Azure. Os grupos de ações com suporte para auditoria são (observação: escolha apenas grupos específicos que abrangem suas necessidades de auditoria. O uso de grupos desnecessários pode levar a grandes quantidades de registros de auditoria): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FALHA_NA_AUTENTICAÇÃO_DO_GRUPO_DE_BANCO_DE_DADOS SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP GRUPO_DE_AUTENTICAÇÃO_BEM_SUCEDIDA_NO_BANCO_DE_DADOS USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP Esses são grupos que abrangem todas as instruções sql e procedimentos armazenados executados no banco de dados e não devem ser usados em combinação com outros grupos, pois isso resultará em logs de auditoria duplicados. Para obter mais informações, consulte Database-Level Grupos de Ações de Auditoria. Para a política de auditoria de banco de dados, ações específicas também podem ser especificadas (observe que ações não podem ser especificadas para a política de auditoria do servidor). As ações com suporte para auditoria são: SELECT ATUALIZAÇÃO INSERIR EXCLUIR EXECUTAR RECEBER REFERÊNCIAS O formulário geral para definir uma ação a ser auditada é: {ação} ON {objeto} POR {principal} Observe que <objeto> no formato acima pode se referir a um objeto como uma tabela, exibição ou procedimento armazenado ou um banco de dados ou esquema inteiro. Para os últimos casos, os formulários DATABASE::{db_name} e SCHEMA::{schema_name} são usados, respectivamente. Por exemplo: SELECT em dbo.myTable por público SELECT em DATABASE::myDatabase por público SELECT em SCHEMA::mySchema por public Para obter mais informações, consulte Database-Level Ações de Auditoria	cadeia de caracteres[]
isAzureMonitorTargetEnabled	Especifica se os eventos de auditoria são enviados ao Azure Monitor. Para enviar os eventos para o Azure Monitor, especifique 'state' como 'Enabled' e 'isAzureMonitorTargetEnabled' como true. Ao usar a API REST para configurar a auditoria, as Configurações de Diagnóstico com a categoria de logs de diagnóstico 'SQLSecurityAuditEvents' no banco de dados também devem ser criadas. Observe que, para auditoria no nível do servidor, você deve usar o banco de dados 'mestre' como {databaseName}. Formato de URI de Configurações de Diagnóstico: PÔR `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Para obter mais informações, consulte API REST de Configurações de Diagnóstico ou do PowerShell de configurações de diagnóstico de	Bool
isStorageSecondaryKeyInUse	Especifica se o valor storageAccountAccessKey é a chave secundária do armazenamento.	Bool
retentionDays	Especifica o número de dias a serem mantidos nos logs de auditoria na conta de armazenamento.	int
estado	Especifica o estado da política. Se o estado estiver habilitado, storageEndpoint ou isAzureMonitorTargetEnabled serão necessários.	'Desabilitado' 'Enabled' (obrigatório)
Chave de acesso da conta de armazenamento	Especifica a chave do identificador da conta de armazenamento de auditoria. Se o estado estiver habilitado e storageEndpoint for especificado, storageAccountAccessKey será necessário.	cadeia
Id de SubscriptionAccountArmazenamento	Especifica a ID da assinatura do armazenamento de blobs.	corda Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
ponto de extremidade de armazenamento	Especifica o ponto de extremidade de armazenamento de blobs (por exemplo, `https://MyAccount.blob.core.windows.net`). Se o estado estiver habilitado, storageEndpoint será necessário.	cadeia

Definição de recurso de modelo do ARM

O tipo de recurso workspaces/sqlPools/auditingSettings pode ser implantado com operações direcionadas:

Grupos de recursos - Veja comandos de implantação de grupos de recursos Para uma lista de propriedades alteradas em cada versão da API, veja registro de alterações.

Exemplos de uso

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/sqlPools/auditingSettings, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "auditActionsAndGroups": [ "string" ],
    "isAzureMonitorTargetEnabled": "bool",
    "isStorageSecondaryKeyInUse": "bool",
    "retentionDays": "int",
    "state": "string",
    "storageAccountAccessKey": "string",
    "storageAccountSubscriptionId": "string",
    "storageEndpoint": "string"
  }
}

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Nome	Descrição	Valor
apiVersion	A versão da API	'2021-06-01'
nome	O nome do recurso	'default' (obrigatório)
Propriedades	Propriedades do recurso.	sqlPoolBlobAuditingPolicyProperties
tipo	O tipo de recurso	'Microsoft.Synapse/workspaces/sqlPools/auditingSettings'

SqlPoolBlobAuditingPolicyProperties

Nome	Descrição	Valor
auditActionsAndGroups	Especifica o Actions-Groups e as Ações a serem auditádas. O conjunto recomendado de grupos de ações a ser usado é a seguinte combinação: isso auditará todas as consultas e procedimentos armazenados executados no banco de dados, bem como logons bem-sucedidos e com falha: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. Essa combinação acima também é o conjunto configurado por padrão ao habilitar a auditoria do portal do Azure. Os grupos de ações com suporte para auditoria são (observação: escolha apenas grupos específicos que abrangem suas necessidades de auditoria. O uso de grupos desnecessários pode levar a grandes quantidades de registros de auditoria): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FALHA_NA_AUTENTICAÇÃO_DO_GRUPO_DE_BANCO_DE_DADOS SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP GRUPO_DE_AUTENTICAÇÃO_BEM_SUCEDIDA_NO_BANCO_DE_DADOS USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP Esses são grupos que abrangem todas as instruções sql e procedimentos armazenados executados no banco de dados e não devem ser usados em combinação com outros grupos, pois isso resultará em logs de auditoria duplicados. Para obter mais informações, consulte Database-Level Grupos de Ações de Auditoria. Para a política de auditoria de banco de dados, ações específicas também podem ser especificadas (observe que ações não podem ser especificadas para a política de auditoria do servidor). As ações com suporte para auditoria são: SELECT ATUALIZAÇÃO INSERIR EXCLUIR EXECUTAR RECEBER REFERÊNCIAS O formulário geral para definir uma ação a ser auditada é: {ação} ON {objeto} POR {principal} Observe que <objeto> no formato acima pode se referir a um objeto como uma tabela, exibição ou procedimento armazenado ou um banco de dados ou esquema inteiro. Para os últimos casos, os formulários DATABASE::{db_name} e SCHEMA::{schema_name} são usados, respectivamente. Por exemplo: SELECT em dbo.myTable por público SELECT em DATABASE::myDatabase por público SELECT em SCHEMA::mySchema por public Para obter mais informações, consulte Database-Level Ações de Auditoria	cadeia de caracteres[]
isAzureMonitorTargetEnabled	Especifica se os eventos de auditoria são enviados ao Azure Monitor. Para enviar os eventos para o Azure Monitor, especifique 'state' como 'Enabled' e 'isAzureMonitorTargetEnabled' como true. Ao usar a API REST para configurar a auditoria, as Configurações de Diagnóstico com a categoria de logs de diagnóstico 'SQLSecurityAuditEvents' no banco de dados também devem ser criadas. Observe que, para auditoria no nível do servidor, você deve usar o banco de dados 'mestre' como {databaseName}. Formato de URI de Configurações de Diagnóstico: PÔR `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Para obter mais informações, consulte API REST de Configurações de Diagnóstico ou do PowerShell de configurações de diagnóstico de	Bool
isStorageSecondaryKeyInUse	Especifica se o valor storageAccountAccessKey é a chave secundária do armazenamento.	Bool
retentionDays	Especifica o número de dias a serem mantidos nos logs de auditoria na conta de armazenamento.	int
estado	Especifica o estado da política. Se o estado estiver habilitado, storageEndpoint ou isAzureMonitorTargetEnabled serão necessários.	'Desabilitado' 'Enabled' (obrigatório)
Chave de acesso da conta de armazenamento	Especifica a chave do identificador da conta de armazenamento de auditoria. Se o estado estiver habilitado e storageEndpoint for especificado, storageAccountAccessKey será necessário.	cadeia
Id de SubscriptionAccountArmazenamento	Especifica a ID da assinatura do armazenamento de blobs.	corda Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
ponto de extremidade de armazenamento	Especifica o ponto de extremidade de armazenamento de blobs (por exemplo, `https://MyAccount.blob.core.windows.net`). Se o estado estiver habilitado, storageEndpoint será necessário.	cadeia

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso workspaces/sqlPools/auditingSettings pode ser implantado com operações direcionadas:

Grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, veja o registro de alterações.

Formato de recurso

Para criar um recurso Microsoft.Synapse/workspaces/sqlPools/auditingSettings, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      auditActionsAndGroups = [
        "string"
      ]
      isAzureMonitorTargetEnabled = bool
      isStorageSecondaryKeyInUse = bool
      retentionDays = int
      state = "string"
      storageAccountAccessKey = "string"
      storageAccountSubscriptionId = "string"
      storageEndpoint = "string"
    }
  }
}

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Nome	Descrição	Valor
nome	O nome do recurso	'default' (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: workspaces/sqlPools
Propriedades	Propriedades do recurso.	sqlPoolBlobAuditingPolicyProperties
tipo	O tipo de recurso	"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"

SqlPoolBlobAuditingPolicyProperties

Nome	Descrição	Valor
auditActionsAndGroups	Especifica o Actions-Groups e as Ações a serem auditádas. O conjunto recomendado de grupos de ações a ser usado é a seguinte combinação: isso auditará todas as consultas e procedimentos armazenados executados no banco de dados, bem como logons bem-sucedidos e com falha: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. Essa combinação acima também é o conjunto configurado por padrão ao habilitar a auditoria do portal do Azure. Os grupos de ações com suporte para auditoria são (observação: escolha apenas grupos específicos que abrangem suas necessidades de auditoria. O uso de grupos desnecessários pode levar a grandes quantidades de registros de auditoria): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FALHA_NA_AUTENTICAÇÃO_DO_GRUPO_DE_BANCO_DE_DADOS SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP GRUPO_DE_AUTENTICAÇÃO_BEM_SUCEDIDA_NO_BANCO_DE_DADOS USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP Esses são grupos que abrangem todas as instruções sql e procedimentos armazenados executados no banco de dados e não devem ser usados em combinação com outros grupos, pois isso resultará em logs de auditoria duplicados. Para obter mais informações, consulte Database-Level Grupos de Ações de Auditoria. Para a política de auditoria de banco de dados, ações específicas também podem ser especificadas (observe que ações não podem ser especificadas para a política de auditoria do servidor). As ações com suporte para auditoria são: SELECT ATUALIZAÇÃO INSERIR EXCLUIR EXECUTAR RECEBER REFERÊNCIAS O formulário geral para definir uma ação a ser auditada é: {ação} ON {objeto} POR {principal} Observe que <objeto> no formato acima pode se referir a um objeto como uma tabela, exibição ou procedimento armazenado ou um banco de dados ou esquema inteiro. Para os últimos casos, os formulários DATABASE::{db_name} e SCHEMA::{schema_name} são usados, respectivamente. Por exemplo: SELECT em dbo.myTable por público SELECT em DATABASE::myDatabase por público SELECT em SCHEMA::mySchema por public Para obter mais informações, consulte Database-Level Ações de Auditoria	cadeia de caracteres[]
isAzureMonitorTargetEnabled	Especifica se os eventos de auditoria são enviados ao Azure Monitor. Para enviar os eventos para o Azure Monitor, especifique 'state' como 'Enabled' e 'isAzureMonitorTargetEnabled' como true. Ao usar a API REST para configurar a auditoria, as Configurações de Diagnóstico com a categoria de logs de diagnóstico 'SQLSecurityAuditEvents' no banco de dados também devem ser criadas. Observe que, para auditoria no nível do servidor, você deve usar o banco de dados 'mestre' como {databaseName}. Formato de URI de Configurações de Diagnóstico: PÔR `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Para obter mais informações, consulte API REST de Configurações de Diagnóstico ou do PowerShell de configurações de diagnóstico de	Bool
isStorageSecondaryKeyInUse	Especifica se o valor storageAccountAccessKey é a chave secundária do armazenamento.	Bool
retentionDays	Especifica o número de dias a serem mantidos nos logs de auditoria na conta de armazenamento.	int
estado	Especifica o estado da política. Se o estado estiver habilitado, storageEndpoint ou isAzureMonitorTargetEnabled serão necessários.	'Desabilitado' 'Enabled' (obrigatório)
Chave de acesso da conta de armazenamento	Especifica a chave do identificador da conta de armazenamento de auditoria. Se o estado estiver habilitado e storageEndpoint for especificado, storageAccountAccessKey será necessário.	cadeia
Id de SubscriptionAccountArmazenamento	Especifica a ID da assinatura do armazenamento de blobs.	corda Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
ponto de extremidade de armazenamento	Especifica o ponto de extremidade de armazenamento de blobs (por exemplo, `https://MyAccount.blob.core.windows.net`). Se o estado estiver habilitado, storageEndpoint será necessário.	cadeia

Comentários

Esta página foi útil?

Última atualização em 2025-06-19

Workspaces/sqlPools/auditingSettings do Microsoft.Synapse

Definição de recurso do Bicep

Formato de recurso

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

SqlPoolBlobAuditingPolicyProperties

Definição de recurso de modelo do ARM

Exemplos de uso

Formato de recurso

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

SqlPoolBlobAuditingPolicyProperties

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso

Valores da propriedade

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

SqlPoolBlobAuditingPolicyProperties

Comentários

Recursos adicionais