Set-UnifiedAuditLogRetentionPolicy

Esse cmdlet está disponível apenas no PowerShell de Conformidade de Segurança & . Para obter mais informações, confira PowerShell de Conformidade de Segurança&.

Use o cmdlet Set-UnifiedAuditLogRetentionPolicy para modificar políticas de retenção de log de auditoria no portal Microsoft 365 Defender ou no portal de conformidade do Microsoft Purview.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

Set-UnifiedAuditLogRetentionPolicy
   [-Identity] <PolicyIdParameter>
   -Priority <Int32>
   -RetentionDuration <UnifiedAuditLogRetentionDuration>
   [-Confirm]
   [-Description <String>]
   [-Operations <MultiValuedProperty>]
   [-RecordTypes <MultiValuedProperty>]
   [-UserIds <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

Description

As políticas de retenção de log de auditoria são usadas para especificar uma duração de retenção para logs de auditoria que são gerados por atividades de administrador e usuário. Uma política de retenção de log de auditoria pode especificar a duração de retenção com base no tipo de atividades auditadas, no serviço Microsoft 365 no qual as atividades são executadas ou nos usuários que executaram as atividades. Para saber mais, confira Gerenciar políticas de retenção de log de auditoria.

Para usar esse cmdlet no PowerShell de Conformidade de Segurança & , você precisa receber permissões. Para obter mais informações, consulte Permissões no portal de Microsoft 365 Defender ou Permissões no portal de conformidade do Microsoft Purview.

Exemplos

Exemplo 1

Set-UnifiedAuditLogRetentionPolicy -Identity "eDiscovery audit retention" -RecordTypes Discovery,AeD -UserIds admin@contoso.onmicrosoft.com -RetentionDuration SixMonths -Priority 100

Este exemplo adiciona o tipo de registro do AeD (para eventos premium de descoberta eletrônica) à política. Ele também configura que a política é aplicada somente aos logs de auditoria para atividades executadas apenas pelo usuário admin@contoso.onmicrosoft.com.

Exemplo 2

Set-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Operations SearchQueryPerformed,FileAccessed -UserIds $null -RetentionDuration SixMonths -Priority 10000

Este exemplo modifica uma política de retenção de log de auditoria e altera a duração da retenção para seis meses, adiciona uma atividade adicional ao parâmetro Operações e remove todos os valores da propriedade UserId para que a política se aplique a todos os usuários.

Parâmetros

-Confirm

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o comando antes de continuar.
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Description

O parâmetro Description especifica uma descrição para a política de retenção de log de auditoria. O comprimento máximo é de 256 caracteres. Se o valor contiver espaços, coloque-o entre aspas (").

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Identity

O parâmetro Identity especifica a política de retenção de log de auditoria unificada que você deseja modificar. É possível usar qualquer valor que identifique a política com exclusividade. Por exemplo:

  • Nome
  • Nome distingished (DN)
  • GUID
Type:PolicyIdParameter
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Security & Compliance

-Operations

O parâmetro Operações especifica as operações de log de auditoria que são retidas pela política. Os valores especificados por você substituirão quaisquer entradas existentes. Para obter uma lista dos valores disponíveis para este parâmetro, consulte Atividades auditadas.

Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Priority

O parâmetro Priority especifica um valor de prioridade para a política que determina a ordem de processamento de política. Um valor inteiro mais alto indica uma prioridade menor. O valor 1 é a prioridade mais alta e o valor 10000 é a prioridade mais baixa. Nenhuma política pode ter o mesmo valor de prioridade.

Esse parâmetro é necessário quando você modifica uma política de retenção de log de auditoria e você deve usar um valor de prioridade exclusivo.

Type:Int32
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RecordTypes

O parâmetro RecordTypes especifica os logs de auditoria de um tipo de registro específico que são mantidos pela política. Para obter detalhes sobre os valores disponíveis, consulte AuditLogRecordType.

Vários valores, separados por vírgulas, podem ser especificados. Os valores especificados por você substituirão quaisquer entradas existentes.

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-RetentionDuration

O parâmetro RetentionDuration especifica quanto tempo os registros de log de auditoria são mantidos. Os valores válidos são:

  • ThreeMonths
  • SixMonths
  • NineMonths
  • TwelveMonths
  • TenYears

Esse parâmetro é necessário ao modificar uma política de retenção de log de auditoria.

Type:UnifiedAuditLogRetentionDuration
Accepted values:ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-UserIds

O parâmetro UserIds especifica os logs de auditoria que são mantidos pela política com base na ID do usuário que realizou a ação. Os valores especificados por você substituirão quaisquer entradas existentes.

Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

A opção WhatIf não funciona no PowerShell de Conformidade de Segurança & .

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance