EXOPolicyTipConfig

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key String The Name parameter specifies the custom Policy Tip you want to modify.
Value Write String The Value parameter specifies the text that's displayed by the Policy Tip.
Ensure Write String Specify if the Policy Tip Config should exist or not. Present, Absent
Credential Write PSCredential Credentials of the Exchange Global Admin
ApplicationId Write String Id of the Azure Active Directory application to authenticate with.
TenantId Write String Id of the Azure Active Directory tenant used for authentication.
CertificateThumbprint Write String Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword Write PSCredential Username can be made up to anything but password will be used for CertificatePassword
CertificatePath Write String Path to certificate used in service principal usually a PFX file.
ManagedIdentity Write Boolean Managed ID being used for authentication.
AccessTokens Write StringArray[] Access token used for authentication.

Description

This resource configures Policy Tips in Exchange Online.

Permissions

Exchange

To authenticate with Microsoft Exchange, this resource required the following permissions:

Roles

  • Data Loss Prevention, View-Only Configuration

Role Groups

  • Organization Management, Compliance Management

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOPolicyTipConfig 'ConfigurePolicyTipConfig'
        {
            Name                 = "en\NotifyOnly"
            Value                = "This message contains content that is restricted by Contoso company policy."
            Ensure               = "Present"
            Credential           = $Credscredential
        }
    }
}

Example 2

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOPolicyTipConfig 'ConfigurePolicyTipConfig'
        {
            Name                 = "en\NotifyOnly"
            Value                = "This message contains content that is restricted by Contoso company policy. Updated" # Updated Property
            Ensure               = "Present"
            Credential           = $Credscredential
        }
    }
}

Example 3

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOPolicyTipConfig 'ConfigurePolicyTipConfig'
        {
            Name                 = "en\NotifyOnly"
            Value                = "This message contains content that is restricted by Contoso company policy. Updated" # Updated Property
            Ensure               = "Absent"
            Credential           = $Credscredential
        }
    }
}