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.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	StringArray[]	Access token used for authentication.
Identity	Key	String	The unique identifier (GUID or name) of the override rule. This parameter is mandatory.
Domains	Write	StringArray[]	The domains for the override rule.
SenderIpRanges	Write	StringArray[]	The IP ranges for the override rule.
Comment	Write	String	An optional comment for the override rule.
Policy	Write	String	The phishing simulation override policy that's associated with the rule.
Ensure	Write	String	Ensures the presence or absence of the configuration.	`Present`, `Absent`

Description¶

This resource allows users to manage resource to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering.

Permissions¶

Exchange¶

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

Roles¶

@{read=System.Object[]; update=System.Object[]}

Role Groups¶

@{read=System.Object[]; update=System.Object[]}

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-_Exe:PhishSimOverr:d779965e-ab14-4dd8-b3f5-0876a99f988b"
        {
            Comment                                  = "Comment note";
            Domains                                  = @("fabrikam.com","wingtiptoys.com");
            Ensure                                   = "Present";
            Identity                                 = "_Exe:PhishSimOverr:d779965e-ab14-4dd8-b3f5-0876a99f988b";
            Policy                                   = "fc55717b-28bb-4cf3-98ee-9ba57903c978";
            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-_Exe:PhishSimOverr:d779965e-ab14-4dd8-b3f5-0876a99f988b"
        {
            Comment                                  = "New Comment note";
            Ensure                                   = "Present";
            Identity                                 = "_Exe:PhishSimOverr:d779965e-ab14-4dd8-b3f5-0876a99f988b";
            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-_Exe:PhishSimOverr:d779965e-ab14-4dd8-b3f5-0876a99f988b"
        {
            Ensure                                   = "Absent";
            Identity                                 = "_Exe:PhishSimOverr:d779965e-ab14-4dd8-b3f5-0876a99f988b";
            ApplicationId                            = $ApplicationId
            TenantId                                 = $TenantId
            CertificateThumbprint                    = $CertificateThumbprint
        }
    }
}