Fix Get-TargetResource for AADGroup resource #6797
Conversation
ajkenah
requested review from
FabienTschanz,
M365DSCApprover,
NikCharlebois,
m365dscapproval and
ykuijs
as code owners
| SkuId = $skuPartNumber.SkuPartNumber -replace [char]0xFEFF | ||
| } | ||
| $returnValue += $currentLicense | ||
| $returnValue += New-CimInstance -ClassName MSFT_AADGroupLicense -Namespace root/Microsoft/Windows/DesiredStateConfiguration -Property $currentLicense -ClientOnly |
There was a problem hiding this comment.
The return of the Get-TargetResource should not return objects of types CIMInstance. What is the issue we're trying to fix with this change?
There was a problem hiding this comment.
When using Get-DscConfiguration via the LCM, double-nested properties are not serialized and omitted by the LCM if they are a hashtable. This is an issue when users are relying on the functionality. The same thing like here was already applied to the IntuneSettingCatalogCustomPolicy with #6780.
There was a problem hiding this comment.
Hi @NikCharlebois.
Apologies for my late response, I was on holiday with my family.
As mentioned by Fabien, the LCM cannot convert nested hash tables into the required CIM object, causing it to error when using the Get-DscConfiguration on an imported MOF.
This is a known issue with the LCM, and the standard approach is to either use classes or create the correctly structured CIMInstance object before presenting it back to the LCM.
As the Graph API evolves, this issue will surely show up again with other resources, so it's probably worth considering at the project level, instead of just the resource level like I've done here.
Options include:
- Use classes.
- Require nested resources to be properly structured as a CIMInstance.
- Remove support for the LCM; or
- Leave it as is. Apparently, I seem to be the only one that uses the Get-DscConfiguration command anyway.
3 participants
Pull Request (PR) description
Updates the Get-TargetResource function for AADGroup to return a Schema accurate object that can be processed with the LCM.
This Pull Request (PR) fixes the following issues
FIXES #6796
Task list
Entry should say what was changed and how that affects users (if applicable), and
reference the issue being resolved (if applicable).