Permalink
Fetching contributors…
Cannot retrieve contributors at this time
143 lines (103 sloc) 5.38 KB
external help file applicable title schema monikerRange
Microsoft.Exchange.TransportMailflow-Help.xml
Office 365 Security & Compliance Center
Get-TeamsRetentionCompliancePolicy
2.0.0
o365scc-ps

Get-TeamsRetentionCompliancePolicy

SYNOPSIS

This cmdlet is available only in the Office 365 Security & Compliance Center. For more information, see Office 365 Security & Compliance Center PowerShell (https://technet.microsoft.com/library/mt587091.aspx).

Use the Get-TeamsRetentionCompliancePolicy cmdlet to view retention policies for Microsoft Teams in the Security & Compliance Center.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

SYNTAX

Get-TeamsRetentionCompliancePolicy [[-Identity] <Object>] [-DistributionDetail] [-Confirm] [-WhatIf]

DESCRIPTION

This list describes the properties that are displayed by default.

  • Name: The unique name of the policy.

  • Enabled: The value True means the policy is enabled.

  • Mode: The current operating mode of the policy. The possible values are Test (the content is tested, but no rules are enforced), AuditandNotify (when content matches the conditions specified by the policy, the rule is not enforced, but notification emails are sent) or Enforce (all aspects of the policy are enabled and enforced).

You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center (https://go.microsoft.com/fwlink/p/?LinkId=511920).

EXAMPLES

-------------------------- Example 1 --------------------------

Get-TeamsRetentionCompliancePolicy

This example displays summary information for all retention policies for Microsoft Teams in your organization.

-------------------------- Example 2 --------------------------

Get-TeamsRetentionCompliancePolicy -Identity "Teams - Regulation 123 Compliance" -DistributionDetail | Format-List

This example displays detailed information for the policy named "Teams - Regulation 123 Compliance", including accurate values for the DistributionStatus and *Location properties.

PARAMETERS

-Confirm

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: Office 365 Security & Compliance Center
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DistributionDetail

The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch.

If you don't use this switch, the values of the DistributionStatus and *Location property values will be inaccurate.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: Office 365 Security & Compliance Center
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

The Identity parameter specifies the retention policy for Microsoft Teams that you want to modify. You can use any value that uniquely identifies the policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Type: PolicyIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Office 365 Security & Compliance Center
Required: True
Position: 1
Default value: None
Accept pipeline input: True
Accept wildcard characters: False

-WhatIf

The WhatIf switch doesn't work in the Office 365 Security & Compliance Center.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Applicable: Office 365 Security & Compliance Center
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

OUTPUTS

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.

NOTES

RELATED LINKS

Online Version