DSC well-known properties

DSC has support for several well-known properties. Some well-known properties enable a DSC Resource to use built-in processing. The well-known properties always start with an underscore (_) and DSC Resources that use these properties can't override or extend them.

_exist

The _exist property indicates that the resource can enforce whether instances exist, handling whether an instance should be added, updated, or removed during a set operation. This property provides shared semantics for DSC Resources and integrating tools, but doesn't enable any additional built-in processing with DSC.

For more information, see DSC Resource _exist property schema.

_inDesiredState

The read-only _inDesiredState property indicates whether a resource instance is in the desired state. This property is mandatory for command-based DSC Resources that define the test property in their manifest.

For more information, see DSC Resource _inDesiredState property schema.

_purge

DSC Resources that need to distinguish between whether unmanaged entries in a list are valid or must be removed can define the write-only _purge property. This property provides shared semantics for DSC Resources and integrating tools, but doesn't enable any built-in processing with DSC.

For more information, see DSC Resource _purge property schema.

_rebootRequested

The read-only _rebootRequested property indicates whether a resource instance requires a reboot after a set operation. To use DSC's built-in reboot notification processing, resources must define this property in their manifest.

For more information, see DSC Resource _rebootRequested property schema.