EXOQuarantinePolicy

Parameters

Parameter Attribute DataType Description Allowed Values
Identity Key String The Identity parameter specifies the QuarantinePolicy you want to modify.
EndUserQuarantinePermissionsValue Write UInt32 The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy.
ESNEnabled Write Boolean The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy.
MultiLanguageCustomDisclaimer Write StringArray[] The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications.
MultiLanguageSenderName Write StringArray[] The MultiLanguageSenderName parameter specifies the email sender's display name to use in quarantine notifications.
MultiLanguageSetting Write StringArray[] The MultiLanguageSetting parameter specifies the language of quarantine notifications.
OrganizationBrandingEnabled Write Boolean The OrganizationBrandingEnabled parameter enables or disables organization branding in the end-user quarantine notification messages.
Ensure Write String Specifies if this QuarantinePolicy should exist. 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.

EXOQuarantinePolicy

Description

Create or modify a EXOQuarantinePolicy in your cloud-based organization.

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]
        $credsGlobalAdmin
    )
    $OrganizationName = $credsGlobalAdmin.UserName.Split('@')[1]
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOQuarantinePolicy 'ConfigureQuarantinePolicy'
        {
            EndUserQuarantinePermissionsValue = 87;
            ESNEnabled                        = $False;
            Identity                          = "$OrganizationName\DefaultFullAccessPolicy";
            Ensure                            = "Present"
            Credential                        = $credsGlobalAdmin
        }
    }
}