Add separate check for strings

[FabienTschanz]

Pull Request (PR) description

This PR improves the comparison of strings inside of Compare-M365DSCComplexObject. Previously, the comparison did not check for different line breaks (\r\n vs \n). The comparison was also updated to use StringComparison.Ordinal, a byte-wise check which does not take into consideration the current culture.

This Pull Request (PR) fixes the following issues

None.

Task list

• Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
  Entry should say what was changed and how that affects users (if applicable), and
  reference the issue being resolved (if applicable).
• Resource parameter descriptions added/updated in the schema.mof.
• Resource documentation added/updated in README.md.
• Resource settings.json file contains all required permissions.
• Examples appropriately added/updated.
• Unit tests added/updated.
• New/changed code adheres to DSC Community Style Guidelines.

[ricmestre]

Nitpicking, but comment # Remove carriage return and line feed characters is incorrect, you're replacing CRLF characters with LF so you could say you're only removing carriage return. Also not that it makes a difference but everything in M365DSC is done with CRLF in mind but you're actually replacing it with LF, again not that it makes a difference in the end result but just saying.

Also, this is something that is missing from plain string comparisons not inside CIM instances, I have a monitoring tool which I have to massage the results with something very similar so that they're not reported as drifts, can't just remember which function it is but it should be in M365DSCUtil.psm1

[FabienTschanz]

@ricmestre Will update my comment 👀 Is the function you mean Test-M365DSCParameterState?