Command update - spo tenant settings set #5352

ganesh-sanap · 2023-07-27T13:56:55Z

Type

Bug Fix
New Feature
Sample

Related Issues?

Closes #5034

What is in this Pull Request ?

Added around 33 new options/parameters to spo tenant settings set cmdlet as discussed in issue #5034.

nicodecleyre · 2023-07-28T07:45:02Z

Amazing work @ganesh-sanap 👏 Looking forward in using these new options (especially IsLoopEnabled 🤭). You rock 🤩

milanholemans · 2023-07-28T15:37:57Z

Thank you @ganesh-sanap, we'll try to review it ASAP!

ganesh-sanap · 2023-08-22T10:00:38Z

@milanholemans Any update on this PR?

milanholemans · 2023-08-23T06:57:07Z

@ganesh-sanap not yet no. As you can see, we have quite some PRs to process at the moment and we only do this in our free time. Also, I haven't really had time for the past few days. We will try to process it ASAP.

Thank you for being so patient.

ganesh-sanap · 2023-10-01T06:41:52Z

Hi @milanholemans, Any updates on this PR? Thank you!

milanholemans · 2023-10-01T09:44:34Z

Hi @ganesh-sanap we had a busy month to release the new major version of CLI. Because this PR is quite large I wasn't able to include it in that release. Will try my best in the coming weeks to review it. Sorry for the delay.

milanholemans · 2023-12-25T12:40:08Z

Hi, @ganesh-sanap it's been a while since this PR was raised. The last couple of months were quite busy for me. During this time, some PRs were merged and changed stuff to CLI. Could you rebase with the latest main version and fix the few errors?
This will speed up the review process which I'll try to complete in the coming weeks.

Thanks!

ganesh-sanap · 2023-12-30T11:25:59Z

@milanholemans Can you help with the steps or commands for rebasing with latest main branch to my local branch (spo-tenant-settings-set-bulk) without loosing changes made to my local branch?

milanholemans · 2023-12-30T17:05:23Z

Hi @ganesh-sanap definitely!

The best way to do this is by syncing your fork on GitHub with the latest changes and pulling these changes locally on your main branch.

Then you switch back to your feature branch and:

# Rebase to main
git rebase main

# Fix merge conflicts in VS Code, when ready click 'Continue' in VS Code.

# When done, push to GitHub, force flag is important! Don't push using VS Code.
git push --force

You can add commits that are added later as usual.

ganesh-sanap · 2023-12-31T10:10:19Z

Thank you @milanholemans! I have done all the changes and marked this PR for your review.

milanholemans · 2023-12-31T12:33:55Z

Thank you @ganesh-sanap! Will start reviewing in the coming days (looking at the size of the PR, it will take awhile).

milanholemans

Fantastic work so far @ganesh-sanap! Love to see all the new options. Because this PR will take some time to complete, I will review it in pieces.
Right now I've only reviewed the docs. I made a few comments along the way. Could you take a look at them, please?

One small point of attention, let's try to end every description with a period (.), because they are all sentences.

Will try to review the code part of the PR ASAP in the coming weeks.

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

milanholemans

Hi @ganesh-sanap

I did a second review of the docs. I feel we're almost there, could you make these few adjustments before we proceed to the code?

Thank you for the awesome work! It's much appreciated.

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

milanholemans · 2024-02-04T21:49:07Z

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

+: Allowed values `Edit`, `View`, `LimitedEdit`, `LimitedView`, `ManageList`, `None`, `Owner`, `RestrictedView`, `Review`, `Submit`
+
+`--ContainerLoopDefaultShareLinkRole [ContainerLoopDefaultShareLinkRole]`
+: Allowed values `Edit`, `View`, `LimitedEdit`, `LimitedView`, `ManageList`, `None`, `Owner`, `RestrictedView`, `Review`, `Submit`


There's indeed not much information. But since we have the description for ContainerDefaultShareLinkRole I think this setting is the same but for Loop components.

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

milanholemans · 2024-02-04T21:51:16Z

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

+: Allowed values `Anyone`, `Organization`, `SpecificPeople`, `Uninitialized`
+
+`--ContainerLoopDefaultShareLinkScope [ContainerLoopDefaultShareLinkScope]`
+: Allowed values `Anyone`, `Organization`, `SpecificPeople`, `Uninitialized`


