How to Install / Update / Uninstall SharePoint Online PowerShell Module?
Requirement: Install SharePoint Online PowerShell module
The SharePoint Online PowerShell Module enables administrators to manage their SharePoint Online environments by using PowerShell cmdlets. PowerShell module for SharePoint Online is a great way to manage and automate your SharePoint environment. You can use it to perform a wide range of tasks, 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 PowerShell Gallery now! So, you can install it as a module directly from PowerShell instead of downloading and installing the 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 in your system by running the following command in the administrative mode in PowerShell:
Get-Module -Name Microsoft.Online.SharePoint.PowerShell -ListAvailable | Select Name,Version
How to Install SharePoint Online PowerShell Module?
The SharePoint Online Management Shell is a Windows PowerShell module installed in your Windows client machine or Server. 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 gives administrators the ability to manage the SharePoint Online environment using PowerShell cmdlets.
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 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"
If(!$SharePointOnlineModule)
{
Write-host "No!" -f Green
#Check if script is executed under elevated 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
}
Once installed, You can connect to SharePoint Online from PowerShell and start using SharePoint Online PowerShell cmdlets. More here: How to Connect to SharePoint Online from PowerShell?
Update SharePoint Online PowerShell module
How to update SharePoint Online management shell? To update the SharePoint Online PowerShell Module, use:
Update-module microsoft.online.sharepoint.powershell
Uninstall SharePoint Online PowerShell Module
To remove the SharePoint Online PowerShell module, use:
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
Cmdlet Name |
---|
Add-SPOGeoAdministrator |
Add-SPOHubSiteAssociation |
Add-SPOHubToHubAssociation |
Add-SPOOrgAssetsLibrary |
Add-SPOSiteCollectionAppCatalog |
Add-SPOSiteDesign |
Add-SPOSiteDesignTask |
Add-SPOSiteScript |
Add-SPOSiteScriptPackage |
Add-SPOTenantCdnOrigin |
Add-SPOTheme |
Add-SPOUser |
Approve-SPOTenantServicePrincipalPermissionGrant |
Approve-SPOTenantServicePrincipalPermissionRequest |
Connect-SPOService |
ConvertTo-SPOMigrationEncryptedPackage |
ConvertTo-SPOMigrationTargetedPackage |
Deny-SPOTenantServicePrincipalPermissionRequest |
Disable-SPOTenantServicePrincipal |
Disconnect-SPOService |
Enable-SPOCommSite |
Enable-SPOTenantServicePrincipal |
Export-SPOQueryLogs |
Export-SPOUserInfo |
Export-SPOUserProfile |
Get-IsCommSite |
Get-SPOAppErrors |
Get-SPOAppInfo |
Get-SPOBrowserIdleSignOut |
Get-SPOBuiltInDesignPackageVisibility |
Get-SPOCrossGeoMovedUsers |
Get-SPOCrossGeoMoveReport |
Get-SPOCrossGeoUsers |
Get-SPODataEncryptionPolicy |
Get-SPODeletedSite |
Get-SPOExternalUser |
Get-SPOGeoAdministrator |
Get-SPOGeoMoveCrossCompatibilityStatus |
Get-SPOGeoStorageQuota |
Get-SPOHideDefaultThemes |
Get-SPOHomeSite |
Get-SPOHubSite |
Get-SPOKnowledgeHubSite |
Get-SPOMigrationJobProgress |
Get-SPOMigrationJobStatus |
Get-SPOMultiGeoCompanyAllowedDataLocation |
Get-SPOMultiGeoExperience |
Get-SPOOrgAssetsLibrary |
Get-SPOOrgNewsSite |
Get-SPOPublicCdnOrigins |
Get-SPOSite |
Get-SPOSiteCollectionAppCatalogs |
Get-SPOSiteContentMoveState |
Get-SPOSiteDataEncryptionPolicy |
Get-SPOSiteDesign |
Get-SPOSiteDesignRights |
Get-SPOSiteDesignRun |
Get-SPOSiteDesignRunStatus |
Get-SPOSiteDesignTask |
Get-SPOSiteGroup |
Get-SPOSiteRenameState |
Get-SPOSiteScript |
Get-SPOSiteScriptFromList |
Get-SPOSiteScriptFromWeb |
Get-SPOSiteUserInvitations |
Get-SPOStorageEntity |
Get-SPOStructuralNavigationCacheSiteState |
Get-SPOStructuralNavigationCacheWebState |
Get-SPOTenant |
Get-SPOTenantCdnEnabled |
Get-SPOTenantCdnOrigins |
Get-SPOTenantCdnPolicies |
Get-SPOTenantContentTypeReplicationParameters |
Get-SPOTenantLogEntry |
Get-SPOTenantLogLastAvailableTimeInUtc |
Get-SPOTenantOrgRelation |
Get-SPOTenantOrgRelationByPartner |
Get-SPOTenantOrgRelationByScenario |
Get-SPOTenantServicePrincipalPermissionGrants |
Get-SPOTenantServicePrincipalPermissionRequests |
Get-SPOTenantSyncClientRestriction |
Get-SPOTenantTaxonomyReplicationParameters |
Get-SPOTheme |
Get-SPOUnifiedGroup |
Get-SPOUnifiedGroupMoveState |
Get-SPOUser |
Get-SPOUserAndContentMoveState |
Get-SPOUserOneDriveLocation |
Get-SPOWebTemplate |
Grant-SPOHubSiteRights |
Grant-SPOSiteDesignRights |
Invoke-SPOMigrationEncryptUploadSubmit |
Invoke-SPOSiteDesign |
Invoke-SPOSiteSwap |
New-SPOMigrationEncryptionParameters |
New-SPOMigrationPackage |
New-SPOPublicCdnOrigin |
New-SPOSdnProvider |
New-SPOSite |
New-SPOSiteGroup |
New-SPOSiteSharingReportJob |
New-SPOTenantOrgRelation |
Register-SPODataEncryptionPolicy |
Register-SPOHubSite |
Remove-SPODeletedSite |
Remove-SPOExternalUser |
Remove-SPOGeoAdministrator |
Remove-SPOHomeSite |
Remove-SPOHubSiteAssociation |
Remove-SPOHubToHubAssociation |
Remove-SPOKnowledgeHubSite |
Remove-SPOMigrationJob |
Remove-SPOMultiGeoCompanyAllowedDataLocation |
Remove-SPOOrgAssetsLibrary |
Remove-SPOOrgNewsSite |
Remove-SPOPublicCdnOrigin |
Remove-SPOSdnProvider |
Remove-SPOSite |
Remove-SPOSiteCollectionAppCatalog |
Remove-SPOSiteCollectionAppCatalogById |
Remove-SPOSiteDesign |
Remove-SPOSiteDesignTask |
Remove-SPOSiteGroup |
Remove-SPOSiteScript |
Remove-SPOSiteSharingReportJob |
Remove-SPOSiteUserInvitations |
Remove-SPOStorageEntity |
Remove-SPOTenantCdnOrigin |
Remove-SPOTenantOrgRelation |
Remove-SPOTenantSyncClientRestriction |
Remove-SPOTheme |
Remove-SPOUser |
Remove-SPOUserInfo |
Remove-SPOUserProfile |
Repair-SPOSite |
Request-SPOPersonalSite |
Request-SPOUpgradeEvaluationSite |
Restore-SPODataEncryptionPolicy |
Restore-SPODeletedSite |
Revoke-SPOHubSiteRights |
Revoke-SPOSiteDesignRights |
Revoke-SPOTenantServicePrincipalPermission |
Revoke-SPOUserSession |
Set-SPOBrowserIdleSignOut |
Set-SPOBuiltInDesignPackageVisibility |
Set-SPOGeoStorageQuota |
Set-SPOHideDefaultThemes |
Set-SPOHomeSite |
Set-SPOHubSite |
Set-SPOKnowledgeHubSite |
Set-SPOMigrationPackageAzureSource |
Set-SPOMultiGeoCompanyAllowedDataLocation |
Set-SPOMultiGeoExperience |
Set-SPOOrgAssetsLibrary |
Set-SPOOrgNewsSite |
Set-SPOSite |
Set-SPOSiteDesign |
Set-SPOSiteGroup |
Set-SPOSiteOffice365Group |
Set-SPOSiteScript |
Set-SPOSiteScriptPackage |
Set-SPOStorageEntity |
Set-SPOStructuralNavigationCacheSiteState |
Set-SPOStructuralNavigationCacheWebState |
Set-SPOTenant |
Set-SPOTenantCdnEnabled |
Set-SPOTenantCdnPolicy |
Set-SPOTenantContentTypeReplicationParameters |
Set-SPOTenantSyncClientRestriction |
Set-SPOTenantTaxonomyReplicationParameters |
Set-SPOUnifiedGroup |
Set-SPOUser |
Set-SPOWebTheme |
Start-SPOSiteContentMove |
Start-SPOSiteRename |
Start-SPOUnifiedGroupMove |
Start-SPOUserAndContentMove |
Stop-SPOSiteContentMove |
Stop-SPOUserAndContentMove |
Submit-SPOMigrationJob |
Test-SPOSite |
Unregister-SPOHubSite |
Update-SPODataEncryptionPolicy |
Update-UserType |
Upgrade-SPOSite |
Verify-SPOTenantOrgRelation |
To install the SharePoint Online PnP PowerShell module, refer: Install SharePoint Online PnP PowerShell Module
Great Thank you!
WOW This is the best, most educational and useful site on SharePoint I’ve ever seen.
THANKS!!