Get-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..
Use o Get-RetentionCompliancePolicy para exibir as políticas de retenção existentes 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)
Get-RetentionCompliancePolicy
[[-Identity] <PolicyIdParameter>]
[-DistributionDetail]
[-ErrorPolicyOnly]
[-ExcludeTeamsPolicy]
[-IncludeTestModeResults]
[-PriorityCleanup]
[-RetentionRuleTypes]
[-TeamsPolicyOnly]
[<CommonParameters>]
Description
Esta lista descreve as propriedades que são exibidas por padrão.
- Nome: o nome exclusivo da política.
- Carga de trabalho: atualmente, ele mostra todas as cargas de trabalho (Exchange, SharePoint, OneDriveForBusiness, Skype, ModernGroup). Ele não mostra a carga de trabalho real na qual a política é aplicada.
- Habilitada: o valor True significa que a política está habilitada.
- Modo: o modo operacional atual da política. Os valores possíveis são Test (o conteúdo é testado, mas nenhuma regra é imposta), AuditAndNotify (quando o conteúdo corresponde às condições especificadas pela política, a regra não é imposta, mas os emails de notificação são enviados) ou Enforce (todos os aspectos da política são habilitados e impostos).
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.
Exemplos
Exemplo 1
Get-RetentionCompliancePolicy
Este exemplo exibe informações de resumo de todas as políticas de retenção da sua organização.
Exemplo 2
Get-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -DistributionDetail | Format-List
Este exemplo exibe informações detalhadas para a política denominada "Conformidade com o Regulamento 123", incluindo valores precisos para as propriedades DistributionStatus e *Location.
Parâmetros
-DistributionDetail
Aplicável: Segurança & Conformidade
A opção DistributionDetail retorna informações detalhadas de distribuição de políticas na propriedade DistributionResults. Não é preciso especificar um valor com essa opção.
Se você não usar essa opção, os valores dos valores das propriedades DistributionStatus e *Location serão imprecisos.
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 |
-ErrorPolicyOnly
Aplicável: Segurança & Conformidade
A opção ErrorPolicyOnly especifica se deve mostrar apenas políticas que têm erros de distribuição nos resultados. Não é preciso especificar um valor com essa opção.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| 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 |
-ExcludeTeamsPolicy
Aplicável: Segurança & Conformidade
A opção ExcludeTeamsPolicy especifica se as políticas do Teams devem ser excluídas dos resultados. Não é preciso especificar um valor com essa opção.
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 |
-Identity
Aplicável: Segurança & Conformidade
O parâmetro Identity especifica a política de retenção que você deseja exibir. É possível usar qualquer valor que identifique a política com exclusividade. Por exemplo:
- Nome
- DN (nome diferenciado)
- GUID
Cuidado: O valor $null ou um valor inexistente para o parâmetro Identity retorna todos os objetos como se você tivesse executado o comando Get- sem o parâmetro Identity. Verifique se todas as listas de valores para o parâmetro Identity são precisas e não contêm valores de $null inexistentes.
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: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-IncludeTestModeResults
Aplicável: Segurança & Conformidade
A opção IncludeTestModeResults especifica se o status do modo de teste deve ser incluído nos detalhes da política. Não é preciso especificar um valor com essa opçã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: | 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 |
-PriorityCleanup
Aplicável: Segurança & Conformidade
{{ Preencher PriorityCleanup Description }}
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 |
-RetentionRuleTypes
Aplicável: Segurança & Conformidade
A opção RetentionRuleTypes especifica se o valor das propriedades RetentionRuleTypes e HasRules deve ser retornado nos resultados. Não é preciso especificar um valor com essa opção.
Para ver a propriedade RetentionRuleTypes, você precisa canalizar o comando para um cmdlet de formatação. Por exemplo, Get-RetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes. Se você não usar a opção RetentionRuleTypes, os valores RetentionRuleTypes aparecerão em branco e HasRules aparecerá como False.
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 |
-TeamsPolicyOnly
Aplicável: Segurança & Conformidade
A opção TeamsPolicyOnly especifica se as políticas do Teams devem ser mostradas nos resultados. Não é preciso especificar um valor com essa opção.
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 |
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.