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).
No comments yet. Be the first to comment.
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...
You may have heard about a new (currently in preview) feature called Runtime Environment.
The main features are:
You can have multiple custom runtime environments that can be used across numerous Runbooks (a.k.a. one runtime in multiple runbooks)
Testing of new module versions is super easy, you create a new runtime, import modules you want to test, switch to this runtime in your runbook, and see how it goes
Testing of the new Runtime language version is super easy
All of this can be automated via direct API calls
Today I will show you how to manage the whole Runtime Environment lifecycle including modules management through my PowerShell module AzureResourceStuff.
By the way, there is official documentation about managing Runtime Environments via API, but it lacks a lot of information, therefore I had to use web browser Developer Tools (F12) to get what I needed in most cases 😎
Open your testing Automation Account in the Azure web portal interface.
Manually switch to the new Runtime experience before you continue!
By the way, you can switch back using Switch to Old Experience button any time.
Now when switching to the new experience, you should see a new menu Runtime Environments (Preview) in your Automation Account left pane.
Now, we can create new runtimes, import modules, and more manually or using PowerShell commands, as shown below.
To be able to use my PowerShell commands, you must first install AzureResourceStuff module from the PowerShell Gallery.
Install-Module AzureResourceStuff
Get-Command -Name automationRuntime -module AzureResourceStuffNow I show you a few basic actions you want to make with your Runtimes. Be sure to check functions help (via Get-Help) to get more details and examples though!
Import-Module Az.Accounts
Connect-AzAccount
Set-AzContext -Subscription "<nameOfYourSubscription>"
Get-AzureAutomationRuntime
$defaultPackage = @{
az = '8.0.0'
}
New-AzureAutomationRuntime -runtimeName 'CustomPSH_7.2' -runtimeLanguage 'PowerShell' -runtimeVersion '7.2' -defaultPackage $defaultPackage
Custom modules are imported from PSH Gallery or a ZIP file.
# import newest version of the 'CommonStuff' module (including all required dependencies) from the PowerShell Gallery
New-AzureAutomationRuntimeModule -moduleName 'CommonStuff' -runtimeName 'CustomPSH_7.2'
# import module archived in the selected zip file
New-AzureAutomationRuntimeZIPModule -moduleZIPPath "C:\DATA\helperFunctions.zip" -runtimeName 'CustomPSH_7.2'
# update 'CommonStuff' module to the newest version
Update-AzureAutomationRunbookModule -moduleName 'CommonStuff' -runtimeName 'CustomPSH_7.2'
# update/downgrade 'CommonStuff' module to the specified version
Update-AzureAutomationRunbookModule -moduleName 'CommonStuff' -moduleVersion '1.0.15' -runtimeName 'CustomPSH_7.2'
# update all custom modules to their newest version
Update-AzureAutomationRunbookModule -allCustomModule -runtimeName 'CustomPSH_7.2'
# replace existing module with the one saved in selected zip file
New-AzureAutomationRuntimeZIPModule -moduleZIPPath "C:\DATA\helperFunctionsv2.zip" -runtimeName 'CustomPSH_7.2'
Remove-AzureAutomationRuntimeModule -moduleName 'CommonStuff' -runtimeName 'CustomPSH_7.2'
Default modules are pre-built into every runtime. You select whether you want to use it (and which version) or don’t want to use it at all.
Get-AzureAutomationRuntimeAvailableDefaultModule
The default (built-in) modules are az, azure cli a.k.a. the ones selected from the dropdown menu in the Azure portal GUI.
$defaultPackage = @{
'azure cli' = '2.56.0'
}
# replace existing default modules with new setting (remove 'az' completely)
Set-AzureAutomationRuntimeDefaultModule -defaultPackage $defaultPackage -runtimeName 'CustomPSH_7.2' -replace
$defaultPackage = @{
'az' = '8.3.0'
'azure cli' = '2.56.0'
}
# replace existing default modules with new setting
Set-AzureAutomationRuntimeDefaultModule -defaultPackage $defaultPackage -runtimeName 'CustomPSH_7.2'
# remove all default modules
Set-AzureAutomationRuntimeDefaultModule -defaultPackage @{} -runtimeName 'CustomPSH_7.2'
Get-AzureAutomationRuntimeSelectedDefaultModule
Copy-AzureAutomationRuntime -runtimeName "CustomPSH_7.2" -newRuntimeName "CustomPSH_7.2_v2"
Remove-AzureAutomationRuntime -runtimeName 'CustomPSH_7.2'
Here are some of the functions related to Runbooks
Get-AzureAutomationRunbookContent -runbookName someRunbook -ResourceGroupName Automations -AutomationAccountName someAutomationAccount
$content = @'
Get-process notepad
restart-service spooler
'@
Set-AzureAutomationRunbookContent -runbookName someRunbook -ResourceGroupName Automations -AutomationAccountName someAutomationAccount -content $content
Get-AzureAutomationRunbookRuntime
Set-AzureAutomationRunbookRuntime
Set-AzureAutomationRuntimeDescription
Useful if you want to automate testing of the new Runtimes a.k.a. that your Runbook will successfully end with this new Runtime (modules) version, before the final assignment.
Start-AzureAutomationRunbookTestJob -runtimeName "CustomPSH_7.2_v2" -runbookName "ExchangeSetAuditSettings"
Stop-AzureAutomationRunbookTestJob
# get the output as array of string
Get-AzureAutomationRunbookTestJobOutput -runbookName "ExchangeSetAuditSettings" -justText 'Output', 'Warning', 'Error', 'Exception'
# get the output as array of objects
Get-AzureAutomationRunbookTestJobOutput -runbookName "ExchangeSetAuditSettings"
# get test run status
Get-AzureAutomationRunbookTestJobStatus -runbookName "ExchangeSetAuditSettings"