Set-AppRetentionCompliancePolicy

Sintaxe

Identity (Default)

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddExchangeLocation <MultiValuedProperty>]
    [-AddExchangeLocationException <MultiValuedProperty>]
    [-AddModernGroupLocation <MultiValuedProperty>]
    [-AddModernGroupLocationException <MultiValuedProperty>]
    [-Applications <String[]>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-Force]
    [-PolicyRBACScopes <MultiValuedProperty>]
    [-RemoveExchangeLocation <MultiValuedProperty>]
    [-RemoveExchangeLocationException <MultiValuedProperty>]
    [-RemoveModernGroupLocation <MultiValuedProperty>]
    [-RemoveModernGroupLocationException <MultiValuedProperty>]
    [-RestrictiveRetention <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

AdaptiveScopeLocation

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddAdaptiveScopeLocation <MultiValuedProperty>]
    [-Applications <String[]>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-Force]
    [-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
    [-WhatIf]
    [<CommonParameters>]

DisableRestrictiveRetentionParameterSet

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-DeletedResources <String>]
    [-WhatIf]
    [<CommonParameters>]

InformationBarrierDefault

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-DeletedResources <String>]
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

OrganizationSegmentsDefault

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-DeletedResources <String>]
    [-WhatIf]
    [<CommonParameters>]

RetryDistributionParameterSet

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Confirm]
    [-RetryDistribution]
    [-WhatIf]
    [<CommonParameters>]

TeamLocation

Set-AppRetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

Description

Exemplos

Exemplo 1

Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,VivaEngage" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21"

Exemplo 2

