Set-UnifiedAuditLogRetentionPolicy

Este cmdlet está disponível apenas no PowerShell de Segurança e Conformidade. Para obter mais informações, consulte PowerShell de Segurança e Conformidade..

Use o cmdlet Set-UnifiedAuditLogRetentionPolicy para modificar as políticas de retenção de log de auditoria no portal Microsoft 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.

Sintaxe

Default (Default)

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 gerados pela atividade do administrador e do usuário. Uma política de retenção de log de auditoria pode especificar a duração da retenção com base no tipo de atividades auditadas, no serviço do Microsoft 365 em que 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 este cmdlet no PowerShell de Segurança e Conformidade, você precisa receber permissões. Para obter mais informações, confira Permissões no portal do Microsoft 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 AeD (para eventos Premium de Descoberta Eletrônica) à política. Ele também configura que a política seja aplicada somente aos logs de auditoria para atividades executadas somente 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 Operations e remove todos os valores da propriedade UserId para que a política se aplique a todos os usuários.

Parâmetros

-Confirm

Aplicável: Segurança & Conformidade

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, 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 reconhecer o comando antes de continuar.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Description

Aplicável: Segurança & Conformidade

O parâmetro Descrição 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 (").

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Identity

Aplicável: Segurança & Conformidade

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

  • Nome
  • DN (nome diferenciado)
  • GUID

Propriedades do parâmetro

Tipo:PolicyIdParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Operations

Aplicável: Segurança & Conformidade

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

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

Propriedades do parâmetro

Tipo:MultiValuedProperty
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Priority

Aplicável: Segurança & Conformidade

O parâmetro Priority especifica um valor de prioridade para a política que determina a ordem de processamento da política. Um valor inteiro mais alto indica uma prioridade mais baixa. O valor 1 é a prioridade mais alta e o valor 10000 é a prioridade mais baixa. Duas políticas não podem 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 deve usar um valor de prioridade exclusivo.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RecordTypes

Aplicável: Segurança & Conformidade

O parâmetro RecordTypes especifica os logs de auditoria de um tipo de registro específico que são retidos 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 substituem quaisquer entradas existentes.

Propriedades do parâmetro

Tipo:MultiValuedProperty
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RetentionDuration

Aplicável: Segurança & Conformidade

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

  • Três Meses
  • SixMonths
  • Nove Meses
  • Doze Meses
  • Dez anos

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

Propriedades do parâmetro

Tipo:UnifiedAuditLogRetentionDuration
Valor padrão:None
Valores aceitos:ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UserIds

Aplicável: Segurança & Conformidade

O parâmetro UserIds especifica os logs de auditoria que são retidos pela política com base na ID do usuário que executou a ação. Os valores especificados substituem quaisquer entradas existentes.

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

Propriedades do parâmetro

Tipo:MultiValuedProperty
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Aplicável: Segurança & Conformidade

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.