Install PowerShell modules for Azure Stack Hub

Before installing PowerShell modules for Azure Stack Hub, ensure that you have the following prerequisites in place:

• An operational Azure Stack Hub environment.
• A Windows-based external client machine with an internet connection.
• PowerShell 5.1 or later installed on your external client machine.

Getting Started: Installing the Azure Stack Hub PowerShell Module

To interact with Azure Stack Hub, you need to install the AzureRM and Az modules. Both modules provide cmdlets for managing Azure Stack Hub, but they cannot be installed on the same system simultaneously. Choose one module that aligns with the Azure modules used in other environments.

Option 1: Installing the AzureRM Module

The AzureRM module is the older module but still fully supported for Azure Stack Hub. To install the AzureRM module, use the following PowerShell cmdlet:

Install-Module -Name AzureRM -RequiredVersion 2.5.0 -AllowClobber

To install AzureRM module for your Azure Stack Hub, run:

Add-AzureRMEnvironment -Name “AzureStackAdmin” -ArmEndpoint “https://adminmanagement.local.azurestack.external”

Replace the ArmEndpoint with the actual Resource Manager endpoint for your Azure Stack Hub.

Option 2: Installing the Az Module

The Az module is the modern module and is the recommended option for new deployments. To install the Az module, run:

Install-Module -Name Az -RequiredVersion 6.0.0 -AllowClobber

Then set the environment for your Azure Stack Hub with:

Add-AzEnvironment -Name “AzureStackUser” -ArmEndpoint “https://management.local.azurestack.external”

Again, update the ARM endpoint as required for your specific Azure Stack Hub environment.

Installing the Azure Stack Hub Module

After installing the AzureRM or Az module, you also need to install the Azure Stack Hub specific module. This module adds cmdlets that are tailored for Azure Stack Hub’s administrative tasks.

For AzureRM, use:

Install-Module -Name AzureStack -RequiredVersion 1.8.0

And if you are using Az, install the Azure Stack Hub module that corresponds with it:

Install-Module -Name Azs.AzureStack.Admin -RequiredVersion 0.8.0

Registering Your Azure Stack Hub with Azure

If you want to syndicate items from Azure Marketplace or you want to report usage data to Azure, you’ll need to register your Azure Stack Hub with Azure. Use PowerShell to automate these registration tasks. The cmdlets differ slightly between AzureRM and Az, but the process involves obtaining a token from Azure and registering your Azure Stack Hub environment with it.

Verifying the Installation

After installing the modules, verify them by running the following cmdlets:

For AzureRM:

Get-Module -ListAvailable AzureRM.*

For Az:

Get-Module -ListAvailable Az.*

For Azure Stack Hub:

Get-Module -ListAvailable -Name AzureStack

or

Get-Module -ListAvailable -Name Azs.AzureStack.Admin

Scripting Examples

Adding a New Plan with PowerShell

For AzureRM:

New-AzureRmResourceGroup -Name “PlanResourceGroup” -Location “local”
New-AzureRmPlan -Name “NewPlan” -ResourceGroupName “PlanResourceGroup” -Quotas @(“storage=local”, “compute=local”, “network=local”)

For Az:

New-AzResourceGroup -Name “PlanResourceGroup” -Location “local”
New-AzsPlan -Name “NewPlan” -ResourceGroupName “PlanResourceGroup” -Quotas @(“storage=local”, “compute=local”, “network=local”)

Configuring Offers and Plans

To create offers and plans that tenants can subscribe to, use the corresponding cmdlets in the Azure Stack Hub module. Creating structured offers allows cloud administrators to control the allocation of resources and services to different tenant groups effectively.

Conclusion

Proper installation and setup of the PowerShell modules for Azure Stack Hub are critical for effective cloud operations. By following the aforementioned steps, cloud operators and administrators can establish a foundational PowerShell environment to automate tasks and manage Azure Stack Hub more efficiently.

Always ensure you are working with the latest versions of the PowerShell modules and refer to the official Microsoft documentation for any updates or changes to cmdlets and their usage.