SharePoint Online: Activate Feature using PowerShell

Requirement: Activate a feature in SharePoint online site collection using PowerShell.

Solution: In SharePoint On-Premises, We use: Enable-SPFeature cmdlet to activate/enable features. In SharePoint online there is no such cmdlet available through PowerShell to activate feature. But we can utilize Client Side Object Model (CSOM) to activate feature in SharePoint online. Lets activate "SharePoint Server Publishing Infrastructure" feature. Here is an example for SharePoint Online PowerShell to activate a site collection feature:
Make sure you have SharePoint online Client SDK installed on your client machine to use this code. You can download it from: https://www.microsoft.com/en-us/download/details.aspx?id=42038

SharePoint Online: PowerShell Script to Enable Feature
Activating a feature makes the functionality associated with the feature available. It could bring new functionality or new artifacts like lists and libraries, etc. Here is how to activate a site feature in SharePoint Online:
  1. Navigate to the site where the feature needs to be activated.
  2. On the site's home page, click the Settings gear icon and then Site Settings option from the Settings menu.
  3. On the Site Settings page, Click the "Manage Site Features" link under Site Actions section.
  4. On the Site Features page, click on Activate button next to the site feature you desire to activate. E.g. Publishing feature
  5. The feature status is changed to Active and the associated feature capabilities are enabled in the site.sharepoint online activate publishing feature powershell
PowerShell to Enable Site Collection Feature in SharePoint Online
Lets activate a SharePoint Online feature using PowerShell
#Load SharePoint CSOM Assemblies
Import-Module Microsoft.Online.SharePoint.Powershell

#Variables for Processing
$SiteURL = "https://crescent.sharepoint.com/Sites/Sales"
$FeatureGUID =[System.GUID]("f6924d36-2fa8-4f0b-b16d-06b7250180fa") #Publishing Feature ID
$LoginName ="Salaudeen@crescent.OnMicrosoft.com"
$LoginPassword ="Password" 

#Get the Client Context
$ctx = New-Object Microsoft.SharePoint.Client.ClientContext($SiteURL)

#Login Credentials
$SecurePWD = ConvertTo-SecureString $LoginPassword –asplaintext –force  
$Credential = new-object -typename System.Management.Automation.PSCredential -argumentlist $LoginName, $SecurePWD
$ctx.Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Credential.UserName,$Credential.Password)

#Get the Site
$site = $ctx.site

#sharepoint online powershell activate feature
$site.Features.Add($FeatureGUID, $force, [Microsoft.SharePoint.Client.FeatureDefinitionScope]::farm)    

$ctx.ExecuteQuery()  
write-host "Feature has been Activated!" 
This PowerShell enables publishing features in SharePoint Online.

SharePoint Online: PowerShell to Activate Feature
Let's Add some error handling to the above code such as "check if feature is activated already" and create a reusable function to the PowerShell to enable feature SharePoint Online.
#Load SharePoint Online CSOM Assemblies
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"

#Function to Enable Feature in SharePoint Online
Function Enable-SPOFeature 
{ 
    param ($SiteCollURL,$UserName,$Password,$FeatureGuid)
    Try 
    {     
        #Setup the context
        $Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($SiteCollURL)
        $Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Username, $Password)
        $Ctx.Credentials = $Credentials
        $Site=$Ctx.Site

        #Check the Feature Status
        $FeatureStatus =  $Site.Features.GetById($FeatureGuid)
        $FeatureStatus.Retrieve("DefinitionId")
        $Ctx.Load($FeatureStatus)
        $Ctx.ExecuteQuery()

        #Activate the feature if its not enabled already
        if($FeatureStatus.DefinitionId -eq $null)
        {
            Write-Host "Enabling Feature $FeatureGuid..." -ForegroundColor Yellow
            $Site.Features.Add($FeatureGuid, $true, [Microsoft.SharePoint.Client.FeatureDefinitionScope]::None) | Out-Null
            $Ctx.ExecuteQuery()
            Write-Host "Feature Enabled on site $SiteCollURL!" -ForegroundColor Green
        }
        else
        {
            Write-host "Feature is Already Active on the Site collection!" -ForegroundColor Red
        }
    } 
    Catch
    {
        write-host "Error: $($_.Exception.Message)" -foregroundcolor Red
    }
}
 
