Edit

Share via

Set-AzureRmAutomationModule

  • Reference
Module:
AzureRM.Automation

Updates a module in Automation.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmAutomationModule
   [-Name] <String>
   [-ContentLinkUri <Uri>]
   [-ContentLinkVersion <String>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<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 -Name ModuleName Check the ProvisioningState property for a value of Succeeded.

Examples

Example 1: Update a module

PS C:\>Set-AzureRmAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLinkUri "http://contosostorage.blob.core.windows.net/modules/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. The module is stored in an Azure blob in a storage account named contosostorage and a container named modules.

Parameters

-AutomationAccountName

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ContentLinkUri

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

Type:Uri
Aliases:ContentLink
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContentLinkVersion

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the module that this cmdlet imports.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
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
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Uri

Outputs

Module