Search for a command to run...
I work as System Administrator for more than 15 years now and I love to make my life easier by automating work & personal stuff via PowerShell (even silly things like food recipes list generation).
Hello Ondrej,
I know only Runtime Version 5.1 & 7.2 are supported values by Get-AzAutomationModule at time of writing.
https://github[.]com/Azure/azure-powershell/issues/27235#issuecomment-2687160833
I raised a feature request for 7.4 and looks like that will be added by 15/05. It would be great if this could be added to your module after general release.
Thanks for your work on creating this function, it works great :).
Ahoj Ondreji, I noticed the error message when using "-RuntimeVersion 7.1" parameter as you mentioned in the article (personally I do not need v7.1, but reporting in case you would like to have a look at it).
"New-AzAutomationModule : Cannot validate argument on parameter 'RuntimeVersion'. The argument "7.1" does not belong to the set "5.1,7.2" specified by the ValidateSet attribute. Supply an argument that is in the set and then try the command again."
Thats a funny thing. GUI shows it, but official commands (like Get-AzAutomationModule) don't support it :) So I will remove it too. Thanks for pointing this out
Hello Ondrej, when trying your New-AzureAutomationModule example, I am getting the following error:
New-PSGetItemInfo : Cannot convert value "2.0.0-rc3" to type "System.Version". Error: "Input string was not in a correct format."
should be fixed in new 1.0.1 module version
Ondrej Sebela Ahoj Ondreji, I have just tried after updating to 1.0.1 and updating PowerShellGet module locally and it works nicely! Dekuji!
ฤฝuboลก Nikolรญni Super, diky :)
Or any other Azure service requiring special authentication strength
If you are using Azure Local (HCI), you might find the following PowerShell script AzureLocalVMImageUpdater.ps1 useful. What is it good for? The code replaces the Windows VM images in the specified Azure Local cluster(s) with the latest compatible ve...
Problem It happens that the hardware hash of your Autopilot device gets changed. Thanks to the replacement of the motherboard or some other issue. This can lead to future problems when your users need to reinstall the operating system, but the Autopi...
Learn how to use undocumented Azure APIs for massive performance gains
Keeping a secure, version-controlled backup of your Intune-managed device data, including BitLocker, LAPS, and FileVault keys, is a best practice for any modern IT team. In this post, Iโll guide you through an Azure DevOps pipeline that automates the...
I bet you would agree that importing PowerShell modules to Azure Automation Account using GUI is super annoying.
Moreover, if such a module has some dependencies, you have to import them one by one beforehand and often in the correct order too. Not to mention that such modules can have their own dependencies ๐ฑ.
And the same pain goes for module updating.
These were the reasons why I created the PowerShell function New-AzureAutomationModule (part of my AzureResourceStuff module) which do all this heavy lifting for you ๐.
There is a (very simplified) diagram that can help you to understand how the function works
Let's say you want to import the module Microsoft.Graph.Groups. Therefore we will use the following command:
New-AzureAutomationModule -moduleName "Microsoft.Graph.Groups" -runtimeVersion "5.1" -resourceGroupName "<resourceGroupName>" -automationAccountName "<automationAccountName>"
We haven't specified the module version therefore the newest supported one will be imported. Right now it is 2.11.1.
Function New-AzureAutomationModule leverages built-in command Find-Module to find all dependencies of the Microsoft.Graph.Groups module directly from https://www.powershellgallery.com/. In this particular case, there is only one dependency and that is Microsoft.Graph.Authentication module in version 2.11.1, which will be installed automatically beforehand.
Because Microsoft.Graph.Authentication doesn't have any dependencies, no other modules will be imported.
Function therefore checks whether there is already an imported module Microsoft.Graph.Authentication in the version 2.11.1 and imports/updates it in case it isn't. The same goes for module Microsoft.Graph.Groups.
moduleVersion parameter, the newest supported version will be imported!PSH modules should contain in their manifest what PSH version (runtime) they support.
So when I am talking about "supported" version. I mean version of the module that officially supports given runtime (by default 5.1).
5.1, 7.2), New-AzureAutomationModule searches only for modules that support given runtime ๐7.1 is shown in Runbook GUI, but official commands don't support it, nor do I.Unfortunately, there can be a situation where the module author forgot to update the manifest file. Hence even though requires PSH Core (7.x) it doesn't say it. This breaks my function because if no specific version is specified, it searches for the newest one that supports a given runtime.
Like PnP.PowerShell module in versions 2.1.1 and 2.2.0. Those modules require PSH Core, but it is required in the manifest since 2.3.0 version.
To avoid this issue, there is a function parameter overridePSGalleryModuleVersion which by default forces the use of 1.12.0 module PnP.PowerShell version for 5.1 runtime, so in the case of PnP.PowerShell , you don't have to worry about it ๐.
But there can be other modules with the same problem too, so don't forget about this parameter ๐.
Install AzureResourceStuff module
Install-Module AzureResourceStuff
Connect-AzAccount -Tenant "<contoso.onmicrosoft.com>" -SubscriptionName "<NameOfYourAutomationSubscription>"
# without specifying moduleVersion parameter, newest possible will be imported
New-AzureAutomationModule -resourceGroupName '<resourceGroupName>' -automationAccountName '<automationAccountName>' -moduleName Microsoft.Graph.Groups -runtimeVersion 5.1
And you should see something like this
New-AzureAutomationModule -resourceGroupName '<resourceGroupName>' -automationAccountName '<automationAccountName>' -moduleName Microsoft.Graph.Groups -moduleVersion 2.11.1 -runtimeVersion 5.1
If you get the error "New-AzureAutomationModule : Import failed"
Search for the imported module in Azure Portal >> Automation Account >> Modules >> <nameOfTheModule>. And check its details.
In this particular case, the error says that the imported module isn't supported in the used 5.1 runtime.
OK, so now you have the right tool to import your modules to the Azure Automation Account, but what about getting the list of the modules your Runbook code depends on? Don't worry I have you covered.
Let's meet the function Get-CodeDependency (part of DependencySearch module) which I will talk about in more detail another time.
This function allows you to analyze a given code to get all its dependencies (modules, pssnapins, admin privileges,...).
Install-Module DependencySearch
Save your runbook code locally to the ps1 file
Let's say this is how the Runbook looks like
And I will save it to C:\temp\runbookcode.ps1
Get the code dependencies using Get-CodeDependency function
Get-CodeDependency -scriptPath C:\temp\runbookcode.ps1 -unknownDependencyAsObject -Verbose
And you should see something like this
Which means that my example code requires three modules Microsoft.Graph.Authentication, Microsoft.Graph.Users, Microsoft.Graph.Identity.DirectoryManagement which I can easily import to my Azure Automation Account using the following command
$resourceGroupName = '<resourceGroupName>'
$automationAccountName = '<automationAccountName>'
'Microsoft.Graph.Authentication', 'Microsoft.Graph.Users', 'Microsoft.Graph.Identity.DirectoryManagement' | % {
New-AzureAutomationModule -moduleName $_ -resourceGroupName $resourceGroupName -automationAccountName $automationAccountName
}
Now when you can use the function New-AzureAutomationModule (part of the AzureResourceStuff module), you should be no longer afraid of importing or updating any module into your Azure Automation Account anymore.
And at the same time using the function Get-CodeDependency (part of the DependencySearch module) you know, which modules your Runbooks need.
๐