Since we have the description for ContainerDefaultShareLinkScope, we can use that one, only this setting is about Loop components.

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

ganesh-sanap · 2024-02-08T11:56:50Z

@milanholemans Pushed commit with required changes, thanks for review!

milanholemans

Hi @ganesh-sanap review number 3 is here 😊
Please could you check the comments I made so far? Haven't been able to test all options yet. Tested the first 20 options and encountered 10 options with issues. Seems like we have the most issues with ...Role options. So it could be a good idea to recheck all these options.

Thanks again for the great work so far!

src/m365/spo/commands/tenant/tenant-settings-set.ts

docs/docs/cmd/spo/tenant/tenant-settings-set.mdx

src/m365/spo/commands/tenant/tenant-settings-set.ts

milanholemans · 2024-02-23T22:55:39Z

@ganesh-sanap don't want to put any stress on you at all, but did you find some time to look at the comments I made? Maybe you have lost sight of this? I wouldn't want this valuable work to be lost.

ganesh-sanap · 2024-02-29T17:08:36Z

I will have a look and work on it @milanholemans.

milanholemans · 2024-03-13T19:38:20Z

Hi @ganesh-sanap did you lose track of this? Don't want to put any pressure just double-checking.

milanholemans · 2024-04-01T15:01:18Z

Hi @ganesh-sanap do you still want to work on this? No problem if you don't have enough time, we can always open it up for someone else.

ganesh-sanap · 2024-04-02T07:33:07Z

@milanholemans sorry for delay. I am working on it. I have few questions about changes requested, will ask separately. Thanks!

milanholemans

Hi @ganesh-sanap, this is a bit annoying, but I would really like to include a few useful options:

ExpireVersionsAfterDays (number)
MajorVersionLimit (number)
EnableAutoExpirationVersionTrim (boolean)

You can find more info about them here: https://learn.microsoft.com/en-us/powershell/module/sharepoint-online/set-spotenant?view=sharepoint-ps

ganesh-sanap · 2024-04-19T11:26:26Z

@milanholemans sure, I will look into those options.

milanholemans · 2024-05-06T21:45:43Z

@ganesh-sanap are you still willing to work on this? How do you see this issue? Is it too big/too much work? Is it unclear? Are you still interested in it? You are welcome to answer honestly so we can find a way out.

ganesh-sanap · 2024-05-07T17:16:10Z

Hi @milanholemans, I have completed all PR review changes except restricting enum values for ~LinkRole options, currently working on it. Hopefully I will complete it by this week and send it again for your review.

Regarding adding new options (ExpireVersionsAfterDays, MajorVersionLimit, EnableAutoExpirationVersionTrim), I checked the logic in PnP PowerShell code and I think these options requires checking existing tenant setting values & adding some rules/errors based on it - this will take more time. Shall we do this in separate issue/PR? Thanks!

milanholemans · 2024-05-07T21:52:00Z

Regarding adding new options (ExpireVersionsAfterDays, MajorVersionLimit, EnableAutoExpirationVersionTrim), I checked the logic in PnP PowerShell code and I think these options requires checking existing tenant setting values & adding some rules/errors based on it - this will take more time. Shall we do this in separate issue/PR? Thanks!

Is it that complicated? Aren't these just number and boolean fields?

ganesh-sanap · 2024-05-08T17:21:23Z

@milanholemans while passing the options (ExpireVersionsAfterDays and MajorVersionLimit) to the command, first we have to check the existing value of EnableAutoExpirationVersionTrim tenant property. We have to allow updating ExpireVersionsAfterDays and MajorVersionLimit properties only when EnableAutoExpirationVersionTrim property is set to false.

I think we will have to do the GET call to tenant settings for adding these type of validation rules before updating the property values using this command. So, this will not be a simple change like other number and boolean fields.

milanholemans · 2024-05-09T13:19:33Z

@milanholemans while passing the options (ExpireVersionsAfterDays and MajorVersionLimit) to the command, first we have to check the existing value of EnableAutoExpirationVersionTrim tenant property. We have to allow updating ExpireVersionsAfterDays and MajorVersionLimit properties only when EnableAutoExpirationVersionTrim property is set to false.

Technically speaking, we should indeed. But is this really limited by the API itself? Does it throw an error if you don't?
This command is so gigantic that it's nearly impossible to build validations for every command. Also would it make it quite unclear in my opinion.

milanholemans · 2024-07-20T10:21:56Z

