Set-AzureRmSqlDatabaseAuditingPolicy

Define a política de auditoria para uma base de dados.

Aviso

O módulo AzureRM PowerShell 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 Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Syntax

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 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 devem ser auditados. 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 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 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 descrevendo 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. Esse cmdlet também é suportado pelo serviço SQL Server Stretch Database no Azure.

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"

Este 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

Este 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

Este comando define a política de auditoria do banco de dados chamado Database01 localizado no 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. Este parâmetro só é aplicável à auditoria de Blob.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AuditActionGroup

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

Type:AuditActionGroups[]
Accepted values: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
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AuditType

Type:AuditType
Accepted values:NotSet, Table, Blob
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DatabaseName

Especifica o nome do banco de dados.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventType

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

Type:String[]
Accepted values:PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure, StoredProcedure_Success, StoredProcedure_Failure, Login_Success, Login_Failure, TransactionManagement_Success, TransactionManagement_Failure, All, None
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RetentionInDays

Especifica o número de dias de retenção para a tabela de logs de auditoria. Um valor 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 .

Type:Nullable<T>[UInt32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountName

Especifica o nome da conta de armazenamento para auditar o banco de dados. Caracteres curinga não são permitidos. Este 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 for definida e você não especificar esse parâmetro, o cmdlet falhará.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageKeyType

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

  • Primário
  • Secundário O valor padrão é Primário.
Type:String
Accepted values:Primary, Secondary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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 .

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

AuditType

AuditActionGroups[]

String[]

String

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

Saídas

AuditingPolicyModel