Skip to content

Conversation

@FabienTschanz
Copy link
Collaborator

@FabienTschanz FabienTschanz commented Dec 26, 2025

Pull Request (PR) description

This PR adds key identifiers to all CIM resources where applicable. If any property contains CIM instances on arrays, and an individual CIM instance contains at least one identifier or any property that makes the instance unique, it is now required to have one of them. This massively helps in comparison and drift reporting.

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.

@FabienTschanz FabienTschanz force-pushed the ref/cim-key-identifiers branch from 5b7eefd to 7ea66e6 Compare December 26, 2025 14:21
@FabienTschanz FabienTschanz changed the title Add Key Identifiers to CIM instances BREAKING: Add Key Identifiers to CIM instances Dec 26, 2025
@FabienTschanz FabienTschanz force-pushed the ref/cim-key-identifiers branch from 7ea66e6 to 49aaf78 Compare December 26, 2025 21:54
@tayhall
Copy link
Contributor

tayhall commented Jan 14, 2026

It would be great to understand this in more detail once released. Ive struggled with the current drift reporting tools and CIM instances or GUID noise. Yorick's CI/CD deployment adds complications with data files and makes it hard to properly test deployments where code moves from Dev Test through to Production tenants. Ive resorted to writing a few reports myself so anything that helps here is going to be welcomed.

@FabienTschanz
Copy link
Collaborator Author

@tayhall This PR adds new key properties to these instances, making them unique in the respective resource configuration they are living in. As an example the MSFT_MicrosoftGraphMember instance type in the AADAdministrativeUnit resource. There, we change the properties Identity and Type both to a key identifier. This means that the combination of those two properties makes the instance unique. You can now only specify one instance that has e.g. the type Group and the name Test. Previously, you could have x number of these instances, which would make the deployment fail.

If you want / need a bit more help, feel free to open a dedicated issue and explain a bit more about your situation. Unfortunately, I can't help you with the stuff from Yorick since I don't use it myself, so you're probably better off opening an issue on his GitHub project(s) for your case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants