How to Run PowerShell Cmdlets from Custom PS Modules When Deploying a New Azure VM

Discover how to troubleshoot and run custom PowerShell cmdlets on new Azure VMs using Bicep templates. Gain insights and tips for successful deployment.
---

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How to run PowerShell cmdlets from custom PS modules when deploying a new Azure VM?

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Trouble with Custom PowerShell Modules in Azure VM Deployments

Deploying a new virtual machine (VM) on Microsoft Azure can sometimes present challenges, especially when it comes to running custom PowerShell cmdlets from modules installed during the process. If you've attempted to run cmdlets from a custom PowerShell module and encountered errors, you’re not alone. In this guide, we'll explore how to overcome these hurdles in a clear and structured manner.

The Problem

During the deployment of a new Azure VM using a Bicep template, you may encounter issues with running cmdlets from a custom PowerShell module. Here is a typical scenario:

You have a Bicep template that installs an MSI-packaged application containing a custom module.

After the installation, you need to run commands from that module.

However, upon execution, you realize that the cmdlets are not recognized, leading to error messages indicating that the module could not be loaded.

Common Issues:

Cmdlets Not Recognized: Errors showing that the cmdlet is not recognized suggest that the custom module was not successfully imported.

Module Load Failure: Messages indicating that the specified module could not be loaded indicate an issue with the module's location or installation status.

The Solution

The confusion primarily arises from executing commands in a single PowerShell session while the installation is still in progress. Here’s how to tackle this problem effectively:

Step 1: Ensure Proper Installation

To guarantee that the installation of your PowerShell module is complete before trying to access its cmdlets, modify the command that initiates the installation:

Use the -Wait parameter with your Start-Process command. This will pause the script until the MSI installation is finished.

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Modify the Module Path

After confirming that the installation is complete, ensure that your PowerShell session can locate the new module. You can do this by manipulating the PSModulePath environment variable:

Add the path where the module is installed to PSModulePath:

[[See Video to Reveal this Text or Code Snippet]]

Import the module using the following command:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Verify the Setup

After making these adjustments, you can verify whether your module is loaded correctly:

Use the command Get-Module -ListAvailable to check if the module appears in the list.

If all went well, you should now be able to run cmdlets from your custom PowerShell module without encountering the "not recognized" error.

Conclusion

By implementing these adjustments, you can effectively troubleshoot and run your custom PowerShell cmdlets in Azure VM deployments. Remember, timing is critical; ensuring that installations complete before invoking cmdlets is key to a successful deployment process.

If you run into further issues or have specific questions, don't hesitate to reach out to community forums or support for assistance. Happy scripting!