Compartilhar via

Set-UnifiedAuditLogRetentionPolicy

Módulo:
Exchange PowerShell

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..

Utilize o cmdlet Set-UnifiedAuditLogRetentionPolicy para modificar as políticas de retenção do registo de auditoria no portal do 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 (Padrão) 

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 registos de auditoria são utilizadas para especificar uma duração de retenção para os registos de auditoria para os quais são gerados pela atividade de administrador e utilizador. Uma política de retenção de registo 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 realizadas ou nos utilizadores que realizaram 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, veja 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 registo AeD (para eventos Premium de Deteção de Dados Eletrónicos) à política. Também configura que a política é aplicada apenas aos registos de auditoria para atividades realizadas apenas pelo utilizador 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 registo 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 utilizadores.

Parâmetros

-Confirm

Aplicável: Conformidade do & de Segurança

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, 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 confirmar 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: Conformidade do & de Segurança

O parâmetro Description especifica uma descrição para a política de retenção do registo 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: Conformidade do & de Segurança

O parâmetro Identidade especifica a política de retenção de registos de auditoria unificada que pretende 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: Conformidade do & de Segurança

O parâmetro Operações especifica as operações de registo de auditoria que são mantidas pela política. Os valores que especificar substituem todas as entradas existentes. Para obter uma lista dos valores disponíveis para este parâmetro, veja 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: Conformidade do & de Segurança

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

Este parâmetro é necessário quando modifica uma política de retenção de registo de auditoria e tem de utilizar 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: Conformidade do & de Segurança

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

Vários valores, separados por vírgulas, podem ser especificados. Os valores que especificar substituem todas as 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: Conformidade do & de Segurança

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

  • TrêsMonths
  • SixMonths
  • Nove Meses
  • Doze Meses
  • Dez Anos

Este parâmetro é necessário ao modificar uma política de retenção de registos 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: Conformidade do & de Segurança

O parâmetro UserIds especifica os registos de auditoria retidos pela política com base no ID do utilizador que efetuou a ação. Os valores que especificar substituem todas as 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: Conformidade do & de Segurança

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 suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.