Merge pull request #2825 from KoenZomers/SetSensitivityLabelOnLibrary

Added `-DefaultSensitivityLabelForLibrary` to `Set-PnPList`

Author: gautamdsheth

CHANGELOG.md

@@ -40,6 +40,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Added `-LargeList` parameter to `Remove-PnPList` cmdlet which improves the list recycling experience for Lists containing huge number of items. [#2778](https://github.com/pnp/powershell/pull/2778)
 - Added support for specifying the ContentUrl and WebsiteUrl configuration in `Add-PnPTeamsTab` cmdlet when trying to add a SharePoint page or list as a tab in Teams channel. [#2807](https://github.com/pnp/powershell/pull/2807)
 - Added `-CheckinType` parameter to `Add-PnPFile` cmdlet which provides the option to specify the checkin type for a file. The default value is set to `MinorCheckIn`. [#2806](https://github.com/pnp/powershell/pull/2806)
+- Added `-DefaultSensitivityLabelForLibrary` to `Set-PnPList` which allows setting the default sensitivity label for a library. [#2825](https://github.com/pnp/powershell/pull/2825)
 - Added `-ApplicationId` as alias for `-ClientId` in `Connect-PnPOnline` and `Request-PnPAccessToken` cmdlets. [#2805](https://github.com/pnp/powershell/pull/2805)
 - Added `-Connection` option to `Connect-PnPOnline` which allows of reusing an authenticated connection to connect to a different site [#2821](https://github.com/pnp/powershell/pull/2821)
 - Added `-UserAssignedManagedIdentityAzureResourceId` and `-UserAssignedManagedIdentityClientId` as alternatives to `-UserAssignedManagedIdentityObjectId` for `Connect-PnPOnline -ManagedIdentity` to provide an user managed identity to authenticate with. [#2813](https://github.com/pnp/powershell/pull/2813)

documentation/Set-PnPList.md

@@ -21,7 +21,7 @@ Set-PnPList -Identity <ListPipeBind> [-EnableContentTypes <Boolean>] [-BreakRole
  [-EnableAttachments <Boolean>] [-EnableFolderCreation <Boolean>] [-EnableVersioning <Boolean>]
  [-EnableMinorVersions <Boolean>] [-MajorVersions <UInt32>] [-MinorVersions <UInt32>]
  [-EnableModeration <Boolean>] [-DraftVersionVisibility <DraftVisibilityType>] [-ReadSecurity <ListReadSecurity>] [-WriteSecurity <ListWriteSecurity>]
- [-NoCrawl] [-ExemptFromBlockDownloadOfNonViewableFiles <Boolean>] [-DisableGridEditing <Boolean>] 
+ [-NoCrawl] [-ExemptFromBlockDownloadOfNonViewableFiles <Boolean>] [-DisableGridEditing <Boolean>] [-DefaultSensitivityLabelForLibrary <SensitivityLabelPipeBind>]
  [-Path <String>] [-Connection <PnPConnection>] [<CommonParameters>]
 ```
 
@@ -79,6 +79,13 @@ Set-PnPList -Identity "Demo List" -Title "Demo List 2" -Path "Lists/DemoList2"
 
 Rename a list, including its' URL.
 
+### EXAMPLE 8
+```powershell
+Set-PnPList -Identity "Demo List" -DefaultSensitivityLabelForLibrary "Confidential"
+```
+
+Sets the default sensitivity label for a document library to Confidential.
+
 ## PARAMETERS
 
 ### -BreakRoleInheritance
@@ -165,6 +172,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -DefaultSensitivityLabelForLibrary
+The instance, Id or name of the sensitivity label to set as the default for the library. If $null is provided, the default label will be removed.
+
+```yaml
+Type: SensitivityLabelPipeBind
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -EnableAttachments
 Enable or disable attachments. Set to $true to enable, $false to disable.
 

src/Commands/Base/PipeBinds/SensitivityLabelPipeBind.cs

@@ -0,0 +1,81 @@
+using System;
+using System.Linq;
+
+namespace PnP.PowerShell.Commands.Base.PipeBinds
+{
+    public sealed class SensitivityLabelPipeBind
+    {
+        private readonly Guid? _labelId;
+        private readonly string _labelName;
+        private readonly Model.Graph.Purview.InformationProtectionLabel _label;
+
+        public SensitivityLabelPipeBind()
+        {
+            _labelId = null;
+            _labelName = string.Empty;
+        }
+
+        public SensitivityLabelPipeBind(string id)
+        {
+            if (string.IsNullOrEmpty(id))
+            {
+                throw new ArgumentException(nameof(id));
+            }
+
+            if (Guid.TryParse(id, out Guid labelId))
+            {
+                _labelId = labelId;
+            }
+            else
+            {
+                _labelName = id;
+            }
+
+            _label = null;
+        }
+
+        public SensitivityLabelPipeBind(Guid id)
+        {
+            _labelId = id;
+            _labelName = string.Empty;
+            _label = null;
+        }
+
+        public SensitivityLabelPipeBind(Model.Graph.Purview.InformationProtectionLabel label)
+        {
+            _labelId = label.Id;
+            _labelName = label.Name;
+            _label = label;
+        }
+
+        public string LabelName => _labelName;
+
+        public Guid? LabelId => _labelId;
+
+        public Model.Graph.Purview.InformationProtectionLabel Label => _label;
+
+        /// <summary>
+        /// Tries to look up the Label by the Label Name
+        /// </summary>
+        /// <param name="connection">Connection that can be used to query Microsoft Graph for the available sensitivity labels</param>
+        /// <param name="accesstoken">Access Token to use to authenticate to Microsoft Graph</param>
+        /// <returns>The the sensitivity label that matches the name set in this pipebind or NULL if no match found</returns>
+        public Model.Graph.Purview.InformationProtectionLabel GetLabelByNameThroughGraph(PnPConnection connection, string accesstoken)
+        {
+            if (string.IsNullOrEmpty(_labelName)) return null;
+
+            string url;
+            if (connection.ConnectionMethod == Model.ConnectionMethod.AzureADAppOnly)
+            {
+                url = "/beta/security/informationProtection/sensitivityLabels";
+            }
+            else
+            {
+                url = "/beta/me/security/informationProtection/sensitivityLabels";
+            }
+
+            var availableLabels = Utilities.REST.GraphHelper.GetResultCollectionAsync<Model.Graph.Purview.InformationProtectionLabel>(connection, $"https://{connection.GraphEndPoint}/{url}", accesstoken).GetAwaiter().GetResult();
+            return availableLabels.FirstOrDefault(l => l.Name == _labelName);
+        }
+    }
+}

src/Commands/Lists/SetList.cs

@@ -2,7 +2,7 @@
 
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using PnP.PowerShell.Commands.Enums;
-
+using System;
 using System.Management.Automation;
 
 namespace PnP.PowerShell.Commands.Lists
@@ -86,6 +86,9 @@ public class SetList : PnPWebCmdlet
         [Parameter(Mandatory = false)]
         public string Path;
 
+        [Parameter(Mandatory = false)]
+        public SensitivityLabelPipeBind DefaultSensitivityLabelForLibrary;        
+
         protected override void ExecuteCmdlet()
         {
             var list = Identity.GetList(CurrentWeb);
@@ -262,6 +265,48 @@ protected override void ExecuteCmdlet()
                 }
             }
 
+            if(ParameterSpecified(nameof(DefaultSensitivityLabelForLibrary)))
+            {
+                if(DefaultSensitivityLabelForLibrary == null)
+                {
+                    WriteVerbose("Removing sensitivity label from library");
+                    list.DefaultSensitivityLabelForLibrary = null;
+                    updateRequired = true;
+                }
+                else
+                {
+                    if (DefaultSensitivityLabelForLibrary.LabelId.HasValue)
+                    {
+                        WriteVerbose($"Setting provided sensitivity label id '{DefaultSensitivityLabelForLibrary.LabelId}' as the default sensitivity label for the library");
+                        list.DefaultSensitivityLabelForLibrary = DefaultSensitivityLabelForLibrary.LabelId.ToString();
+                        updateRequired = true;
+                    }
+                    else
+                    {
+                        if (!string.IsNullOrEmpty(DefaultSensitivityLabelForLibrary.LabelName))
+                        {
+                            WriteVerbose($"Looking up sensitivity label id by label name '{DefaultSensitivityLabelForLibrary.LabelName}'");
+                            var label = DefaultSensitivityLabelForLibrary.GetLabelByNameThroughGraph(Connection, GraphAccessToken);
+
+                            if (label == null || !label.Id.HasValue)
+                            {
+                                throw new ArgumentException($"Unable to find a sensitivity label with the provided name '{DefaultSensitivityLabelForLibrary.LabelName}'", nameof(DefaultSensitivityLabelForLibrary));
+                            }
+                            else
+                            {
+                                WriteVerbose($"Provided sensitivity label name '{DefaultSensitivityLabelForLibrary.LabelName}' resolved to sensitivity label id '{label.Id.Value}' and will be set as the default sensitivity label for the library");
+                                list.DefaultSensitivityLabelForLibrary = label.Id.Value.ToString();
+                                updateRequired = true;
+                            }
+                        }
+                        else
+                        {
+                            throw new ArgumentException($"Unable set the default sensitivity label for the library as there's no label name or label Id", nameof(DefaultSensitivityLabelForLibrary));
+                        }
+                    }
+                }
+            }
+
             if (updateRequired)
             {
                 list.Update();

src/Commands/Model/Graph/Purview/InformationProtectionLabel.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Text.Json.Serialization;
 
 namespace PnP.PowerShell.Commands.Model.Graph.Purview
@@ -12,7 +13,7 @@ public class InformationProtectionLabel
         /// The label ID is a globally unique identifier (GUID)
         /// </summary>
         [JsonPropertyName("id")]
-        public string Id { get; set; }
+        public Guid? Id { get; set; }
 
         /// <summary>
         /// The plaintext name of the label.

src/Commands/Purview/SetSiteSensitivityLabel.cs

@@ -29,7 +29,7 @@ protected override void ExecuteCmdlet()
                     throw new PSArgumentException($"No Microsoft Purview sensitivity label with the provided name '{Identity}' could be found", nameof(Identity));
                 }
 
-                sensitivityLabelId = label.ElementAt(0).Id;
+                sensitivityLabelId = label.ElementAt(0).Id?.ToString();
                 WriteVerbose($"Microsoft Purview label with name '{Identity}' successfully resolved to Id '{sensitivityLabelId}'");                    
             }
             else