Added cmdlet

Author: KoenZomers

CHANGELOG.md

@@ -57,6 +57,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Added `HidePeopleWhoHaveListsOpen` parameter to `Set-PnPSite` cmdlet to hide people who simultaneously have lists open [#4699](https://github.com/pnp/powershell/pull/4699)
 - Added `-WhoCanShareAllowListInTenant`, `-LegacyBrowserAuthProtocolsEnabled`, `-EnableDiscoverableByOrganizationForVideos`, `-RestrictedAccessControlforSitesErrorHelpLink`, `-Workflow2010Disabled`, `-AllowSharingOutsideRestrictedAccessControlGroups`, `-HideSyncButtonOnDocLib`, `-HideSyncButtonOnODB`, `-StreamLaunchConfig`, `-EnableMediaReactions`, `-ContentSecurityPolicyEnforcement` and `-DisableSpacesActivation` to `Set-PnPTenant` [#4681](https://github.com/pnp/powershell/pull/4681)
 - Added `Start-PnPEnterpriseAppInsightsReport` and `Get-PnPEnterpriseAppInsightsReport` which allow working with App Insights repors [#4713](https://github.com/pnp/powershell/pull/4713)
+- Added `Get-PnPMicrosoft365Roadmap` which allows retrieval of the Microsoft 365 Roadmap items
 
 ### Changed
 

documentation/Get-PnPMicrosoft365Roadmap.md

@@ -0,0 +1,86 @@
+---
+Module Name: PnP.PowerShell
+title: Get-PnPMicrosoft365Roadmap
+schema: 2.0.0
+applicable: SharePoint Online
+external help file: PnP.PowerShell.dll-Help.xml
+online version: https://pnp.github.io/powershell/cmdlets/Get-PnPMicrosoft365Roadmap.html
+---
+ 
+# Get-PnPMicrosoft365Roadmap
+
+## SYNOPSIS
+
+**Required Permissions**
+
+  * None
+
+Returns all items currently on the Microsoft 365 Roadmap
+
+## SYNTAX
+
+```powershell
+Get-PnPMicrosoft365Roadmap [-RoadmapUrl <string>] [-Verbose] 
+```
+
+## DESCRIPTION
+
+Allows retrieval of the Microsoft 365 Roadmap. Pipe the output to i.e. a Where-Object to filter it down to the desired items. You do not need to be connected to any tenant to utilize this cmdlet.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```powershell
+Get-PnPMicrosoft365Roadmap
+```
+
+Retrieves all the available items currently on the Microsoft 365 Roadmap
+
+### EXAMPLE 2
+```powershell
+Get-PnPMicrosoft365Roadmap | Where-Object { $_.Status -eq "Rolling out" }
+```
+
+Retrieves the items on the Microsoft 365 Roadmap which are currently rolling out
+
+### EXAMPLE 3
+```powershell
+Get-PnPMicrosoft365Roadmap | Where-Object { $_.Created -ge (Get-Date).AddDays(-7) -or $_.Modified -ge (Get-Date).AddDays(-7) }
+```
+
+Retrieves the items on the Microsoft 365 Roadmap which have been added or modified in the last 7 days
+
+## PARAMETERS
+
+### -RoadmapUrl
+Allows passing in a custom URL to retrieve the roadmap from. It will use the default value listed below if it is not provided. In most cases you don't want to provide this parameter yourself.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: https://www.microsoft.com/releasecommunications/api/v1/m365
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Verbose
+When provided, additional debug statements will be shown while executing the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## RELATED LINKS
+
+[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
+[Microsoft 365 Roadmap](https://www.microsoft.com/microsoft-365/roadmap)

src/Commands/Model/ServiceHealth/Microsoft365RoadmapItem.cs

@@ -0,0 +1,84 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace PnP.PowerShell.Commands.Model.ServiceHealth
+{
+    /// <summary>
+    /// An item on the Microsoft 365 Roadmap
+    /// </summary>
+    public class Microsoft365RoadmapItem
+    {
+        /// <summary>
+        /// The ID of the roadmap item
+        /// </summary>
+        [JsonPropertyName("id")]
+        public int? Id { get; set; }
+
+        /// <summary>
+        /// Title of the roadmap item
+        /// </summary>
+        [JsonPropertyName("title")]
+        public string Title { get; set; }
+
+        /// <summary>
+        /// Description of the roadmap item
+        /// </summary>
+        [JsonPropertyName("description")]
+        public string Description { get; set; }
+
+        /// <summary>
+        /// An optional link to a page holding more information regarding the roadmap item
+        /// </summary>
+        [JsonPropertyName("moreInfoLink")]
+        public string MoreInfoLink { get; set; }
+
+        /// <summary>
+        /// Date at which the roadmap item is expected to become generally available
+        /// </summary>
+        [JsonPropertyName("publicDisclosureAvailabilityDate")]
+        public string PublicDisclosureAvailabilityDate { get; set; }
+
+        /// <summary>
+        /// Date at which the roadmap item is expectedo to become available in preview
+        /// </summary>
+        [JsonPropertyName("publicPreviewDate")]
+        public string PublicPreviewDate { get; set; }
+
+        /// <summary>
+        /// Date and time at which this roadmap item was initially added
+        /// </summary>
+        [JsonPropertyName("created")]
+        public DateTime? Created { get; set; }
+
+        /// <summary>
+        /// Unknown status
+        /// </summary>
+        [JsonPropertyName("publicRoadmapStatus")]
+        public string PublicRoadmapStatus { get; set; }
+
+        /// <summary>
+        /// Rollout status of the roadmap item
+        /// </summary>
+        [JsonPropertyName("status")]
+        public string Status { get; set; }
+
+        /// <summary>
+        /// Date and time at which this roadmap item has last been modified
+        /// </summary>
+        [JsonPropertyName("modified")]
+        public DateTime? Modified { get; set; }
+
+        /// <summary>
+        /// All tags applicable to this roadmap item
+        /// </summary>
+        [JsonPropertyName("tags")]
+        public List<Microsoft365RoadmapTag> Tags { get; set; }
+
+        /// <summary>
+        /// Tags applicable to this roadmap item, categorized by type of tag
+        /// </summary>
+        [JsonPropertyName("tagsContainer")]
+        public Microsoft365RoadmapTagsContainer TagsContainer { get; set; }
+    }
+}

src/Commands/Model/ServiceHealth/Microsoft365RoadmapTag.cs

@@ -0,0 +1,13 @@
+using System.Text.Json.Serialization;
+
+namespace PnP.PowerShell.Commands.Model.ServiceHealth
+{
+    /// <summary>
+    /// An tag on an item in the Microsoft 365 Roadmap
+    /// </summary>
+    public class Microsoft365RoadmapTag
+    {
+        [JsonPropertyName("tagName")]
+        public string TagName { get; set; }
+    }
+}

src/Commands/Model/ServiceHealth/Microsoft365RoadmapTagsContainer.cs

@@ -0,0 +1,35 @@
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace PnP.PowerShell.Commands.Model.ServiceHealth
+{
+    /// <summary>
+    /// A container with tags on an item in the Microsoft 365 Roadmap
+    /// </summary>
+    public class Microsoft365RoadmapTagsContainer
+    {
+        /// <summary>
+        /// All tagged products to which the roadmap item applies
+        /// </summary>
+        [JsonPropertyName("products")]
+        public List<Microsoft365RoadmapTag> Products { get; set; }
+
+        /// <summary>
+        /// All tagged cloud instances for which the roadmap item applies
+        /// </summary>
+        [JsonPropertyName("cloudInstances")]
+        public List<Microsoft365RoadmapTag> CloudInstances { get; set; }
+
+        /// <summary>
+        /// All tagged release phases that apply to the roadmap item
+        /// </summary>
+        [JsonPropertyName("releasePhase")]
+        public List<Microsoft365RoadmapTag> ReleasePhase { get; set; }
+
+        /// <summary>
+        /// All platforms for which the roadmap item applies
+        /// </summary>
+        [JsonPropertyName("platforms")]
+        public List<Microsoft365RoadmapTag> Platforms { get; set; }
+    }
+}

src/Commands/ServiceHealth/GetMicrosoft365Roadmap.cs

@@ -0,0 +1,36 @@
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using PnP.PowerShell.Commands.Model.ServiceHealth;
+
+namespace PnP.PowerShell.Commands.ServiceHealth
+{
+    [Cmdlet(VerbsCommon.Get, "PnPMicrosoft365Roadmap")]
+    [OutputType(typeof(List<Microsoft365RoadmapItem>))]
+    public class GetMicrosoft365Roadmap : PSCmdlet
+    {
+        [Parameter(Mandatory = false)]
+        public string RoadmapUrl = "https://www.microsoft.com/releasecommunications/api/v1/m365";
+
+        protected override void ProcessRecord()
+        {
+            WriteVerbose($"Retrieving the Microsoft 365 Roadmap from {RoadmapUrl}");
+
+            var response = Framework.Http.PnPHttpClient.Instance.GetHttpClient().GetAsync(RoadmapUrl).GetAwaiter().GetResult();
+            if (!response.IsSuccessStatusCode)
+            {
+                throw new PSInvalidOperationException($"Failed to retrieve the Microsoft 365 Roadmap from {RoadmapUrl}");
+            }
+
+            WriteVerbose("Successfully retrieved the Microsoft 365 Roadmap. Parsing roadmap content.");
+
+            var content = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
+            var roadmapItems = JsonSerializer.Deserialize<List<Microsoft365RoadmapItem>>(content, new JsonSerializerOptions() { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, PropertyNamingPolicy = JsonNamingPolicy.CamelCase });
+
+            WriteVerbose($"{roadmapItems.Count} item{(roadmapItems.Count != 1 ? "s" : "")} parsed");
+
+            WriteObject(roadmapItems, true);
+        }
+    }
+}