Set-​Azure​Rm​Automation​Module

Updates a module in Automation.

Syntax

Set-AzureRmAutomationModule
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-Name] <String>
   [-ContentLinkUri <Uri>]
   [-ContentLinkVersion <String>]
   [<CommonParameters>]

Description

The Set-AzureRmAutomationModule cmdlet updates a module in Azure Automation. This command accepts a compressed file that has a .zip file name extension. The file contains a folder that includes a file that is one of the following types:

  • wps_2 module, which has a .psm1 or .dll file name extension
  • wps_2 module manifest, which has a .psd1 file name extension

The name of the .zip file, the name of the folder, and the name of the file in the folder must be the same.

Specify the .zip file as a URL that the Automation service can access.

If you import a wps_2 module into Automation by using this cmdlet or the New-AzureRmAutomationModule cmdlet, the operation is asynchronous. The command finishes whether the import succeeds or fails. To check whether it succeeded, run the following command:

PS C:\\\> $ModuleInstance = Get-AzureRmAutomationModule -NameModuleName

Check the ProvisioningState property for a value of Succeeded.

Examples

Example 1: Update a module

PS C:\>Set-AzureRmAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLinkUri ".\ContosoModule.zip" -ContentLinkVersion "1.1" -ResourceGroupName "ResourceGroup01"

This command imports an updated version of an existing module named ContosoModule into the Automation account named Contoso17.

Required Parameters

-AutomationAccountName

Specifies the name of the Automation account for which this cmdlet updates a module.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of the module that this cmdlet imports.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of a resource group for which this cmdlet updates a module.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ContentLinkUri

Specifies the URL of the .zip file that contains the new version of a module that this cmdlet imports.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ContentLinkVersion

Specifies the version of the module to which this cmdlet updates Automation.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False