PowerShell / PowerShell/DSC

Define canonical properties for surfacing ARM metadata

Open
#887 0 comments 0 reactions 1 assignee View on GitHub

@michaeltlombardi is already working on this.

Since Jan 22, 2026.

Doc-Impact Issue-Enhancement Partner-MC Schema-Impact
Dominant language
Rust
Stars
523
Forks
75
Avg merge
3d 16h
Merged PRs (30d)
24

Description

Summary of the new feature / enhancement

Related to #598 and #884, we need to define canonical properties for resources to use that can be surfaced in an ARM context.

Currently, we need to define:

  • _name - the uniquely identifying name for an instance. According to the ARM documentation, the name must follow URI component restrictions defined in RFC3986.
  • _securityContext - indicates the requisite security context for managing the instance. Must be valid for the securityContext metadata property.
  • _kind - Indicates a subtype for the resource when a resource supports multiple object forms validated by different JSON subschemas. This can be an arbitrary string.
Proposed technical implementation details (optional)

We'll need to define each of these canonical properties as JSON Schemas, include them in the published schemas, and document them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.