Partilhar via


Set-RetentionCompliancePolicy

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-RetentionCompliancePolicy para modificar as políticas de retenção existentes no portal de conformidade do Microsoft Purview.

Nota: a execução deste cmdlet causa uma sincronização completa na sua organização, o que é uma operação significativa. Se precisar de atualizar várias políticas, aguarde até que a distribuição da política seja bem-sucedida antes de executar o cmdlet novamente para a política seguinte. Para obter informações sobre o status de distribuição, veja Get-RetentionCompliancePolicy.

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

Sintaxe

Identity

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddExchangeLocation <MultiValuedProperty>]
    [-AddExchangeLocationException <MultiValuedProperty>]
    [-AddModernGroupLocation <MultiValuedProperty>]
    [-AddModernGroupLocationException <MultiValuedProperty>]
    [-AddOneDriveLocation <MultiValuedProperty>]
    [-AddOneDriveLocationException <MultiValuedProperty>]
    [-AddPublicFolderLocation <MultiValuedProperty>]
    [-AddSharePointLocation <MultiValuedProperty>]
    [-AddSharePointLocationException <MultiValuedProperty>]
    [-AddSkypeLocation <MultiValuedProperty>]
    [-AddSkypeLocationException <MultiValuedProperty>]
    [-Applications <MultiValuedProperty>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-EnforceSimulationPolicy <Boolean>]
    [-Force]
    [-PolicyTemplateInfo <PswsHashtable>]
    [-PolicyRBACScopes <MultiValuedProperty>]
    [-PriorityCleanup]
    [-RemoveExchangeLocation <MultiValuedProperty>]
    [-RemoveExchangeLocationException <MultiValuedProperty>]
    [-RemoveModernGroupLocation <MultiValuedProperty>]
    [-RemoveModernGroupLocationException <MultiValuedProperty>]
    [-RemoveOneDriveLocation <MultiValuedProperty>]
    [-RemoveOneDriveLocationException <MultiValuedProperty>]
    [-RemovePublicFolderLocation <MultiValuedProperty>]
    [-RemoveSharePointLocation <MultiValuedProperty>]
    [-RemoveSharePointLocationException <MultiValuedProperty>]
    [-RemoveSkypeLocation <MultiValuedProperty>]
    [-RemoveSkypeLocationException <MultiValuedProperty>]
    [-RestrictiveRetention <Boolean>]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

AdaptiveScopeLocation

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

RetryDistribution

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-RetryDistribution]
    [-Confirm]
    [-DeletedResources <String>]
    [-EnforceSimulationPolicy <Boolean>]
    [-PriorityCleanup]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

TeamLocation

Set-RetentionCompliancePolicy
    [-Identity] <PolicyIdParameter>
    [-AddTeamsChannelLocation <MultiValuedProperty>]
    [-AddTeamsChannelLocationException <MultiValuedProperty>]
    [-AddTeamsChatLocation <MultiValuedProperty>]
    [-AddTeamsChatLocationException <MultiValuedProperty>]
    [-Comment <String>]
    [-Confirm]
    [-DeletedResources <String>]
    [-Enabled <Boolean>]
    [-EnforceSimulationPolicy <Boolean>]
    [-Force]
    [-PriorityCleanup]
    [-RemoveTeamsChannelLocation <MultiValuedProperty>]
    [-RemoveTeamsChannelLocationException <MultiValuedProperty>]
    [-RemoveTeamsChatLocation <MultiValuedProperty>]
    [-RemoveTeamsChatLocationException <MultiValuedProperty>]
    [-StartSimulation <Boolean>]
    [-WhatIf]
    [<CommonParameters>]

Description

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 de conformidade do Microsoft Purview.

Nota: não utilize um comando Foreach-Object canalizado ao adicionar ou remover localizações de âmbito: "Value1","Value2",..."ValueN" | Foreach-Object {Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}.

Exemplos

Exemplo 1

Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14"

Este exemplo faz as seguintes alterações na política de retenção existente chamada "Regulamentação de conformidade 123":

  • Adiciona a caixa de correio para a usuária Brenda Fernandes.
  • Adiciona o site https://contoso.sharepoint.com/sites/teams/financedo SharePoint .
  • Remove as pastas públicas.
  • Atualiza o comentário.

Exemplo 2

$stringJson = @"
[{
     'EmailAddress': 'USSales@contoso.onmicrosoft.com',
     'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b'
}]
"@

Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson

O exemplo remove o Grupo do Microsoft 365 e o site eliminados especificados da política especificada. Identifica os recursos eliminados com o endereço de e-mail do Grupo do Microsoft 365 e o ID do site relacionado.

