Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Microsoft's Desired State Configuration platform uses JSON schemas to describe and validate the data that DSC takes as input and returns as output.
These schemas define the structure, purpose, and validation for data in DSC and are published to
the DSC GitHub repository. DSC publishes updated schemas with every release. Each schema has an
$id keyword that uniquely identifies the schema. For convenience, DSC provides shortened links to
the schemas under the aka.ms/dsc/schemas namespace.
For more information about how the DSC schemas are published and the URIs that identify them, see DSC JSON Schema URIs.
The articles in this section provide reference documentation for the latest supported version of the DSC schemas.
Configuration document schemas
The article DSC configuration document schema reference describes the root JSON schema for configuration documents.
The article DSC Configuration document functions reference describes DSC configuration functions generally and links to the reference documentation for the available functions.
Resource schemas
The article DSC command resource manifest schema reference describes the root JSON schema for resource manifests.
The article # DSC canonical properties reference describes DSC canonical resource properties generally and links to the reference documentation for the available canonical properties.
Output schemas
The following table links to the reference documentation for the JSON schemas describing the output DSC returns for its commands:
| Command | Article link |
|---|---|
dsc config get |
dsc config get result schema reference |
dsc config set |
dsc config set result schema reference |
dsc config test |
dsc config test result schema reference |
dsc resource get |
dsc resource get result schema reference |
dsc resource list |
dsc resource list result schema reference |
dsc resource set |
dsc resource set result schema reference |
dsc resource test |
dsc resource test result schema reference |
Definition schemas
The following list defines the reference documentation for JSON schemas included as subschemas throughout DSC.
- For more information about the
Microsoft.DSCmetadata property, see Microsoft.DSC metadata property schema reference - For more information about the messages DSC emits, see Structured message schema reference
- For more information about the kinds of DSC resources and how they affect schema validation, see DSC Resource kind schema reference.
- For more information about the naming of DSC resources and how they're validated, see DSC Resource fully qualified type name schema reference
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
