Compartilhar via

Set-AzureRmSqlDatabaseAuditingPolicy

  • Referência
Módulo:
AzureRM.Sql

Define a política de auditoria para um banco de dados.

Aviso

O módulo PowerShell do AzureRM foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.

Sintaxe

Set-AzureRmSqlDatabaseAuditingPolicy
   [-AuditType <AuditType>]
   [-PassThru]
   [-AuditActionGroup <AuditActionGroups[]>]
   [-AuditAction <String[]>]
   [-EventType <String[]>]
   [-StorageAccountName <String>]
   [-StorageKeyType <String>]
   [-RetentionInDays <UInt32>]
   [-TableIdentifier <String>]
   [-ServerName] <String>
   [-DatabaseName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzureRmSqlDatabaseAuditingPolicy altera a política de auditoria de um banco de dados SQL do Azure. Para usar o cmdlet, use os parâmetros ResourceGroupName, ServerName e DatabaseName para identificar o banco de dados. Especifique o parâmetro StorageAccountName para especificar a conta de armazenamento para os logs de auditoria e o parâmetro StorageKeyType para definir as chaves de armazenamento. Você também pode definir a retenção para a tabela de logs de auditoria definindo o valor dos parâmetros RetentionInDays e TableIdentifier para definir o período e a semente para os nomes da tabela de log de auditoria. Especifique o parâmetro EventType para definir quais tipos de evento auditar. Depois que o cmdlet for executado com êxito, a auditoria do banco de dados será habilitada. Para Auditoria de Tabela, se o banco de dados usou a política de seu servidor para auditoria antes de você executar esse cmdlet, a auditoria interromperá o uso dessa política. Para Auditoria de Blob, se o banco de dados usou a política de seu servidor para auditoria antes de você executar esse cmdlet, ambas as políticas de auditoria existirão lado a lado. Se o cmdlet for bem-sucedido e você usar o parâmetro PassThru , ele retornará um objeto que descreve a política de auditoria atual, além dos identificadores de banco de dados. Os identificadores de banco de dados incluem, mas não estão limitados a, ResourceGroupName, ServerName e DatabaseName. O serviço de SQL Server Stretch Database no Azure também dá suporte a esse cmdlet.

Exemplos

Exemplo 1: Definir a política de auditoria de um banco de dados para usar a auditoria de tabela

PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -AuditType Table -StorageAccountName "Storage31"

Esse comando define a política de auditoria do banco de dados chamado Database01 localizado no Server01 para usar a conta de armazenamento chamada Storage31.

Exemplo 2: Definir a chave da conta de armazenamento de uma política de auditoria existente de um banco de dados

PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -StorageAccountKey Secondary

Esse comando define a política de auditoria do banco de dados chamado Database01 localizado no Server01 para continuar usando o mesmo nome de conta de armazenamento, mas agora usar a chave secundária.

Exemplo 3: Definir a política de auditoria de um banco de dados para usar um tipo de evento específico

PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -EventType Login_Failure

Exemplo 4: Definir a política de auditoria de um banco de dados para usar a auditoria de Blob

PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -AuditType Blob -StorageAccountName "Storage31" -AuditActionGroup "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP" -AuditAction "UPDATE ON database::[Database01] BY [public]"  -RetentionInDays 8

Esse comando define a política de auditoria do banco de dados chamado Database01 localizado em Server01. A política registra o tipo de evento Login_Failure. O comando não altera as configurações de armazenamento.

Parâmetros

-AuditAction

Especifique uma ou mais ações de auditoria. Esse parâmetro só é aplicável à auditoria de Blob.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AuditActionGroup

Especifique um ou mais grupos de ações de auditoria. Esse parâmetro só é aplicável à auditoria de Blob.

Tipo:AuditActionGroups[]
Valores aceitos:BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, 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, AUDIT_CHANGE_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AuditType

Tipo:AuditType
Valores aceitos:NotSet, Table, Blob
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DatabaseName

Especifica o nome do banco de dados.

Tipo:String
Cargo:2
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EventType

Especifica os tipos de evento a serem auditados. Este parâmetro só é aplicável à auditoria de tabela. Você pode especificar vários tipos de eventos. Você pode especificar Todos para auditar todos os tipos de eventos ou Nenhum para especificar que nenhum evento será auditado. Se você especificar All ou None ao mesmo tempo, o cmdlet não será executado.

Tipo:String[]
Valores aceitos:PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure, StoredProcedure_Success, StoredProcedure_Failure, Login_Success, Login_Failure, TransactionManagement_Success, TransactionManagement_Failure, All, None
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

Retorna um objeto que representa o item com que você está trabalhando. Por padrão, este cmdlet não gera saída.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Especifica o nome do grupo de recursos ao qual o banco de dados está atribuído.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-RetentionInDays

Especifica o número de dias de retenção para a tabela de logs de auditoria. Um valor de zero (0) significa que a tabela não é mantida. O valor padrão é zero. Se você especificar um valor maior que zero, deverá especificar um valor para o parâmetro TableIdentifer .

Tipo:Nullable<T>[UInt32]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ServerName

Especifica o nome do servidor que hospeda o banco de dados.

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageAccountName

Especifica o nome da conta de armazenamento para auditar o banco de dados. Caracteres curinga não são permitidos. Esse parâmetro não é necessário. Se você não especificar esse parâmetro, o cmdlet usará a conta de armazenamento definida anteriormente como parte da política de auditoria do banco de dados. Se esta for a primeira vez que uma política de auditoria de banco de dados é definida e você não especificar esse parâmetro, o cmdlet falhará.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageKeyType

Especifica quais das chaves de acesso de armazenamento devem ser usadas. Os valores aceitáveis para esse parâmetro são:

  • Primária
  • Secundário O valor padrão é Primário.
Tipo:String
Valores aceitos:Primary, Secondary
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TableIdentifier

Especifica o nome da tabela de logs de auditoria. Especifique esse valor se você especificar um valor maior que zero para o parâmetro RetentionInDays .

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

AuditType

AuditActionGroups[]

String[]

String

Nullable<T>[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Saídas

AuditingPolicyModel