|
| 1 | +--- |
| 2 | +external help file: Microsoft.Exchange.TransportMailflow-Help.xml |
| 3 | +online version: https://docs.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy |
| 4 | +applicable: Security & Compliance Center |
| 5 | +title: Get-AppRetentionCompliancePolicy |
| 6 | +schema: 2.0.0 |
| 7 | +author: chrisda |
| 8 | +ms.author: chrisda |
| 9 | +ms.reviewer: |
| 10 | +--- |
| 11 | + |
| 12 | +# Get-AppRetentionCompliancePolicy |
| 13 | + |
| 14 | +## SYNOPSIS |
| 15 | +This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). |
| 16 | + |
| 17 | +Use the Get-AppRetentionCompliancePolicy to view app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies. |
| 18 | + |
| 19 | +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). |
| 20 | + |
| 21 | +## SYNTAX |
| 22 | + |
| 23 | +``` |
| 24 | +Get-AppRetentionCompliancePolicy [[-Identity] <PolicyIdParameter>] |
| 25 | + [-DistributionDetail] |
| 26 | + [-RetentionRuleTypes] |
| 27 | + [<CommonParameters>] |
| 28 | +``` |
| 29 | + |
| 30 | +## DESCRIPTION |
| 31 | +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Yammer chats, and Yammer community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. |
| 32 | + |
| 33 | +To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). |
| 34 | + |
| 35 | +## EXAMPLES |
| 36 | + |
| 37 | +### Example 1 |
| 38 | +```powershell |
| 39 | +Get-AppRetentionCompliancePolicy | Format-Table Name,GUID |
| 40 | +``` |
| 41 | + |
| 42 | +This example returns a summary list of all app retention compliance policies. |
| 43 | + |
| 44 | +### Example 1 |
| 45 | +```powershell |
| 46 | +Get-AppRetentionCompliancePolicy -Identity "Contoso Yammer" |
| 47 | +``` |
| 48 | + |
| 49 | +This example returns detailed information for the app retention compliance policy named Contoso Yammer. |
| 50 | + |
| 51 | +## PARAMETERS |
| 52 | + |
| 53 | +### -Identity |
| 54 | +The Identity parameter specifies the app retention compliance policy that you want to view. You can use any value that uniquely identifies the policy. For example: |
| 55 | + |
| 56 | +- Name |
| 57 | +- Distinguished name (DN) |
| 58 | +- GUID |
| 59 | + |
| 60 | +```yaml |
| 61 | +Type: PolicyIdParameter |
| 62 | +Parameter Sets: (All) |
| 63 | +Aliases: |
| 64 | +Applicable: Security & Compliance Center |
| 65 | + |
| 66 | +Required: False |
| 67 | +Position: 0 |
| 68 | +Default value: None |
| 69 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 70 | +Accept wildcard characters: False |
| 71 | +``` |
| 72 | +
|
| 73 | +### -DistributionDetail |
| 74 | +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. |
| 75 | +
|
| 76 | +```yaml |
| 77 | +Type: SwitchParameter |
| 78 | +Parameter Sets: (All) |
| 79 | +Aliases: |
| 80 | +Applicable: Security & Compliance Center |
| 81 | + |
| 82 | +Required: False |
| 83 | +Position: Named |
| 84 | +Default value: None |
| 85 | +Accept pipeline input: False |
| 86 | +Accept wildcard characters: False |
| 87 | +``` |
| 88 | +
|
| 89 | +### -RetentionRuleTypes |
| 90 | +The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. |
| 91 | +
|
| 92 | +To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-AppRetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the value appears blank. |
| 93 | + |
| 94 | +```yaml |
| 95 | +Type: SwitchParameter |
| 96 | +Parameter Sets: (All) |
| 97 | +Aliases: |
| 98 | +Applicable: Security & Compliance Center |
| 99 | +
|
| 100 | +Required: False |
| 101 | +Position: Named |
| 102 | +Default value: None |
| 103 | +Accept pipeline input: False |
| 104 | +Accept wildcard characters: False |
| 105 | +``` |
| 106 | + |
| 107 | +### CommonParameters |
| 108 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). |
| 109 | + |
| 110 | +## INPUTS |
| 111 | + |
| 112 | +### |
| 113 | + |
| 114 | +## OUTPUTS |
| 115 | + |
| 116 | +### |
| 117 | + |
| 118 | +## NOTES |
| 119 | + |
| 120 | +## RELATED LINKS |
0 commit comments