IMPORTANTE: antes de executar este comando, certifique-se de que lê as informações de Atenção para o parâmetro DeletedResources sobre endereços SMTP duplicados.

Exemplo 3

$stringJson = @"
[{
     'EmailAddress': 'USSales@contoso.onmicrosoft.com',
     'SiteId': '8b2a8345-b9ec-3b6a-bf31-6eaa83697c4b'
}]
"@

Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLocationException "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson

O exemplo exclui o Grupo e o site do Microsoft 365 eliminados especificados da política de nível de inquilino especificada. Identifica os recursos eliminados com o endereço de e-mail do Grupo do Microsoft 365 e o ID do site relacionado.

IMPORTANTE: antes de executar este comando, certifique-se de que lê as informações de Atenção para o parâmetro DeletedResources sobre endereços SMTP duplicados.

Exemplo 4

$stringJson = @"
[{
     'EmailAddress': 'USSales2@contoso.onmicrosoft.com',
     'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b'
 },
{
     'EmailAddress': 'USSales2@contoso.onmicrosoft.com',
     'SiteId': '4afb7116-b9ec-4b2c-bf31-4abb83697c4b'
}]
"@

Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales2@contoso.onmicrosoft.com" -DeletedResources $stringJson

Este exemplo é semelhante ao Exemplo 2, exceto se forem especificados vários recursos eliminados.

IMPORTANTE: antes de executar este comando, certifique-se de que lê as informações de Atenção para o parâmetro DeletedResources sobre endereços SMTP duplicados.

Exemplo 5

$stringJson = @"
[{
     'EmailAddress': 'SalesUser@contoso.onmicrosoft.com'
}]
"@

Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson

Este exemplo exclui a caixa de correio ou o utilizador de correio eliminado de forma recuperável especificado da Política de Retenção do Teams mencionada. Pode identificar os recursos eliminados através da caixa de correio ou do endereço de e-mail do utilizador de correio.

IMPORTANTE: antes de executar este comando, certifique-se de que lê as informações de Atenção para o parâmetro DeletedResources sobre endereços SMTP duplicados.

Exemplo 6

$stringJson = @"
[{
     'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com'
},
{
     'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com'
}]
"@

Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson

Este exemplo é semelhante ao Exemplo 5, exceto se forem especificados vários recursos eliminados.

IMPORTANTE: antes de executar este comando, certifique-se de que lê as informações de Atenção para o parâmetro DeletedResources sobre endereços SMTP duplicados.

As exclusões de políticas têm de permanecer dentro dos limites suportados para as políticas de retenção: Limites para políticas de retenção do Microsoft 365 e políticas de etiquetas de retenção

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

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

Conjuntos de parâmetros

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

-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

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

Conjuntos de parâmetros

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

-AddExchangeLocationException

Aplicável: Conformidade do & de Segurança

Este parâmetro especifica as caixas de correio a adicionar à 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

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

Conjuntos de parâmetros

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

-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

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

Conjuntos de parâmetros

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

-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

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

Conjuntos de parâmetros

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

-AddOneDriveLocation

Aplicável: Conformidade do & de Segurança

O parâmetro AddOneDriveLocation especifica os sites do OneDrive a adicionar à lista de sites incluídos quando não estiver a utilizar o valor Tudo para o parâmetro OneDriveLocation. Você pode identificar o site pelo valor da URL.

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

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

-AddOneDriveLocationException

Aplicável: Conformidade do & de Segurança

Este parâmetro especifica os sites do OneDrive a adicionar à lista de sites excluídos quando utiliza o valor Tudo para o parâmetro OneDriveLocation. Você pode identificar o site pelo valor da URL.

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

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

-AddPublicFolderLocation

Aplicável: Conformidade do & de Segurança

O parâmetro AddPublicFolderLocation especifica que você deseja adicionar todas as pastas públicas à política de retenção. Use o valor All para esse parâmetro.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-AddSharePointLocation

Aplicável: Conformidade do & de Segurança

O parâmetro AddSharePointLocation especifica os sites do SharePoint a adicionar à lista de sites incluídos quando não estiver a utilizar o valor Tudo para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.

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

Os sites do SharePoint não podem ser adicionados à política até serem indexados.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-AddSharePointLocationException

Aplicável: Conformidade do & de Segurança

Este parâmetro especifica os sites do SharePoint a adicionar à lista de sites excluídos quando utiliza o valor Tudo para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.

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

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

-AddSkypeLocation

Aplicável: Conformidade do & de Segurança

O parâmetro AddSkypeLocation especifica o Skype for Business utilizadores online a adicionar a partir da lista de utilizadores incluídos Skype for Business Online.

