Skip to content

Commit 91ba2fd

Browse files
authored
Merge pull request #78806 from georgewallace/gw_modules
module updates
2 parents b237609 + 2f47202 commit 91ba2fd

File tree

1 file changed

+49
-2
lines changed

1 file changed

+49
-2
lines changed

articles/automation/shared-resources/modules.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ ms.service: automation
66
ms.subservice: shared-resources
77
author: georgewallace
88
ms.author: gwallace
9-
ms.date: 03/13/2019
9+
ms.date: 06/05/2019
1010
ms.topic: conceptual
1111
manager: carmonm
1212
---
1313

1414
# Manage Modules in Azure Automation
1515

16-
Azure Automation provides the ability to import PowerShell modules into your Automation Account to be used by the PowerShell based runbooks. These modules can be custom modules you've created, from the PowerShell Gallery, or the AzureRM and Az modules for Azure.
16+
Azure Automation provides the ability to import PowerShell modules into your Automation Account to be used by the PowerShell based runbooks. These modules can be custom modules you've created, from the PowerShell Gallery, or the AzureRM and Az modules for Azure. When you create an Automation Account some modules are imported by default.
1717

1818
## Import modules
1919

@@ -46,6 +46,22 @@ You can also import modules from the PowerShell Gallery directly from your Autom
4646

4747
![PowerShell Gallery import from Azure portal](../media/modules/gallery-azure-portal.png)
4848

49+
## Delete modules
50+
51+
If you have issues with a module or you need to roll back to a previous version of a module, you can delete it from your Automation Account. You can not delete the original version of the [default modules](#default-modules) that are imported when you create an Automation Account. If the module you want to delete is a newer version of one of the [default modules](#default-modules) installed, it will roll-back to the version that was installed with your Automation Account. Otherwise, any module you delete from your Automation Account will be removed.
52+
53+
### Azure portal
54+
55+
In the Azure portal, navigate to your Automation Account and select **Modules** under **Shared Resources**. Select the module you want to remove. On the **Module** page, clcick **Delete**. If this module is one of the [default modules](#default-modules) it will be rolled back to the version that was present when the Automation Account was created.
56+
57+
### PowerShell
58+
59+
To remove a module through PowerShell, run the following command:
60+
61+
```azurepowershell-interactive
62+
Remove-AzureRmAutomationModule -Name <moduleName> -AutomationAccountName <automationAccountName> -ResourceGroupName <resourceGroupName>
63+
```
64+
4965
## Internal cmdlets
5066

5167
The following is a listing of cmdlets in the internal `Orchestrator.AssetManagement.Cmdlets` module that is imported into every Automation Account. These cmdlets are accessible in your runbooks and DSC configurations and allow you to interact with your assets within your Automation Account. Additionally, the internal cmdlets allow you to retrieve secrets from encrypted **Variable** values, **Credentials**, and encrypted **Connection** fields. The Azure PowerShell cmdlets are not able to retrieve these secrets. These cmdlets do not require you to implicitly connect to Azure when using them. This is beneficial for scenarios where you have a connection, such as a Run As Account that you need to use to authenticate to Azure.
@@ -205,6 +221,37 @@ We recommend you consider the following when you author a PowerShell module for
205221

206222
* If referencing [Azure Powershell Az modules](/powershell/azure/new-azureps-module-az?view=azps-1.1.0) in your module, ensure you aren't also referencing `AzureRM`. The `Az` module can't be used in conjunction with the `AzureRM` modules. `Az` is supported in runbooks but aren't imported by default. To learn about the `Az` modules and considerations to take into account, see [Az module support in Azure Automation](../az-modules.md).
207223

224+
## Default modules
225+
226+
The following table lists the modules that are imported by default when an Automation Account is created. The modules listed below can have newer versions of them imported, but the original version can not be removed from your Automation Account even if you delete a newer version of them.
227+
228+
|Module name|Version|
229+
|---|---|
230+
| AuditPolicyDsc | 1.1.0.0 |
231+
| Azure | 1.0.3 |
232+
| Azure.Storage | 1.0.3 |
233+
| AzureRM.Automation | 1.0.3 |
234+
| AzureRM.Compute | 1.2.1 |
235+
| AzureRM.Profile | 1.0.3 |
236+
| AzureRM.Resources | 1.0.3 |
237+
| AzureRM.Sql | 1.0.3 |
238+
| AzureRM.Storage | 1.0.3 |
239+
| ComputerManagementDsc | 5.0.0.0 |
240+
| GPRegistryPolicyParser | 0.2 |
241+
| Microsoft.PowerShell.Core | 0 |
242+
| Microsoft.PowerShell.Diagnostics | |
243+
| Microsoft.PowerShell.Management | |
244+
| Microsoft.PowerShell.Security | |
245+
| Microsoft.PowerShell.Utility | |
246+
| Microsoft.WSMan.Management | |
247+
| Orchestrator.AssetManagement.Cmdlets | 1 |
248+
| PSDscResources | 2.9.0.0 |
249+
| SecurityPolicyDsc | 2.1.0.0 |
250+
| StateConfigCompositeResources | 1 |
251+
| xDSCDomainjoin | 1.1 |
252+
| xPowerShellExecutionPolicy | 1.1.0.0 |
253+
| xRemoteDesktopAdmin | 1.1.0.0 |
254+
208255
## Next steps
209256

210257
* 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)