---
description: DSC examples are present
ms.custom: PSSA v1.22.0
ms.date: 06/28/2023
ms.topic: reference
title: DSCDscExamplesPresent
---
# DscExamplesPresent

**Severity Level: Information**

## 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.

## Example

### 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
