DscTagging.adoc

DSC Resource 'DscTagging'

DscTagging contains information about the current DSC configuration (version, envrionment, modules, …​).

Source	https://github.com/dsccommunity/CommonTasks/tree/dev/CommonTasks/DscResources/DscTagging
DSC Resource	xPSDesiredStateConfiguration, PSDesiredStateConfiguration
Documentation	xRegistry

Table 1. Attributes of category 'DscTagging'

Parameter	Attribute	DataType	Description	Allowed Values
Version	Mandatory	System.Version	DSC configuration version
Environment	Mandatory	String	DSC environment information
Layers		String[]	List of used layers (YAML files) for each node

Note	To fill the Layers list each YAML file requires an DscTagging configuration. In these configuration the attribute Layers should be set with the current layer name (e.g. YAML file name). In Datum.yml the merging rules for DscTagging must be specified as deep merge.

Example Datum.yml (Excerpt)

ResolutionPrecedence:
  - AllNodes\$($Node.Environment)\$($Node.NodeName)
  - Environment\$($Node.Environment)
  - Roles\$($Node.Role)
  - Roles\ServerBaseline

lookup_options:
  # merge rules of DscTagging - using Add to identify duplicate module names
  DscTagging:
    merge_hash: deep
  DscTagging\Modules:
    merge_basetype_array: Add

Example Environment\Dev.yml (Excerpt)

DscTagging:
  Environment: Dev
  Layers:
    - Environment\Dev

Example Roles\FileServer.yml (Excerpt)

DscTagging:
  Layers:
    - Roles\FileServer

Example Roles\ServerBaseline.yml (Excerpt)

Configurations:
  - DscTagging

DscTagging:
  Version: 0.3.0
  Layers:
    - Roles\ServerBaseline

Example of RSOP MyComputer.yml (Excerpt)

Configurations:
  - DscTagging

DscTagging:
  Version: 0.3.0
  Environment: Dev
  Layers:
    - Environment\Dev
    - Roles\FileServer
    - Roles\ServerBaseline