Use Docker to run PowerShell for Azure Stack Hub
In this article, you can use Docker to create a container on which to run the version of PowerShell that's required for working with the various interfaces. You can find instructions for using both AzureRM modules and the latest Az modules. AzureRM requires a Windows-based container. Az uses a Linux-based container.
In a command-line program, such as PowerShell or Bash, enter:
Set up a service principal for using PowerShell
To use PowerShell to access resources in Azure Stack Hub, you need a service principal in your Azure Active Directory (Azure AD) tenant. You delegate permissions with user role-based access control (RBAC). You may need to request the service principal from your cloud operator.
To set up your service principal, follow the instructions in Give applications access to Azure Stack Hub resources by creating service principals.
Note the application ID, the secret, your tenant ID, and object ID for later use.
Run PowerShell in Docker
In these instructions, you will run a Linux-based container image that contains the PowerShell and the required modules for Azure Stack Hub.
You need to run Docker by using Linux container. When you run Docker, switch to Linux containers.
Run Docker from a machine that's joined to the same domain as Azure Stack Hub. If you are using the Azure Stack Development Kit (ASDK), you need to install the VPN on your remote machine.
Install Azure Stack Hub Az module on a Linux container
From your command line, run the following Docker command to run PowerShell in an Ubuntu container:
docker run -it mcr.microsoft.com/azurestack/powershell
You can run Ubuntu, Debian, or Centos. You can find the following Docker files in the GitHub repository, azurestack-powershell. Refer to the GitHub repository for the latest changes to the Docker files. Each OS is tagged. Replace the tag, the section after the colon, with the tag for the desired OS.
Linux Docker image Ubuntu
docker run -it mcr.microsoft.com/azurestack/powershell:ubuntu-18.04
docker run -it mcr.microsoft.com/azurestack/powershell:debian-9
docker run -it mcr.microsoft.com/azurestack/powershell:centos-7
The shell is ready for your cmdlets. Test your shell connectivity by signing in and then running
First, create your service principal credentials. You will need the secret and application ID. You will also need the object ID when running the
Test-AzureStack.ps1to check your container. You may need to request a service principal from your cloud operator.
Type the following cmdlets to create a service principle object:
$passwd = ConvertTo-SecureString <Secret> -AsPlainText -Force $pscredential = New-Object System.Management.Automation.PSCredential('<ApplicationID>', $passwd)
Connect to your environment by running the following script with the following values from your Azure Stack Hub instance.
Value Description The name of the environment. The name of your Azure Stack Hub environment. Resource Manager Endpoint The URL for the Resource Manager. Contact your cloud operator if you don't know it. It will look something like
Directory Tenant ID The ID of your Azure Stack Hub tenant directory. Credential An object containing your service principal. In this case
./Login-Environment.ps1 -Name <String> -ResourceManagerEndpoint <resource manager endpoint> -DirectoryTenantId <String> -Credential $pscredential
PowerShell returns your account object.
Test your environment by running the
Test-AzureStack.ps1script in the container. Specify the service principal object ID. If you do not indicate the object ID, the script will still run but it will just test tenant (user) modules and fail on modules that require administrator privileges.
./Test-AzureStack.ps1 <Object ID>
- Read an overview of Azure Stack Hub PowerShell in Azure Stack Hub.
- Read about API profiles for PowerShell in Azure Stack Hub.
- Install Azure Stack Hub PowerShell.
- Read about creating Azure Resource Manager templates for cloud consistency.
Submit and view feedback for