É possível usar qualquer valor que identifique o usuário com exclusividade. 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

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

Conjuntos de parâmetros

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

-AddSkypeLocationException

Aplicável: Conformidade do & de Segurança

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-AddTeamsChannelLocation

Aplicável: Conformidade do & de Segurança

O parâmetro AddTeamsChannelLocation especifica o Teams a adicionar à política.

Pode utilizar qualquer valor que identifique exclusivamente a equipa. Por exemplo:

  • Nome
  • Endereço de email
  • GUID

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

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

-AddTeamsChannelLocationException

Aplicável: Conformidade do & de Segurança

O parâmetro AddTeamsChannelLocationException especifica o Teams a adicionar à lista de exclusão quando utiliza o valor Tudo para o parâmetro TeamsChannelLocation. Pode utilizar qualquer valor que identifique exclusivamente a equipa. Por exemplo:

  • Nome
  • Endereço de email
  • GUID

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

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

-AddTeamsChatLocation

Aplicável: Conformidade do & de Segurança

O parâmetro AddTeamsChatLocation especifica os utilizadores do Teams a adicionar à política.

É possível usar qualquer valor que identifique o usuário com exclusividade. 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

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

Conjuntos de parâmetros

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

-AddTeamsChatLocationException

Aplicável: Conformidade do & de Segurança

O parâmetro AddTeamsChatLocationException especifica os utilizadores do Teams a adicionar à lista de exclusão quando utiliza o valor All para o parâmetro TeamsChatLocation. É possível usar qualquer valor que identifique o usuário com exclusividade. Por exemplo:

  • Nome
  • Endereço de email
  • GUID

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

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

-Applications

Aplicável: Conformidade do & de Segurança

O parâmetro Aplicações especifica o destino quando Grupos do Microsoft 365 são incluídos na política (o parâmetro ModernGroups está definido). Os valores válidos são:

  • Group:Exchange para a caixa de correio que está ligada ao Grupo do Microsoft 365.
  • Group:SharePoint para o site do SharePoint que está ligado ao Grupo do Microsoft 365.
  • "Group:Exchange,SharePoint" tanto para a caixa de correio como para o site do SharePoint que estão ligados ao Grupo do Microsoft 365.
  • blank ($null): este valor é a predefinição e é funcionalmente equivalente ao valor "Group:Exchange,SharePoint". Para retornar ao valor padrão tanto da caixa postal como do site SharePoint para os grupos Microsoft 365 selecionados, especifique "Group:Exchange,SharePoint".

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-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

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

Conjuntos de parâmetros

Identity
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
TeamLocation
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-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

-DeletedResources

Aplicável: Conformidade do & de Segurança

O parâmetro DeletedResources especifica o Grupo do Microsoft 365 eliminado, a caixa de correio ou o utilizador de correio a ser removido ou adicionado como uma exclusão à respetiva lista de localizações. Utilize este parâmetro com os parâmetros AddModernGroupLocationException e RemoveModernGroupLocation para Grupos do Microsoft 365 eliminados ou com o parâmetro AddTeamsChatLocationException para caixas de correio ou utilizadores de correio eliminados.

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

ATENÇÃO: quando utiliza um endereço SMTP com este parâmetro, tenha em atenção que o mesmo endereço também pode estar a ser utilizado para outras caixas de correio ou utilizadores de correio. 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.

Para obter mais informações sobre o cenário de Grupo do Microsoft 365 eliminado, consulte Saiba mais sobre a eliminação moderna de grupos em retenção.

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

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Enabled

Aplicável: Conformidade do & de Segurança

O parâmetro Enabled especifica se a política está habilitada. 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

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

Conjuntos de parâmetros

Identity
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
TeamLocation
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-EnforceSimulationPolicy

Aplicável: Conformidade do & de Segurança

O parâmetro EnforceSimulationPolicy especifica se pretende impor uma política de simulação como uma política ativa. Os valores válidos são:

  • $true: impor a política de simulação como uma política ativa.
  • $false: não imponha a política de simulação como uma política ativa. Este valor é a predefinição.

Para obter mais informações sobre o modo de simulação, consulte Saiba sobre o modo de simulação.

Propriedades do parâmetro

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

-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

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

Conjuntos de parâmetros

Identity
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
TeamLocation
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 Identity especifica a política de retenção 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:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-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

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

Conjuntos de parâmetros

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

-PolicyTemplateInfo

Aplicável: Conformidade do & de Segurança

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-PriorityCleanup

Aplicável: Conformidade do & de Segurança