#Parameters to Activate Feature
$SiteCollURL = "https://Crescent.sharepoint.com/sites/Demo"
$UserName = "SPAdmin@Crescent.com"
$Password = "Password goes here"
$FeatureGuid= [System.Guid] ("f6924d36-2fa8-4f0b-b16d-06b7250180fa") #Publishing Feature
$SecurePassword= ConvertTo-SecureString $Password –asplaintext –force  

#sharepoint online enable feature powershell
Enable-SPOFeature -SiteCollURL $SiteCollURL -UserName $UserName -Password $SecurePassword -FeatureGuid $FeatureGuid
This activates SharePoint Server Publishing Infrastructure feature in SharePoint online.

How to Activate Site Feature (Web) using PowerShell?
While the above code activates site collection level feature, the same code can be used to activate any web level feature as well. Simply change the line:
$Site=$Ctx.site 
To
$Site=$Ctx.web 
Also set the GUID for web level feature! This activates feature using PowerShell in SharePoint online.

PnP PowerShell to Enable Publishing Feature in SharePoint Online:
Let's activate a SharePoint Online feature using PnP PowerShell at site collection level
#Config Variable
$SiteURL = "https://crescenttech.sharepoint.com/Sites/Procurement"
$FeatureId = "f6924d36-2fa8-4f0b-b16d-06b7250180fa" #Site Scoped Publishing Feature

#Connect to PNP Online
Connect-PnPOnline -Url $SiteURL -Credentials (Get-Credential)

#get the Feature
$Feature = Get-PnPFeature -Scope Site -Identity $FeatureId 

#Get the Feature status
If($Feature.DefinitionId -eq $null)
{    
    #sharepoint online powershell enable feature
    Write-host -f Yellow "Activating Feature..."
    Enable-PnPFeature -Scope Site -Identity $FeatureId -Force

    Write-host -f Green "Feature Activated Successfully!"
}
Else
{
    Write-host -f Yellow "Feature is already active!"
}
Similarly, you can activate publishing feature using PnP PowerShell at web scope as:
#Config Variable
$SiteURL = "https://crescenttech.sharepoint.com/Sites/Procurement"
$FeatureId = "94c94ca6-b32f-4da9-a9e3-1f3d343d7ecb" #Web Scoped Publishing Feature

#Connect to PNP Online
Connect-PnPOnline -Url $SiteURL -Credentials (Get-Credential)

#get the Feature
$Feature = Get-PnPFeature -Scope Web -Identity $FeatureId 

#Get the Feature status
If($Feature.DefinitionId -eq $null)
{    
    #Activate the Feature
    Write-host -f Yellow "Activating Feature..."
    Enable-PnPFeature -Scope Web -Identity $FeatureId -Force

    Write-host -f Green "Feature Activated Successfully!"
}
Else
{
    Write-host -f Yellow "Feature is already active!"
}
To disable a feature in SharePoint Online using PowerShell, refer: SharePoint Online: Deactivate Feature using PowerShell
SharePoint Online: Activate Feature using PowerShell SharePoint Online: Activate Feature using PowerShell Reviewed by Salaudeen Rajack on January 03, 2015 Rating: 5

7 comments:

  1. What changes will be applicable for SharePoint on premises.

    ReplyDelete
  2. How do you find the feature guid id in SPO?

    ReplyDelete
  3. Thank you very much for your help. This tutorial is great!

    I'm getting a Exception at line 11 ctx.ExecuteQuery()

    Exception calling "ExecuteQuery" with "0" argument(s): "Specified method is not supported."
    At line:11 char:1
    + $ctx.ExecuteQuery()
    + ~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : NotSpecified: (:) [], MethodInvocationException
    + FullyQualifiedErrorId : ServerException

    What do you think this could be?

    ReplyDelete
  4. How to deactivate SharePoint Online feature using Powershell?

    ReplyDelete

Please Login and comment to get your questions answered!

Powered by Blogger.