$stringJson = @"
[{
     'EmailAddress': 'SalesUser@contoso.onmicrosoft.com'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Policy" -AddExchangeLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson

Exemplo 3

$stringJson = @"
[{
     'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com'
},
{
     'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com'
}]
"@
Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson

Parâmetros

-AddAdaptiveScopeLocation

Aplicável: Segurança & Conformidade

O parâmetro AddAdaptiveScopeLocation especifica o local do escopo adaptável a ser adicionado à política. Você cria escopos adaptáveis usando o cmdlet New-AdaptiveScope. Você pode usar qualquer valor que identifique exclusivamente o escopo adaptável. Por exemplo:

• Nome
• DN (nome diferenciado)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-AddExchangeLocation

Aplicável: Segurança & Conformidade

O parâmetro AddExchangeLocation especifica as caixas de correio a serem adicionadas à lista de caixas de correio incluídas quando você não estiver usando o valor All para o parâmetro ExchangeLocation. Os valores válidos são:

• O parâmetro ExchangeLocation especifica as caixas de correio que devem ser incluídas na política. Os valores válidos são:
• Uma caixa de correio

O valor All para todas as caixas de correio. Você só pode usar esse valor sozinho.

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-AddExchangeLocationException

Aplicável: Segurança & Conformidade

O parâmetro AddExchangeLocationException especifica as caixas de correio a serem adicionadas à lista de caixas de correio excluídas quando você estiver usando o valor All para o parâmetro ExchangeLocation. Os valores válidos são:

• Este parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:
• Uma caixa de correio

O valor All para todas as caixas de correio. Você só pode usar esse valor sozinho.

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-AddModernGroupLocation

Aplicável: Segurança & Conformidade

O parâmetro AddModernGroupLocation especifica os Grupos do Microsoft 365 a serem adicionados à lista de Grupos do Microsoft 365 incluídos quando você não estiver usando o valor Todos para o parâmetro ModernGroupLocation.

Você pode usar qualquer valor que identifique exclusivamente o Grupo do Microsoft 365. Por exemplo:

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-AddModernGroupLocationException

Aplicável: Segurança & Conformidade

O parâmetro AddModernGroupLocationException especifica os Grupos do Microsoft 365 a serem adicionados à lista de Grupos do Microsoft 365 excluídos quando você estiver usando o valor Todos para o parâmetro ModernGroupLocation.

Você pode usar qualquer valor que identifique exclusivamente o Grupo do Microsoft 365. Por exemplo:

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-Applications

Aplicável: Segurança & Conformidade

O parâmetro Applications especifica os aplicativos a serem incluídos na política.

Esse parâmetro usa a seguinte sintaxe: "LocationType:App1,LocationType:App2,...LocationType:AppN:

LocationType é Usuário ou Grupo.

App é um valor com suporte, conforme mostrado nos exemplos a seguir.

• Aplicativos do Microsoft 365: Por exemplo:

  "User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint" ou "User:MicrosoftTeams","User:VivaEngage"

• Experiências do Microsoft Copilot: atualmente em versão prévia. Você deve usar todos os seguintes valores ao mesmo tempo:

  "User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"

  Observação: mesmo que você deva usar CopilotinBusinessApplicationplatformsSales e SQLCopilot, esses valores são irrelevantes no momento.

• Aplicativos corporativos de IA: atualmente em versão prévia. Você deve usar todos os seguintes valores ao mesmo tempo:

  "User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"

• Outros aplicativos de IA: atualmente em versão prévia. Você deve usar todos os seguintes valores ao mesmo tempo:

  "User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"

Propriedades do parâmetro

Conjuntos de parâmetros

-Comment

Aplicável: Segurança & Conformidade

O parâmetro Comment especifica um comentário opcional. Se você especificar um valor que contenha espaços, coloque-o entre aspas ("), por exemplo: “Está é uma observação de administrador”.

Propriedades do parâmetro

Conjuntos de 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

Conjuntos de parâmetros

-DeletedResources

Aplicável: Segurança & Conformidade

O parâmetro DeletedResources especifica a caixa de correio ou o usuário de email excluído a ser adicionado como uma exclusão à respectiva lista de locais. Use esse parâmetro com o parâmetro AddTeamsChatLocationException para caixas de correio excluídas ou usuários de email que precisam ser excluídos de uma política de retenção somente do Teams.

Um valor válido é uma cadeia de caracteres JSON. Consulte a seção Exemplos para obter exemplos de sintaxe e uso desse parâmetro.

Para obter informações sobre o cenário de caixa de correio inativa, consulte Saiba mais sobre caixas de correio inativas.

CUIDADO: esse parâmetro usa o endereço SMTP da caixa de correio ou do usuário de email excluído, que também pode ser especificado para outras caixas de correio ou usuários de email. Se você usar esse parâmetro sem primeiro executar etapas adicionais, outras caixas de correio e usuários de email com o mesmo endereço SMTP na política de retenção também serão excluídos. Para marcar se há caixas de correio adicionais ou usuários de email com o mesmo endereço SMTP, use o comando a seguir e substitua user@contoso.com pelo endereço SMTP para marcar:Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted

Para impedir que caixas de correio ativas ou usuários de email com o mesmo endereço SMTP sejam excluídos, coloque a caixa de correio em Retenção de Litígio antes de executar o comando com o parâmetro DeletedResources.

Propriedades do parâmetro

Conjuntos de parâmetros

-Enabled

Aplicável: Segurança & Conformidade

O parâmetro Enabled habilita ou desabilita a política. Os valores válidos são:

• $true: a política está habilitada. Esse valor é o padrão.
• $true: a política está habilitada. Esse é o valor padrão.

Propriedades do parâmetro

Conjuntos de parâmetros

-Force

Aplicável: Segurança & Conformidade

A opção Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.

Você pode usar essa opção para executar tarefas de modo programático onde a solicitação por entrada administrativa é inadequada.

Propriedades do parâmetro

Conjuntos de parâmetros

-Identity

Aplicável: Segurança & Conformidade

O parâmetro Identity especifica a política de conformidade de retenção de aplicativo 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

Conjuntos de parâmetros

-PolicyRBACScopes

Aplicável: Segurança & Conformidade

Observação: as unidades de Administração não são compatíveis no momento, portanto, este parâmetro não é funcional. As informações apresentadas aqui são para fins informativos quando o suporte para unidades administrativas é lançado.

O parâmetro PolicyRBACScopes especifica as unidades administrativas a serem atribuídas à política. Um valor válido é o Microsoft Entra ObjectID (valor GUID) da unidade administrativa. Vários valores, separados por vírgulas, podem ser especificados.

As unidades administrativas estão disponíveis somente no Microsoft Entra ID P1 ou P2. Você cria e gerencia unidades administrativas no Microsoft Graph PowerShell.

Propriedades do parâmetro

Conjuntos de parâmetros

-RemoveAdaptiveScopeLocation

Aplicável: Segurança & Conformidade

O parâmetro RemoveAdaptiveScopeLocation especifica o local do escopo adaptável a ser removido da política. Você cria escopos adaptáveis usando o cmdlet New-AdaptiveScope. Você pode usar qualquer valor que identifique exclusivamente o escopo adaptável. Por exemplo:

• Nome
• DN (nome diferenciado)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-RemoveExchangeLocation

Aplicável: Segurança & Conformidade

O parâmetro RemoveExchangeLocation especifica as caixas de correio a serem removidas da lista de caixas de correio incluídas quando você não estiver usando o valor All para o parâmetro ExchangeLocation. Os valores válidos são:

• Este parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:
• Uma caixa de correio

O valor All para todas as caixas de correio. Você só pode usar esse valor sozinho.

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-RemoveExchangeLocationException

Aplicável: Segurança & Conformidade

O parâmetro RemoveExchangeLocationException especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:

• Este parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:
• Uma caixa de correio

O valor All para todas as caixas de correio. Você só pode usar esse valor sozinho.

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-RemoveModernGroupLocation

Aplicável: Segurança & Conformidade

O parâmetro RemoveModernGroupLocation especifica os Grupos do Microsoft 365 a serem removidos da lista de grupos incluídos quando você não estiver usando o valor All para o parâmetro ModernGroupLocation.

Você pode usar qualquer valor que identifique exclusivamente o Grupo do Microsoft 365. Por exemplo:

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-RemoveModernGroupLocationException

Aplicável: Segurança & Conformidade

O parâmetro RemoveModernGroupLocationException especifica os Grupos do Microsoft 365 a serem removidos da lista de grupos excluídos quando você estiver usando o valor All para o parâmetro ModernGroupLocation.

Você pode usar qualquer valor que identifique exclusivamente o Grupo do Microsoft 365. Por exemplo:

• Nome
• Nome
• Nome diferenciado (DN)
• GUID

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

Propriedades do parâmetro

Conjuntos de parâmetros

-RestrictiveRetention

Aplicável: Segurança & Conformidade

O parâmetro RestrictiveRetention especifica se o Bloqueio de Preservação está habilitado para a política. Os valores válidos são:

• $true: O Bloqueio de Preservação está habilitado para a política. Ninguém, incluindo um administrador, pode desativar a política ou torná-la menos restritiva.
• $false: o Bloqueio de Preservação não está habilitado para a política. Esse valor é o padrão.

Depois que uma política é bloqueada, ninguém pode desativá-la ou desabilitá-la ou remover aplicativos da política. As únicas maneiras de modificar a política são adicionando aplicativos a ela ou estendendo sua duração. Uma política bloqueada pode ser aumentada ou estendida, mas não pode ser reduzida, desabilitada ou desativada.

Portanto, antes de bloquear uma política, é fundamental que você entenda os requisitos de conformidade da sua organização e que não bloqueie uma política até ter certeza de que é o que precisa.

Propriedades do parâmetro

Conjuntos de parâmetros

-RetryDistribution

Aplicável: Segurança & Conformidade

A opção RetryDistribution especifica se a política deve ser redistribuída para todos os locais. Não é preciso especificar um valor com essa opção.

Locais cujas distribuições iniciais tenham êxito não são incluídos na repetição. Ao usar essa opção, os erros de distribuição de política são relatados.

Observação: como o processo de repetir a distribuição é uma operação significativa, execute-a somente se necessário e para uma política por vez. Ele não se destina a ser executado sempre que você atualizar uma política. Se você executar um script para atualizar várias políticas, aguarde até que a distribuição da política seja bem-sucedida antes de executar o comando novamente para a próxima política.

Propriedades do parâmetro

Conjuntos de parâmetros

-WhatIf

Aplicável: Segurança & Conformidade

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

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters