Get-PolicyTipConfig

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PolicyTipConfig cmdlet to view the data loss prevention (DLP) Policy Tips in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Get-PolicyTipConfig
   [-Action <PolicyTipMessageConfigAction>]
   [-Locale <CultureInfo>]
   [-Original]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Get-PolicyTipConfig
   [[-Identity] <PolicyTipConfigIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-PolicyTipConfig -Action NotifyOnly

This example returns a summary list of the custom Policy Tips in all languages that have the action value NotifyOnly.

Example 2

Get-PolicyTipConfig -Original -Locale fr

This example returns a summary list of all built-in French Policy Tips.

Example 3

Get-PolicyTipConfig en\RejectOverride | Format-List

This example returns details about the custom English Policy Tip for the action value RejectOverride.

Parameters

-Action

The Action parameter filters the Policy Tips by action. Valid values for this parameter are:

NotifyOnly
RejectOverride
Reject

You can't use the value Url with the Action parameter. Instead, use command: Get-PolicyTipConfig Url.

You can't use the Action parameter with the Identity parameter.

Type:	PolicyTipMessageConfigAction
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-DomainController

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example:

Locale\Action: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs. Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject.
The value Url
GUID
Distinguished name (DN)

You can't use the Identity parameter with the Action, Locale or Original parameters.

Type:	PolicyTipConfigIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Locale

The Locale parameter specifies a locale-specific version of the Policy Tip.

Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see Supported languages for NDRs.

You can't use the Locale parameter with the Identity parameter.

Type:	CultureInfo
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Original

The Original switch specifies whether to include built-in Policy Tips in the results. You don't need to specify a value with this switch.

You can't use the Original switch with the Identity parameter.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Inputs

Input types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

Output types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn't return data.

Share via