Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tally.wharflab.com/llms.txt

Use this file to discover all available pages before exploring further.

powershell/PSDSCDscExamplesPresent is a PSScriptAnalyzer diagnostic emitted by tally for PowerShell snippets embedded in Dockerfiles.
PropertyValue
SeverityInformation
CategoryPSScriptAnalyzer
Auto-fixNo

​
Description

Checks that DSC examples for given resource are present.

​
How

To fix a violation of this rule, please make sure Examples directory is present:
  • For non-class based resources it should exist at the same folder level as DSCResources folder.
  • For class based resources it should be present at the same folder level as resource .psm1 file.
The Examples folder should contain a sample configuration for given resource. The filename should contain the resource’s name.

​
Examples

​
Non-class based resource

Let’s assume we have non-class based resource with a following file structure:
  • xAzure
    • DSCResources
      • MSFT_xAzureSubscription
        • MSFT_xAzureSubscription.psm1
        • MSFT_xAzureSubscription.schema.mof
In this case, to fix this warning, we should add examples in a following way:
  • xAzure
    • DSCResources
      • MSFT_xAzureSubscription
        • MSFT_xAzureSubscription.psm1
        • MSFT_xAzureSubscription.schema.mof
    • Examples
      • MSFT_xAzureSubscription_AddSubscriptionExample.ps1
      • MSFT_xAzureSubscription_RemoveSubscriptionExample.ps1

​
Class based resource

Let’s assume we have class based resource with a following file structure:
  • MyDscResource
    • MyDscResource.psm1
    • MyDscResource.psd1
In this case, to fix this warning, we should add examples in a following way:
  • MyDscResource
    • MyDscResource.psm1
    • MyDscResource.psd1
    • Examples
      • MyDscResource_Example1.ps1
      • MyDscResource_Example2.ps1

​
Source

This rule documentation is adapted from Microsoft’s PSScriptAnalyzer documentation for DSCDscExamplesPresent, licensed under CC BY 4.0.