Skip to content

Commit bb9db1c

Browse files
authored
package format details
1 parent 0985002 commit bb9db1c

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

articles/automation/shared-resources/modules.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,17 @@ PowerShell modules can be imported into Azure Automation to make their cmdlets a
110110

111111
We recommend you consider the following when you author a PowerShell module for use in Azure Automation:
112112

113+
* Do NOT include a version folder within the .zip package. This is less of a concern for runbooks but will cause an issue with the State Configuration service. Azure Automation will create this automatically when the module is distributed to nodes managed by DSC, and if a version folder exists you will end up with two instances. Example folder structure for a DSC module:
114+
115+
```powershell
116+
myModule
117+
- DSCResources
118+
- myResourceFolder
119+
myResourceModule.psm1
120+
myResourceSchema.mof
121+
myModuleManifest.psd1
122+
```
123+
113124
* Include a synopsis, description, and help URI for every cmdlet in the module. In PowerShell, you can define certain help information for cmdlets to allow the user to receive help on using them with the **Get-Help** cmdlet. The following example shows how to define a synopsis and help URI for in a .psm1 module file:
114125

115126
```powershell
@@ -253,4 +264,4 @@ The following table lists the modules that are imported by default when an Autom
253264

254265
## Next steps
255266

256-
* To learn more about creating PowerShell Modules, see [Writing a Windows PowerShell Module](https://msdn.microsoft.com/library/dd878310%28v=vs.85%29.aspx)
267+
* To learn more about creating PowerShell Modules, see [Writing a Windows PowerShell Module](https://msdn.microsoft.com/library/dd878310%28v=vs.85%29.aspx)

0 commit comments

Comments
 (0)