Edit

Share via

New-AzureAutomationModule

  • Reference
Module:
Azure

Imports a module into Automation.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

New-AzureAutomationModule
   -Name <String>
   -ContentLink <Uri>
   [-Tags <IDictionary>]
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

Important

This PowerShell command for Azure Automation is longer supported as of 01/23/2020. The Azure Service Management model is deprecated for Azure Automation and was disabled on that date. Please use the commands which support the Azure Resource Management model in Az.Automation.

The New-AzureAutomationModule cmdlet imports a module into Azure Automation. A module is a compressed file, with a .zip extension, that contains a folder which includes one of the following file types:

  • A Windows PowerShell module (psm1 file).

  • A Windows PowerShell module manifest (psd1 file).

  • An assembly (dll file).

The names of the zip file, the folder in the zip file, and file in the folder (.psm1, psd.1, or .dll) must match.

Examples

Example 1: Import a module

PS C:\> New-AzureAutomationModule -AutomationAccountName "Contoso17" -Name "ContosoModule" -ContentLink "http://contosostorage.blob.core.windows.net/modules/ContosoModule.zip"

This command imports a 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 the module will be stored in.

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

-ContentLink

Public URL such as a website or Azure blob storage specifying the path to the module file. This location must be publically accessible.

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

-Name

Specifies a name for the module.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-Tags

Specifies one or more tags related to the module.

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

Outputs

Module