Azure PowerShell works with PowerShell 6.2.4 and later on all platforms. It is also supported with PowerShell 5.1 on Windows. Install the latest version of PowerShell available for your operating system. Azure PowerShell has no additional requirements when run on PowerShell 6.2.4 and later. This guide explains how to install the Active Directory (AD) module for PowerShell Core 6.0 and Windows PowerShell. For Windows PowerShell, the tutorial describes how to install the AD module for Windows 7, Windows 8, Windows 8.1, Windows 10, Windows Server 2008 R2, Windows Server 2012 R2, and Windows Server 2016. Author Recent Posts Michael PietroforteMichael Pietroforte is the founder.
-->PowerShell supports macOS 10.12 and higher. PowerShell 7.0.3 or higher and PowerShell Preview7.1.0 or higher require macOS 10.13 and higher. All packages are available on our GitHub releasespage. After the package is installed, run
pwsh
from a terminal.Note
PowerShell 7 is an in-place upgrade that removes PowerShell Core 6.x.
The
/usr/local/microsoft/powershell/6
folder is replaced by /usr/local/microsoft/powershell/7
.If you need to run PowerShell 6 side-by-side with PowerShell 7, reinstall PowerShell 6 using thebinary archive method.
There are several ways to install PowerShell on macOS. Choose one of the following methods:
- Install using Homebrew. Homebrew is the preferred package manager for macOS.
- Install PowerShell via Direct Download
- Install from binary archives.
After installing PowerShell, you should install OpenSSL. OpenSSL isneeded for PowerShell remoting and CIM operations.
Installation of latest stable release via Homebrew on macOS 10.13 or higher
If the
brew
command is not found, you need to install Homebrew followingtheir instructions.Now, you can install PowerShell:
Finally, verify that your install is working properly:
When new versions of PowerShell are released, update Homebrew's formulae and upgrade PowerShell:
Note
The commands above can be called from within a PowerShell (pwsh) host,but then the PowerShell shell must be exited and restarted to complete the upgradeand refresh the values shown in
$PSVersionTable
.Installation of latest preview release via Homebrew on macOS 10.13 or higher
After you've installed Homebrew, you can install PowerShell. First, install the Cask-Versionspackage that lets you install alternative versions of cask packages:
Now, you can install PowerShell:
Finally, verify that your install is working properly:
When new versions of PowerShell are released, update Homebrew's formulae and upgrade PowerShell:
Note
The commands above can be called from within a PowerShell (pwsh) host,but then the PowerShell shell must be exited and restarted to complete the upgrade.and refresh the values shown in
$PSVersionTable
.Installing PowerShell using the Homebrew tap method is also supported for stable and LTS versions.
You can now verify your install
When new versions of PowerShell are released, simply run the following command.
Note
Whether you use the cask or the tap method, when updating to a newer version of PowerShell, usethe same method you used to initially install PowerShell. If you use a different method, opening anew pwsh session will continue to use the older version of PowerShell.
If you do decide to use different methods, there are ways to correct the issue using theHomebrew link method.
Installation via Direct Download
Download the PKG package
powershell-lts-7.0.3-osx-x64.pkg
from the releases page onto yourmacOS machine.You can double-click the file and follow the prompts, or install it from the terminal:
Install OpenSSL. OpenSSL is needed for PowerShell remoting and CIMoperations.
Install as a .NET Global tool
If you already have the .NET Core SDK installed, it's easy to install PowerShellas a .NET Global tool.
The dotnet tool installer adds
~/.dotnet/tools
to your PATH
environment variable. However, thecurrently running shell does not have the updated PATH
. You should be able to start PowerShellfrom a new shell by typing pwsh
.Install OpenSSL. OpenSSL is needed for PowerShell remoting and CIMoperations.
Binary Archives
PowerShell binary
tar.gz
archives are provided for the macOS platform to enable advanceddeployment scenarios. When you install using this method you must also manually install anydependencies.Install OpenSSL. OpenSSL is needed for PowerShell remoting and CIMoperations.
Installing binary archives on macOS
Installing dependencies
OpenSSL is required for PowerShell remoting and CIM operations. You can install OpenSSL via MacPortsif needed.
Note
MacPorts and Homebrew can have problems when used to together on the same system. However,Homebrew does not have a package for OpenSSL 1.0. For more information, see theMacPorts FAQ.
- Install the Xcode command-line tools. The Xcode tools are required by MacPorts.
- Install MacPorts. If you need instructions, refer to theinstallation guide.
- Update MacPorts by running
sudo port selfupdate
. - Upgrade MacPorts packages by running
sudo port upgrade outdated
. - Install OpenSSL by running
sudo port install openssl10
. - Link the libraries to make them available to PowerShell:
Uninstalling PowerShell
If you installed PowerShell with Homebrew, use the following command to uninstall:
If you installed PowerShell via direct download, PowerShell must be removed manually:
To remove the additional PowerShell paths, refer to the paths section in this documentand remove the paths using
sudo rm
.Note
This is not necessary if you installed with Homebrew.
Paths
$PSHOME
is/usr/local/microsoft/powershell/7.0.3/
- User profiles will be read from
~/.config/powershell/profile.ps1
- Default profiles will be read from
$PSHOME/profile.ps1
- User modules will be read from
~/.local/share/powershell/Modules
- Shared modules will be read from
/usr/local/share/powershell/Modules
- Default modules will be read from
$PSHOME/Modules
- PSReadline history will be recorded to
~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt
Powershell For Mac Download
Chromecast for second monitor mac. The profiles respect PowerShell's per-host configuration. So the default host-specific profileexists at
Microsoft.PowerShell_profile.ps1
in the same locations.PowerShell respects the XDG Base Directory Specification on macOS.
Because macOS is a derivation of BSD, the prefix
/usr/local
is used instead of /opt
. So,$PSHOME
is /usr/local/microsoft/powershell/7.0.3/
, and the symbolic link is placed at/usr/local/bin/pwsh
.Installation support
Microsoft supports the installation methods in this document. There may be other methods ofinstallation available from other sources. While those tools and methods may work, Microsoft cannotsupport those methods.
Additional Resources
-->This article explains how to install the Azure PowerShell modules usingPowerShellGet. These instructions work on Windows,macOS, and Linux platforms.
Azure PowerShell is also available in Azure Cloud Shell and is nowpreinstalled in Docker images.
Requirements
Note
PowerShell 7.x and later is the recommended version of PowerShell for use with Azure PowerShell onall platforms.
Azure PowerShell works with PowerShell 6.2.4 and later on all platforms. It is also supported withPowerShell 5.1 on Windows. Install thelatest version of PowerShell available foryour operating system. Azure PowerShell has no additional requirements when run on PowerShell 6.2.4and later.
To check your PowerShell version, run the command:
To use Azure PowerShell in PowerShell 5.1 on Windows:
- Update toWindows PowerShell 5.1.If you're on Windows 10 version 1607 or higher, you already have PowerShell 5.1 installed.
- Install .NET Framework 4.7.2 or later.
- Make sure you have the latest version of PowerShellGet. Run
Install-Module -Name PowerShellGet -Force
.
Install the Azure PowerShell module
Warning
We do not support having both the AzureRM and Az modules installed for PowerShell 5.1 on Windowsat the same time. If you need to keep AzureRM available on your system, install the Az module forPowerShell 6.2.4 or later.
Using the PowerShellGet cmdlets is the preferred installation method. Install the Az module for thecurrent user only. This is the recommended installation scope. This method works the same onWindows, macOS, and Linux platforms. Run the following command from a PowerShell session:
By default, the PowerShell gallery isn't configured as a trusted repository for PowerShellGet. Thefirst time you use the PSGallery you see the following prompt:
Answer
Yes
or Yes to All
to continue with the installation.Installing the module for all users on a system requires elevated privileges. Start the PowerShellsession using Run as administrator in Windows or use the
sudo
command on macOS or Linux:The Az module is a rollup module for the Azure PowerShell cmdlets. Installing it downloads all ofthe generally available Az PowerShell modules, and makes their cmdlets available for use.
Install offline
In some environments, it's not possible to connect to the PowerShell Gallery. In those situations,you can still install offline using one of these methods:
- Download the modules to another location in your network and use that as an installation source.This method allows you to cache PowerShell modules on a single server or file share to be deployedwith PowerShellGet to any disconnected systems. Learn how to set up a local repository and installon disconnected systems withWorking with local PowerShellGet repositories.
- Download the Azure PowerShell MSI to a machine connected to the network,and then copy the installer to systems without access to PowerShell Gallery. Keep in mind that theMSI installer only works for PowerShell 5.1 on Windows.
- Save the module with Save-Module to a file share,or save it to another source and manually copy it to other machines:
Troubleshooting
Here are some common problems seen when installing the Azure PowerShell module. If you experience aproblem not listed here, file an issue on GitHub.
Windows Powershell For Mac
Proxy blocks connection
If you get errors from
Install-Module
that indicate the PowerShell Gallery is unreachable, you maybe behind a proxy. Different operating systems and network environment have different requirementsfor configuring a system-wide proxy. Contact your system administrator for your proxy settings andhow to configure them for your environment.PowerShell itself may not be configured to use this proxy automatically. With PowerShell 5.1 andlater, configure the PowerShell session to use a proxy using the following commands:
If your operating system credentials are configured correctly, this configuration routes PowerShellrequests through the proxy. To have this setting persist between sessions, add the commands to yourPowerShell profile.
To install the package, your proxy needs to allow HTTPS connections to the following address:
https://www.powershellgallery.com
Sign in
To start working with Azure PowerShell, sign in with your Azure credentials.
Note
If you've disabled module autoloading, manually import the module with
Import-Module -Name Az
.Because of the way the module is structured, this can take a few seconds.You'll need to repeat these steps for every new PowerShell session you start. To learn how topersist your Azure sign in across PowerShell sessions, seePersist user credentials across PowerShell sessions.
Update the Azure PowerShell module
To update any PowerShell module, you should use the same method used to install the module. Forexample, if you originally used
Install-Module
, then you should useUpdate-Module to get the latest version. If youoriginally used the MSI package then you should download and install the new MSI package.The PowerShellGet cmdlets cannot update modules that were installed from an MSI package. MSIpackages do not update modules that were installed using PowerShellGet. If you have any issuesupdating using PowershellGet, then you should reinstall, rather than update. Reinstalling isdone the same way as installing, but you need to add the
-Force
parameter:Unlike MSI-based installations, installing or updating using PowerShellGet does not remove olderversions that may exist on your system. To remove old versions of Azure PowerShell from your system,see Uninstall the Azure PowerShell module. For more information aboutMSI-based installations, see Install Azure PowerShell with an MSI.
Use multiple versions of Azure PowerShell
It's possible to install more than one version of Azure PowerShell. To check if you have multipleversions of Azure PowerShell installed, use the following command:
To remove a version of Azure PowerShell, see Uninstall the Azure PowerShell module.
If you have more than one version of the module installed, module autoload and
Import-Module
loadthe latest version by default.You can install or load a specific version of the
Az
module using the -RequiredVersion
parameter:Use multiple repositories with PowerShellGet
The Repository parameter is required if you have added additional repositories to PowerShellGeton your system and the Az module can be found in more than one of them.
Provide feedback
If you find a bug in Azure PowerShell,file an issue on GitHub. To provide feedbackfrom the command line, use the Send-Feedback cmdlet.
Next Steps
To learn more about the Azure PowerShell modules and their features, seeGet Started with Azure PowerShell. If you're familiar with AzurePowerShell and need to migrate from AzureRM, seeMigrate from AzureRM to Az.