Set-AppRetentionCompliancePolicy

Sintaxe

Identity (Padrão)

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

O parâmetro AddAdaptiveScopeLocation especifica a localização do âmbito adaptável a adicionar à política. Pode criar âmbitos ajustáveis com o cmdlet New-AdaptiveScope. Pode utilizar qualquer valor que identifique exclusivamente o âmbito 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: Conformidade do & de Segurança

O parâmetro AddExchangeLocation especifica as caixas de correio a adicionar à lista de caixas de correio incluídas quando não estiver a utilizar 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: Conformidade do & de Segurança

O parâmetro AddExchangeLocationException especifica as caixas de correio a adicionar à lista de caixas de correio excluídas quando estiver a utilizar o valor Tudo 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: Conformidade do & de Segurança

O parâmetro AddModernGroupLocation especifica o Grupos do Microsoft 365 a adicionar à lista de Grupos do Microsoft 365 incluídos quando não estiver a utilizar o valor All para o parâmetro ModernGroupLocation.

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

O parâmetro AddModernGroupLocationException especifica o Grupos do Microsoft 365 a adicionar à lista de Grupos do Microsoft 365 excluídos quando estiver a utilizar o valor All para o parâmetro ModernGroupLocation.

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

O parâmetro Aplicações especifica as aplicações a incluir na política.

Este parâmetro utiliza a seguinte sintaxe: : "LocationType:App1,LocationType:App2,...LocationType:AppN

LocationType é Utilizador ou Grupo.

App é um valor suportado, conforme mostrado nos exemplos seguintes.

• Aplicações do Microsoft 365: por exemplo:

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

• Microsoft Copilot experiências: atualmente em Pré-visualização. Tem de utilizar todos os seguintes valores ao mesmo tempo:

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

  Nota: apesar de ter de utilizar CopilotinBusinessApplicationplatformsSales e SQLCopilot, esses valores são atualmente irrelevantes.

• Aplicações de IA empresariais: atualmente em Pré-visualização. Tem de utilizar todos os seguintes valores ao mesmo tempo:

  "User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"

• Outras aplicações de IA: atualmente em Pré-visualização. Tem de utilizar todos os seguintes valores ao mesmo tempo:

  "User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"

Propriedades do parâmetro

Conjuntos de parâmetros

-Comment

Aplicável: Conformidade do & de Segurança

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

Conjuntos de parâmetros

-DeletedResources

Aplicável: Conformidade do & de Segurança

O parâmetro DeletedResources especifica a caixa de correio eliminada ou o utilizador de correio a adicionar como uma exclusão à respetiva lista de localizações. Utilize este parâmetro com o parâmetro AddTeamsChatLocationException para caixas de correio eliminadas ou utilizadores de correio que precisam de ser excluídos de uma política de retenção apenas do Teams.

Um valor válido é uma cadeia JSON. Veja a secção Exemplos para obter exemplos de sintaxe e utilização deste parâmetro.

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

ATENÇÃO: este parâmetro utiliza o endereço SMTP da caixa de correio ou utilizador de correio eliminado, que também pode ser especificado para outras caixas de correio ou utilizadores de correio. Se utilizar este parâmetro sem primeiro seguir passos adicionais, outras caixas de correio e utilizadores de correio com o mesmo endereço SMTP na política de retenção também serão excluídos. Para marcar para caixas de correio ou utilizadores de correio adicionais com o mesmo endereço SMTP, utilize o seguinte comando 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 utilizadores de correio com o mesmo endereço SMTP sejam excluídos, coloque a caixa de correio em Suspensão de Litígios antes de executar o comando com o parâmetro DeletedResources.

Propriedades do parâmetro

Conjuntos de parâmetros

-Enabled

Aplicável: Conformidade do & de Segurança

O parâmetro Ativado ativa ou desativa a política. Os valores válidos são:

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

Propriedades do parâmetro

Conjuntos de parâmetros

-Force

Aplicável: Conformidade do & de Segurança

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

O parâmetro Identidade especifica a política de conformidade de retenção de aplicações 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

Conjuntos de parâmetros

-PolicyRBACScopes

Aplicável: Conformidade do & de Segurança

Nota: Administração unidades não são atualmente suportadas, pelo que este parâmetro não está funcional. As informações aqui apresentadas destinam-se a fins informativos quando o suporte para unidades de administração é lançado.

O parâmetro PolicyRBACScopes especifica as unidades administrativas a atribuir à 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 só estão disponíveis no Microsoft Entra ID P1 ou P2. Pode criar e gerir unidades administrativas no Microsoft Graph PowerShell.

Propriedades do parâmetro

Conjuntos de parâmetros

-RemoveAdaptiveScopeLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveAdaptiveScopeLocation especifica a localização do âmbito adaptável a remover da política. Pode criar âmbitos ajustáveis com o cmdlet New-AdaptiveScope. Pode utilizar qualquer valor que identifique exclusivamente o âmbito 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: Conformidade do & de Segurança

O parâmetro RemoveExchangeLocation especifica as caixas de correio a remover da lista de caixas de correio incluídas quando não estiver a utilizar o valor Tudo 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: Conformidade do & de Segurança

O parâmetro RemoveExchangeLocationException especifica as caixas de correio a remover da lista de caixas de correio excluídas quando utiliza o valor Tudo 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: Conformidade do & de Segurança

O parâmetro RemoveModernGroupLocation especifica o Grupos do Microsoft 365 a remover da lista de grupos incluídos quando não estiver a utilizar o valor All para o parâmetro ModernGroupLocation.

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

O parâmetro RemoveModernGroupLocationException especifica o Grupos do Microsoft 365 a remover da lista de grupos excluídos quando estiver a utilizar o valor All para o parâmetro ModernGroupLocation.

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

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

• $true: O Bloqueio de Preservação está ativado 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á ativado para a política. Este valor é a predefinição.

Depois de bloquear uma política, ninguém pode desativá-la ou desativá-la ou remover aplicações da política. As únicas formas de modificar a política são ao adicionar aplicações à mesma ou ao prolongar a duração. Uma política bloqueada pode ser aumentada ou expandida, mas não pode ser reduzida, desativada ou desativada.

Por conseguinte, antes de bloquear uma política, é fundamental que compreenda os requisitos de conformidade da sua organização e que não bloqueie uma política até ter a certeza de que é o que precisa.

Propriedades do parâmetro

Conjuntos de parâmetros

-RetryDistribution

Aplicável: Conformidade do & de Segurança

O comutador RetryDistribution especifica se pretende redistribuir a política para todas as localizações. 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.

Nota: uma vez que o processo de repetição da distribuição é uma operação significativa, execute-a apenas se necessário e para uma política de cada vez. Não se destina a ser executado sempre que atualizar uma política. Se 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 política seguinte.

Propriedades do parâmetro

Conjuntos de parâmetros

-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

Conjuntos de parâmetros

CommonParameters