Hi @ganesh-sanap. I know this PR is taking a while, but I haven't forgotten about it. We're currently preparing a V8 release with CLI which consumed quite some time from my side. I will try to find some time to do another review for this big PR. Maybe in the meantime you could rebase with the latest main and resolve the merge conflict to make it go a little bit faster?

milanholemans

I did another partial review of the command logic @ganesh-sanap. Could you take a look at the comments I made, please?
Pardon me for the long silent period.
Can you also make sure that the code is rebased with the latest main, please?

milanholemans · 2024-08-04T21:47:19Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

-  SharingCapability: string; // <SharingCapabilities>
+  NoAccessRedirectUrl?: string;
+  ArchiveRedirectUrl?: string;
+  ConditionalAccessPolicyErrorHelpLink?: string;


I'm unable to clear this value:

milanholemans · 2024-08-04T21:54:01Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

+  NoAccessRedirectUrl?: string;
+  ArchiveRedirectUrl?: string;
+  ConditionalAccessPolicyErrorHelpLink?: string;
+  CustomizedExternalSharingServiceUrl?: string;


Can we set this value to null when an empty string is passed?

This comment is for which option/parameter exactly?

Comments always apply to the last line displayed, so in this case, it should be CustomizedExternalSharingServiceUrl.

milanholemans · 2024-08-04T21:54:04Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

+  ArchiveRedirectUrl?: string;
+  ConditionalAccessPolicyErrorHelpLink?: string;
+  CustomizedExternalSharingServiceUrl?: string;
+  LabelMismatchEmailHelpLink?: string;


Can we set this value to null when an empty string is passed?

milanholemans · 2024-08-04T22:23:29Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

