Added GetPnPSiteHistoricalVersionsStatus

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Updated `Get/Set-PnPSearchSettings` with an option `-SearchBoxPlaceholderText` to set search placeholder text for the SPO nav bar search box 
 - Added Set-PnPTermGroup cmdlet to update an existing taxonomy term group.
 - Added Set-PnPTeamifyPromptHidden to hide the teamify prompt on a group connected Team Site (modern team site)
+- Added Get-PnPSiteHistoricalVersionsStatus to get information about the Historical Versions feature related to Search
 
 ### Changed
 - Changed the client id of the application used behind the scenes when authenticating to a tenant where Legacy Authentication has been turned off. We now by default utilize the PnP Management Shell application. If you have not provided consent you will be prompted with a message on how to provide consent.

Commands/PnP.PowerShell.Commands.csproj

@@ -806,6 +806,7 @@
     <Compile Include="RecordsManagement\SetListRecordDeclaration.cs" />
     <Compile Include="Search\GetSearchCrawlLog.cs" />
     <Compile Include="Search\GetSearchSettings.cs" />
+    <Compile Include="Search\GetSiteHistoricalVersionsStatus.cs" />
     <Compile Include="Search\SetSearchSettings.cs" />
     <Compile Include="Enums\SearchSettingsScope.cs" />
     <Compile Include="SiteDesigns\GetSiteDesignTask.cs" />

Commands/Search/GetSiteHistoricalVersionsStatus.cs

@@ -0,0 +1,56 @@
+#if !ONPREMISES
+using System.Collections.Generic;
+using System.Management.Automation;
+using Microsoft.SharePoint.Client;
+using Microsoft.SharePoint.Client.Search.Administration;
+using PnP.PowerShell.CmdletHelpAttributes;
+
+namespace PnP.PowerShell.Commands.Search
+{
+    [Cmdlet(VerbsCommon.Get, "PnPSiteHistoricalVersionsStatus", DefaultParameterSetName = "Xml")]
+    [CmdletHelp("Returns information about the Historical Versions feature for the current site collection from the context. " +
+       "The document statistics are only updated periodically, check the next update time property (in UTC) to see when new data will be available.",
+        SupportedPlatform = CmdletSupportedPlatform.Online,
+        Category = CmdletHelpCategory.Search)]
+    [CmdletExample(
+        Code = @"PS:> Get-PnPSiteHistoricalVersionsStatus",
+        Remarks = "Returns the status of the feature as well as the number of documents processed for the site if the feature is enabled.",
+        SortOrder = 1)]
+    public class GetSiteHistoricalVersionsStatus : PnPWebCmdlet
+    {
+
+        protected override void ExecuteCmdlet()
+        {
+            var siteLog = new SiteCrawlLog(ClientContext, ClientContext.Site);
+            ClientContext.Load(siteLog);
+
+            var resultTable = siteLog.GetHistoricalVersionsStatus();
+            ClientContext.ExecuteQueryRetry();
+
+            if (resultTable.Value == null || resultTable.Value.Rows.Count == 0)
+            {
+                WriteWarning("No information was obtained for the current site");
+            }
+            else
+            {
+                // The API should only return 1 row
+                WriteObject(ConvertToPSObject(resultTable.Value.Rows[0]));
+            }
+
+        }
+
+        private object ConvertToPSObject(IDictionary<string, object> r)
+        {
+            PSObject res = new PSObject();
+            if (r != null)
+            {
+                foreach (var kvp in r)
+                {
+                    res.Properties.Add(new PSNoteProperty(kvp.Key, kvp.Value));
+                }
+            }
+            return res;
+        }
+    }
+}
+#endif