[EXOMailTips] Change the Organization parameter to IsSingleInstance (BREAKING CHANGE)

[ykuijs]

Description of the issue

The EXOMailTips resource has an Organization parameter, which is the Key parameter. This accepts all string input, which means the resource can be supplied more than once in a config. However M365 only has one Mail Tips configuration. This can result into conflicts.

We have to change the current Organization parameter into the IsSingleInstance parameter, which makes sure the resource can only be used once in a config. This is however a breaking change, so must be included in the April 2024 breaking change release.

Microsoft 365 DSC Version

Dev

Which workloads are affected

Exchange Online

The DSC configuration

Current:

EXOMailTips 'OrgWideMailTips'
{
    Organization                          = "contoso.com"
    MailTipsAllTipsEnabled                = $True
    MailTipsGroupMetricsEnabled           = $True
    MailTipsLargeAudienceThreshold        = 100
    MailTipsMailboxSourcedTipsEnabled     = $True
    MailTipsExternalRecipientsTipsEnabled = $True
    Ensure                                = "Present"
    Credential                            = $Credscredential
}

Target:

EXOMailTips 'OrgWideMailTips'
{
    IsSingleInstance                      = "Yes"
    MailTipsAllTipsEnabled                = $True
    MailTipsGroupMetricsEnabled           = $True
    MailTipsLargeAudienceThreshold        = 100
    MailTipsMailboxSourcedTipsEnabled     = $True
    MailTipsExternalRecipientsTipsEnabled = $True
    Ensure                                = "Present"
    Credential                            = $Credscredential
}

Verbose logs showing the problem

N/A

Environment Information + PowerShell Version

N/A