@@ -179,36 +326,70 @@ class SpoTenantSettingsSetCommand extends SpoCommand {
  #initTelemetry(): void {
    this.telemetry.push((args: CommandArgs) => {
      const telemetryProps: any = {


From what I can see, we're missing some telemetry options:

CoreRequestFilesLinkEnabled
OneDriveRequestFilesLinkEnabled
DisableDocumentLibraryDefaultLabeling
DisableVivaConnectionsAnalytics
DisplayNamesOfFileViewersInSpo
EnableAIPIntegration
EnableRestrictedAccessControl
ExternalUserExpirationRequired
HideSyncButtonOnDocLib
IncludeAtAGlanceInShareEmails
InformationBarriersSuspension
IsFluidEnabled
IsWBFluidEnabled
IsCollabMeetingNotesFluidEnabled
IsEnableAppAuthPopUpEnabled
IsLoopEnabled
OneDriveDefaultLinkToExistingAccess
ContainerDefaultLinkToExistingAccess
ReduceTempTokenLifetimeEnabled
ShowOpenInDesktopOptionForSyncedFiles
ShowPeoplePickerGroupSuggestionsForIB
SiteOwnerManageLegacyServicePrincipalEnabled
StopNew2010Workflows
StopNew2013Workflows
ViewersCanCommentOnMediaDisabled
AllowEveryoneExceptExternalUsersClaimInPrivateSite
AnyoneLinkTrackUsers
HasAdminCompletedCUConfiguration
HasIntelligentContentServicesCapability
HasTopicExperiencesCapability
MachineLearningCaptureEnabled
MassDeleteNotificationDisabled
MobileFriendlyUrlEnabledInTenant
EnableAutoNewsDigest
AllowCommentsTextOnEmailEnabled
CommentsOnFilesDisabled
DisableAddToOneDrive
DisableBackToClassic
DisablePersonalListCreation
ViewInFileExplorerEnabled
AllowGuestUserShareToUsersNotInSiteCollection
BlockSendLabelMismatchEmail
CoreDefaultLinkToExistingAccess

milanholemans · 2024-08-04T22:29:04Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

  public getAllEnumOptions(): string[] {
-    return ['SharingCapability', 'SharingDomainRestrictionMode', 'DefaultSharingLinkType', 'ODBMembersCanShare', 'ODBAccessRequests', 'FileAnonymousLinkType', 'FolderAnonymousLinkType', 'DefaultLinkPermission', 'ConditionalAccessPolicy', 'LimitedAccessFileType', 'SpecialCharactersStateInFileFolderNames'];
+    return ['SharingCapability', 'CoreSharingCapability', 'ODBSharingCapability', 'ContainerSharingCapability', 'CoreDefaultShareLinkRole', 'CoreLoopDefaultSharingLinkRole', 'ContainerDefaultShareLinkRole', 'ContainerLoopDefaultShareLinkRole', 'OneDriveDefaultShareLinkRole', 'OneDriveLoopDefaultSharingLinkRole', 'CoreDefaultShareLinkScope', 'CoreLoopDefaultSharingLinkScope', 'ContainerDefaultShareLinkScope', 'ContainerLoopDefaultShareLinkScope', 'OneDriveDefaultShareLinkScope', 'OneDriveLoopDefaultSharingLinkScope', 'SharingDomainRestrictionMode', 'DefaultSharingLinkType', 'ODBMembersCanShare', 'ODBAccessRequests', 'AllowAnonymousMeetingParticipantsToAccessWhiteboards', 'FileAnonymousLinkType', 'FolderAnonymousLinkType', 'DefaultLinkPermission', 'ConditionalAccessPolicy', 'LimitedAccessFileType', 'MediaTranscription', 'MediaTranscriptionAutomaticFeatures', 'ImageTaggingOption', 'MarkNewFilesSensitiveByDefault', 'OCRModeForAdminSites', 'OCRModeForComplianceODBs', 'OCRModeForComplianceSites', 'SpecialCharactersStateInFileFolderNames'];
+  }
+
+  public getAllRoleOptions(): string[] {
+    return ['CoreDefaultShareLinkRole', 'CoreLoopDefaultSharingLinkRole', 'ContainerDefaultShareLinkRole', 'ContainerLoopDefaultShareLinkRole', 'OneDriveDefaultShareLinkRole', 'OneDriveLoopDefaultSharingLinkRole'];
  }


Instead of functions, can't we use just an array like we do with boolean options?

milanholemans · 2024-08-04T22:32:00Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

+  private getMediaTranscriptionPolicyType(): string[] { return ['Enabled', 'Disabled']; }
+  private getMediaTranscriptionAutomaticFeaturesPolicyType(): string[] { return ['Enabled', 'Disabled']; }
+  private getImageTaggingChoice(): string[] { return ['Disabled', 'Basic', 'Enhanced']; }
+  private getSensitiveByDefaultState(): string[] { return ['AllowExternalSharing', 'BlockExternalSharing']; }
+  private getObjectCharacterRecognitionMode(): string[] { return ['Disabled', 'InclusionList', 'ExclusionList']; }
+  private getSharingScope(): string[] { return ['Uninitialized', 'Anyone', 'Organization', 'SpecificPeople']; }


Instead of functions, let's use private variables.

milanholemans · 2024-08-04T22:33:40Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

+              this.getAllRoleOptions().indexOf(propertyKey) > -1) {
+              const role: Role = Role[(propertyValue.trim() as keyof typeof Role)];
+              if (role === undefined || role === null) {
+                return `${propertyKey} option has invalid value of "${propertyValue}". Allowed values are: ${this.RoleMap.join(", ")}.`;
+              }
+            }


Why do we need this? Normally all values listed in the autocomplete property should be correct input.

milanholemans · 2024-08-04T22:37:54Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

+        if (this.getAllRoleOptions().indexOf(optionKey) > -1) {
+          // map enum values to int
+          optionValue = Role[(args.options[optionKey].trim() as keyof typeof Role)].valueOf();
+        }


Can't we just treat these values as enums? This logic is already present.

milanholemans · 2024-08-04T22:57:03Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

+            propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="String">${optionValue}</Parameter></SetProperty>`;
+          }
+          else {
+            propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="Null">${null}</Parameter></SetProperty>`;


Can't we simplify this?

Suggested change

propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="Null">${null}</Parameter></SetProperty>`;

propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="Null" /></SetProperty>`;

milanholemans · 2024-08-04T23:01:22Z

src/m365/spo/commands/tenant/tenant-settings-set.ts

@@ -637,6 +1137,15 @@ class SpoTenantSettingsSetCommand extends SpoCommand {
          });
          propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="Array">${valuesXml}</Parameter></SetProperty><Method Name="Update" Id="${id++}" ObjectPathId="7" />`;
        }
+        else if (['LabelMismatchEmailHelpLink'].indexOf(optionKey) > -1) {


Is this something we could apply to all options instead of just this one?

milanholemans · 2024-09-12T09:56:00Z

Hi @ganesh-sanap, are you still willing to continue this PR?

ganesh-sanap · 2024-09-15T06:10:34Z

Yes, I will look into review comments.

ganesh-sanap mentioned this pull request Jul 27, 2023

[Enhancement] - Add more options to spo tenant settings set #5034

Open

milanholemans self-assigned this Sep 4, 2023

milanholemans marked this pull request as draft December 25, 2023 12:40

ganesh-sanap force-pushed the spo-tenant-settings-set-bulk branch from a9a8098 to 6a878e8 Compare December 31, 2023 09:15

ganesh-sanap marked this pull request as ready for review December 31, 2023 10:05

milanholemans requested changes Jan 17, 2024

View reviewed changes

milanholemans marked this pull request as draft January 17, 2024 23:28

ganesh-sanap marked this pull request as ready for review January 25, 2024 11:21

milanholemans requested changes Feb 4, 2024

View reviewed changes

milanholemans marked this pull request as draft February 4, 2024 22:32

ganesh-sanap marked this pull request as ready for review February 8, 2024 11:55

milanholemans requested changes Feb 13, 2024

View reviewed changes

milanholemans marked this pull request as draft February 13, 2024 20:18

milanholemans added the waiting on response label Feb 23, 2024

milanholemans removed the waiting on response label Feb 29, 2024

milanholemans added the waiting on response label Apr 1, 2024

milanholemans removed the waiting on response label Apr 13, 2024

milanholemans requested changes Apr 17, 2024

View reviewed changes

ganesh-sanap marked this pull request as ready for review May 8, 2024 17:21

ganesh-sanap requested a review from milanholemans July 20, 2024 07:08

milanholemans requested changes Aug 5, 2024

View reviewed changes

milanholemans marked this pull request as draft August 5, 2024 00:10

milanholemans added the waiting on response label Sep 12, 2024

Jwaegebaert removed the waiting on response label Sep 16, 2024

ganesh-sanap force-pushed the spo-tenant-settings-set-bulk branch from 9cd907c to fb20cac Compare September 22, 2024 08:24

Command update - spo tenant settings set

a1baff4

ganesh-sanap force-pushed the spo-tenant-settings-set-bulk branch from fb20cac to a1baff4 Compare October 13, 2024 07:17

	propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="Null">${null}</Parameter></SetProperty>`;
	propsXml += `<SetProperty Id="${id++}" ObjectPathId="7" Name="${optionKey}"><Parameter Type="Null" /></SetProperty>`;

Command update - spo tenant settings set #5352

Are you sure you want to change the base?

Command update - spo tenant settings set #5352

Conversation

ganesh-sanap commented Jul 27, 2023

Type

Related Issues?

What is in this Pull Request ?

nicodecleyre commented Jul 28, 2023

milanholemans commented Jul 28, 2023

ganesh-sanap commented Aug 22, 2023

milanholemans commented Aug 23, 2023

ganesh-sanap commented Oct 1, 2023

milanholemans commented Oct 1, 2023

milanholemans commented Dec 25, 2023

ganesh-sanap commented Dec 30, 2023

milanholemans commented Dec 30, 2023 • edited Loading

ganesh-sanap commented Dec 31, 2023

milanholemans commented Dec 31, 2023

milanholemans left a comment • edited Loading

Choose a reason for hiding this comment

milanholemans left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ganesh-sanap commented Feb 8, 2024

milanholemans left a comment

Choose a reason for hiding this comment

milanholemans commented Feb 23, 2024

ganesh-sanap commented Feb 29, 2024

milanholemans commented Mar 13, 2024

milanholemans commented Apr 1, 2024

ganesh-sanap commented Apr 2, 2024

milanholemans left a comment

Choose a reason for hiding this comment

ganesh-sanap commented Apr 19, 2024

milanholemans commented May 6, 2024

ganesh-sanap commented May 7, 2024 • edited Loading

milanholemans commented May 7, 2024

ganesh-sanap commented May 8, 2024

milanholemans commented May 9, 2024

milanholemans commented Jul 20, 2024

milanholemans left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

milanholemans commented Sep 12, 2024

ganesh-sanap commented Sep 15, 2024

milanholemans commented Dec 30, 2023 •

edited

Loading

milanholemans left a comment •

edited

Loading

ganesh-sanap commented May 7, 2024 •

edited

Loading

milanholemans left a comment •

edited

Loading