O comutador PriorityCleanup especifica se pretende atualizar uma política de limpeza de Prioridade. Não é preciso especificar um valor com essa opção.

As políticas de limpeza prioritárias aceleram a eliminação de conteúdo confidencial ao substituir quaisquer definições de retenção existentes ou retenções de Deteção de Dados Eletrónicos. Para obter mais informações, veja Limpeza da Prioridade.

Propriedades do parâmetro

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

-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

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

Conjuntos de parâmetros

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

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

É possível usar qualquer valor que identifique a caixa de correio exclusivamente. 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

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

Conjuntos de parâmetros

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

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

É possível usar qualquer valor que identifique a caixa de correio exclusivamente. 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

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

Conjuntos de parâmetros

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

-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

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

Conjuntos de parâmetros

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

-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

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

Conjuntos de parâmetros

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

-RemoveOneDriveLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveOneDriveLocation especifica os sites do OneDrive a remover da lista de sites incluídos quando não estiver a utilizar o valor Tudo para o parâmetro OneDriveLocation. Você pode identificar o site pelo valor da URL.

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

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

-RemoveOneDriveLocationException

Aplicável: Conformidade do & de Segurança

Este parâmetro especifica os sites do OneDrive a remover da lista de sites excluídos quando utiliza o valor Tudo para o parâmetro OneDriveLocation. Você pode identificar o site pelo valor da URL.

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

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

-RemovePublicFolderLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemovePublicFolderLocation especifica que você deseja remover todas as pastas públicas da política de retenção. Use o valor All para esse parâmetro.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-RemoveSharePointLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveSharePointLocation especifica os sites do SharePoint a remover da lista de sites incluídos quando não estiver a utilizar o valor Tudo para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.

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

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

-RemoveSharePointLocationException

Aplicável: Conformidade do & de Segurança

Este parâmetro especifica os sites do SharePoint a remover da lista de sites excluídos quando utiliza o valor Tudo para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.

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

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

-RemoveSkypeLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveSkypeLocation especifica o Skype for Business utilizadores online a remover da lista de utilizadores incluídos Skype for Business Online.

É possível usar qualquer valor que identifique o usuário com exclusividade. 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

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

Conjuntos de parâmetros

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

-RemoveSkypeLocationException

Aplicável: Conformidade do & de Segurança

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-RemoveTeamsChannelLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveTeamsChannelLocation especifica as Equipas a remover da política.

Pode utilizar qualquer valor que identifique exclusivamente a equipa. Por exemplo:

  • Nome
  • Endereço de email
  • GUID

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

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

-RemoveTeamsChannelLocationException

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveTeamsChannelLocationException especifica as Equipas a remover da lista de exclusão quando utiliza o valor All para o parâmetro TeamsChannelLocation. Pode utilizar qualquer valor que identifique exclusivamente a equipa. Por exemplo:

  • Nome
  • Endereço de email
  • GUID

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

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

-RemoveTeamsChatLocation

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveTeamsChatLocation especifica os utilizadores do Teams a remover da política.

É possível usar qualquer valor que identifique o usuário com exclusividade. 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

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

Conjuntos de parâmetros

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

-RemoveTeamsChatLocationException

Aplicável: Conformidade do & de Segurança

O parâmetro RemoveTeamsChatLocationException especifica os utilizadores do Teams a remover da lista de exclusão quando utiliza o valor All para o parâmetro TeamsChatLocation. É possível usar qualquer valor que identifique o usuário com exclusividade. Por exemplo:

  • Nome
  • Endereço de email
  • GUID

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

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

-RestrictiveRetention

Aplicável: Conformidade do & de Segurança

O parâmetro RestrictiveRetention especifica se o Bloqueio de Preservação está ativado para uma política de retenção ou política de etiqueta de retenção. 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 uma política ser bloqueada, ninguém pode desativá-la ou desativá-la ou remover conteúdos da política. Além disso, não é possível modificar ou eliminar conteúdos sujeitos à política durante o período de retenção. A única forma de modificar a política de retenção é ao adicionar conteúdo 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 de retenção, é 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

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

Conjuntos de parâmetros

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

-RetryDistribution

Aplicável: Conformidade do & de Segurança

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

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-StartSimulation

Aplicável: Conformidade do & de Segurança

O parâmetro StartSimulation especifica se deve iniciar a simulação de uma política criada no modo de simulação. Os valores válidos são:

  • $true: Iniciar a simulação.
  • $false: não inicie a simulação. Este valor é a predefinição.

Para obter mais informações sobre o modo de simulação, consulte Saiba sobre o modo de simulação.

Propriedades do parâmetro

Tipo:Boolean
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.