How to Install the SharePoint Online PowerShell Module?

Requirement: Install SharePoint Online PowerShell module.

The SharePoint Online PowerShell Module enables administrators to manage their SharePoint Online environments using PowerShell cmdlets. This module is a great way to manage and automate your SharePoint environment. You can use it to perform a wide range of tasks you typically do in the SharePoint Admin center, including creating and managing sites, lists and libraries, users and groups, fields, content, and more. This article will show you how to install the SharePoint Online PowerShell module.

SharePoint Online Management Shell is available as a module in the PowerShell Gallery now! So, you can install it as a module directly from PowerShell instead of downloading and installing the SharePoint Online Management Shell MSI file! This makes it easier to update. Here is how to install the SharePoint Online PowerShell module:

How to find your SharePoint Online PowerShell version?

To get started, check if you have already installed the SharePoint Online Management Shell module in your system by running the following command in the administrative mode in PowerShell:

Get-Module -Name Microsoft.Online.SharePoint.PowerShell -ListAvailable | Select-Object Name,Version

This finds your version of the SharePoint Online PowerShell module installed.

How to Install SharePoint Online PowerShell Module?

How do I install SharePoint Online Management Shell from PowerShell? The SharePoint Online Management Shell is a Windows PowerShell module installed in your Windows client machine or Server (Unlike the SharePoint Server PowerShell that can be accessed only from any of the Server of the Server Farm). To install the PowerShell Module for SharePoint Online, Open PowerShell as Administrator and enter:

Install-Module Microsoft.Online.SharePoint.PowerShell

Confirm the prompt, and you’ll see the PowerShell module for SharePoint Online starts downloading and installing:

This installs the latest SharePoint Online PowerShell module from PowerShell Gallery and allows administrators to manage the SharePoint Online environment, including OneDrive, using PowerShell cmdlets.

Re-install the SharePoint Online PowerShell module

To re-install the SharePoint Online PowerShell module, use: -Force switch:

Install-Module Microsoft.Online.SharePoint.PowerShell -force

Please note, installing the PowerShell module for SharePoint Online doesn’t install “SharePoint Online Management Shell” on your PC. Still, you can run any SharePoint Online cmdlets directly in Windows PowerShell itself!

Let’s check If the SharePoint Online PowerShell Module is installed. If not, install it.

#Check if SharePoint Online PowerShell module has been installed
Try {
    Write-host "Checking if SharePoint Online PowerShell Module is Installed..." -f Yellow -NoNewline
    $SharePointOnlineModule = Get-Module -ListAvailable "Microsoft.Online.SharePoint.PowerShell"

    #Check if SharePoint Online Module is installed
    If(!$SharePointOnlineModule)
    {
        Write-host "No!" -f Green

        #Check if script is executed under elevated user permissions - Run as Administrator
        If (-NOT ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator"))
        {   
            Write-Host "Please Run this script in elevated mode (Run as Administrator)! " -NoNewline
            Read-Host "Press any key to continue"
            Exit
        }

        Write-host "Installing SharePoint Online PowerShell Module..." -f Yellow -NoNewline
        Install-Module "Microsoft.Online.SharePoint.PowerShell" -Force -Confirm:$False
        Write-host "Done!" -f Green
    }
    Else
    {
        Write-host "Yes!" -f Green
        #sharepoint online powershell module import
        Write-host "Importing SharePoint Online PowerShell Module..." -f Yellow  -NoNewline
        Import-Module "Microsoft.Online.SharePoint.PowerShell" -DisableNameChecking
        Write-host "Done!" -f Green
    }
}
Catch{
    write-host "Error: $($_.Exception.Message)" -foregroundcolor red
}

How do I connect SharePoint Online to PowerShell?

Once installed, You can connect to the SharePoint Online tenant from PowerShell and start using SharePoint Online PowerShell cmdlets. Ensure you are in the SharePoint Administrator or Global Administrator role to connect to SharePoint Online.

• Step 1: Import SharePoint Online PowerShell module
• Step 2: Connect to SharePoint Online from PowerShell using the Connect-SPOService cmdlet
• Step 3: Run PowerShell cmdlets for SharePoint Online, E.g., Get all site collections

#Import PowerShell module for SharePoint Online 
Import-Module Microsoft.Online.Sharepoint.PowerShell -DisableNameChecking

#Connect to SharePoint Online Service and create a PowerShell session
Connect-SPOService -url "https://crescent-admin.sharepoint.com" -Credential (Get-Credential)

#Get All SharePoint Sites
Get-SPOSite

This PowerShell script prompts for username and password (You can leave the credential parameter to connect from Multifactor authentication – MFA enabled account), Connects to SharePoint Online, and gets all SharePoint Online sites using Get-SPOSite cmdlet. Make sure you change the site URL according to your environment. More on connecting to SharePoint Online from PowerShell: How to Connect to SharePoint Online from PowerShell?

Update SharePoint Online PowerShell module

How to update the SharePoint Online management shell? To update the SharePoint Online PowerShell Module, use the below command:

Update-module microsoft.online.sharepoint.powershell

Type “A” to confirm Yes to All, and hit enter to update the PowerShell module for SharePoint Online.

Uninstall SharePoint Online PowerShell Module

To remove the SharePoint Online PowerShell module, use the below cmdlets:

Uninstall-Module -Name Microsoft.Online.SharePoint.PowerShell

Use the “-AllVersions” switch if you have more than one version installed. Make sure you run these cmdlets as Administrator in the PowerShell console.

SharePoint Online PowerShell commands

Once you have the SharePoint Online PowerShell module installed, You can get a list of cmdlets from the module using:

Get-command -Module Microsoft.Online.SharePoint.PowerShell

The client-side object model is a subset of the SharePoint Online PowerShell module (You don’t have to add a reference to CSOM assemblies – Client SDK components if you import the SharePoint PowerShell module). The SharePoint PnP PowerShell cmdlets also add significant value to this space. To install the SharePoint Online PnP PowerShell module, refer: Install SharePoint Online PnP PowerShell Module

Wrapping up

Installing the SharePoint Online PowerShell module is a simple process that can greatly enhance administrators’ productivity and streamline the management of SharePoint Online resources. By following the steps outlined in this article, administrators can easily install the module and start using its powerful capabilities to automate tasks and manage SharePoint Online. Whether you are working with a small or large SharePoint Online environment, the SharePoint Online PowerShell module provides a flexible and efficient way to manage your SharePoint Online tenant.