EXOPhishSimOverrideRule

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Credential	Write	PSCredential	Credentials of the workload's 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	String[]	Access token used for authentication.
IsSingleInstance	Key	String	Only valid value is 'Yes'.	Yes
Domains	Write	String[]	The email domains used by the non-Microsoft phishing simulation, either the 5321.MailFrom domain or the DKIM domain. Up to 20 values.
SenderIpRanges	Write	String[]	The source IP addresses used by the non-Microsoft phishing simulation, as single IP addresses, IP address ranges or CIDR ranges. Up to 10 values.
Comment	Write	String	An optional comment for the override rule.
Ensure	Write	String	Ensures the presence or absence of the configuration.	Present, Absent

Description

This resource manages the tenant's single phishing simulation override rule of the advanced delivery policy, which lets non-Microsoft phishing simulations bypass Exchange Online Protection filtering.

Permissions

Exchange

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

Roles

• Read
• View-Only Configuration
• Update
• Organization Configuration

Role Groups

• Read
• View-Only Organization Management
• Update
• Organization Management

Office 365 Exchange Online

To authenticate with the Office 365 Exchange Online API, this resource requires the following permissions:

Delegated permissions

• Read

• None

• Update

• None

Application permissions

• Read

• Exchange.ManageAsApp

• Update

• Exchange.ManageAsApp

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()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        EXOPhishSimOverrideRule "EXOPhishSimOverrideRule-Example"
        {
            Comment               = "Allows security awareness training campaigns from the training vendor";
            Domains               = @("fabrikam.com","wingtiptoys.com");
            Ensure                = "Present";
            IsSingleInstance      = "Yes";
            SenderIpRanges        = @("192.168.1.55");
            ApplicationId         = $ApplicationId
            TenantId              = $TenantId
            CertificateThumbprint = $CertificateThumbprint
        }
    }
}

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()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        EXOPhishSimOverrideRule "EXOPhishSimOverrideRule-Example"
        {
            Comment               = "Allows security awareness training campaigns from the training vendor and the internal red team"; # Updated Property
            Domains               = @("fabrikam.com","wingtiptoys.com");
            Ensure                = "Present";
            IsSingleInstance      = "Yes";
            SenderIpRanges        = @("192.168.1.55");
            ApplicationId         = $ApplicationId
            TenantId              = $TenantId
            CertificateThumbprint = $CertificateThumbprint
        }
    }
}

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()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        EXOPhishSimOverrideRule "EXOPhishSimOverrideRule-Example"
        {
            Ensure                = "Absent";
            IsSingleInstance      = "Yes";
            ApplicationId         = $ApplicationId
            TenantId              = $TenantId
            CertificateThumbprint = $CertificateThumbprint
        }
    }
}