Skip to content

Commit 3150cba

Browse files
authored
Add description to Microsoft.DSC metadata (#371)
1 parent a094449 commit 3150cba

File tree

1 file changed

+13
-1
lines changed
  • dsc/docs-conceptual/dsc-3.0/reference/schemas/metadata/Microsoft.DSC

1 file changed

+13
-1
lines changed

dsc/docs-conceptual/dsc-3.0/reference/schemas/metadata/Microsoft.DSC/properties.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,19 @@ Metadata properties used and returned by DSC for configuration and resource oper
1313

1414
## Description
1515

16-
Blah
16+
The `Microsoft.DSC` metadata object captures execution details that DSC adds to
17+
command output and, when applicable, to resource results. It describes what
18+
operation ran, when it started and finished, how long it took, the security
19+
context DSC ran under, and the DSC version that produced the output. These
20+
properties are informational and help with diagnostics, auditing, and tooling.
21+
22+
Not every property is present for every operation. For example, `executionType`
23+
is only meaningful for `Set` (and is `WhatIf` when you invoke DSC with
24+
`--whatIf`), while `operation` is always provided. Timestamps use RFC 3339
25+
`date-time` format, and durations use the ISO 8601 `duration` format.
26+
27+
Consumers should tolerate additional, future metadata fields. Producers should
28+
preserve unknown metadata they do not interpret.
1729

1830
## Properties
1931

0 commit comments

Comments
 (0)