File tree Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Original file line number Diff line number Diff line change
1
+ #DscExamplesPresent
2
+ ** Severity Level: Information**
3
+
4
+
5
+ ##Description
6
+
7
+ Checks that DSC examples for given resource are present.
8
+
9
+ ##How to Fix
10
+
11
+ To fix a violation of this rule, please make sure Examples directory is present:
12
+ * For non-class based resources it should exist at the same folder level as DSCResources folder.
13
+ * For class based resources it should be present at the same folder level as resource psm1 file.
14
+
15
+ Examples folder should contain sample configuration for given resource - file name should contain resource's name.
16
+
17
+ ##Example
18
+
19
+ ### Non-class based resource
20
+
21
+ Let's assume we have non-class based resource with a following file structure:
22
+
23
+ * xAzure
24
+ * DSCResources
25
+ * MSFT_xAzureSubscription
26
+ * MSFT_xAzureSubscription.psm1
27
+ * MSFT_xAzureSubscription.schema.mof
28
+
29
+ In this case, to fix this warning, we should add examples in a following way:
30
+
31
+ * xAzure
32
+ * DSCResources
33
+ * MSFT_xAzureSubscription
34
+ * MSFT_xAzureSubscription.psm1
35
+ * MSFT_xAzureSubscription.schema.mof
36
+ * Examples
37
+ * MSFT_xAzureSubscription_AddSubscriptionExample.ps1
38
+ * MSFT_xAzureSubscription_RemoveSubscriptionExample.ps1
39
+
40
+ ### Class based resource
41
+
42
+ Let's assume we have class based resource with a following file structure:
43
+
44
+ * MyDscResource
45
+ * MyDscResource.psm1
46
+ * MyDscresource.psd1
47
+
48
+ In this case, to fix this warning, we should add examples in a following way:
49
+
50
+ * MyDscResource
51
+ * MyDscResource.psm1
52
+ * MyDscresource.psd1
53
+ * Tests
54
+ * MyDscResource_Example1.ps1
55
+ * MyDscResource_Example2.ps1
You can’t perform that action at this time.
0 commit comments