@pnp/cli-microsoft365 5.8.0 → 5.9.0-beta.1672f8f

package/dist/utils/spo.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.spo = void 0;
 const url = require("url");
-const _1 = require(".");
+const urlUtil_1 = require("./urlUtil");
+const validation_1 = require("./validation");
 const Auth_1 = require("../Auth");
 const config_1 = require("../config");
 const base_permissions_1 = require("../m365/spo/base-permissions");
@@ -20,7 +21,7 @@ exports.spo = {
     },
     ensureFormDigest(siteUrl, logger, context, debug) {
         return new Promise((resolve, reject) => {
-            if (_1.validation.isValidFormDigest(context)) {
+            if (validation_1.validation.isValidFormDigest(context)) {
                 if (debug) {
                     logger.logToStderr('Existing form digest still valid');
                 }
@@ -255,7 +256,7 @@ exports.spo = {
             webFullUrl[webFullUrlLastCharPos] === '/') {
             webFullUrl = webFullUrl.substring(0, webFullUrlLastCharPos);
         }
-        folderToEnsure = _1.urlUtil.getWebRelativePath(webFullUrl, folderToEnsure);
+        folderToEnsure = urlUtil_1.urlUtil.getWebRelativePath(webFullUrl, folderToEnsure);
         if (debug) {
             logger.log(`folderToEnsure`);
             logger.log(folderToEnsure);
@@ -282,7 +283,7 @@ exports.spo = {
             // append the next sub-folder to the folder path and check if it exists
             prevFolder = nextFolder;
             nextFolder += `/${folders[folderIndex]}`;
-            const folderServerRelativeUrl = _1.urlUtil.getServerRelativePath(webFullUrl, nextFolder);
+            const folderServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webFullUrl, nextFolder);
             const requestOptions = {
                 url: `${webFullUrl}/_api/web/GetFolderByServerRelativeUrl('${encodeURIComponent(folderServerRelativeUrl)}')`,
                 headers: {
@@ -296,7 +297,7 @@ exports.spo = {
                 checkOrAddFolder(resolve, reject);
             })
                 .catch(() => {
-                const prevFolderServerRelativeUrl = _1.urlUtil.getServerRelativePath(webFullUrl, prevFolder);
+                const prevFolderServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webFullUrl, prevFolder);
                 const requestOptions = {
                     url: `${webFullUrl}/_api/web/GetFolderByServerRelativePath(DecodedUrl=@a1)/AddSubFolderUsingPath(DecodedUrl=@a2)?@a1=%27${encodeURIComponent(prevFolderServerRelativeUrl)}%27&@a2=%27${encodeURIComponent(folders[folderIndex])}%27`,
                     headers: {
@@ -402,7 +403,7 @@ exports.spo = {
       * @param formDigestValue formDigestValue
       */
     getFolderIdentity(webObjectIdentity, webUrl, siteRelativeUrl, formDigestValue) {
-        const serverRelativePath = _1.urlUtil.getServerRelativePath(webUrl, siteRelativeUrl);
+        const serverRelativePath = urlUtil_1.urlUtil.getServerRelativePath(webUrl, siteRelativeUrl);
         const requestOptions = {
             url: `${webUrl}/_vti_bin/client.svc/ProcessQuery`,
             headers: {

package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md

@@ -1,4 +1,4 @@
-# aad o365group restore
+# aad o365group recyclebinitem restore
 
 Restores a deleted Microsoft 365 Group
 

package/docs/docs/cmd/aad/user/user-signin-list.md

@@ -78,4 +78,4 @@ Get all user's sign-ins filter by given user's Id and application identifier in
 
 ```sh
 m365 aad user signin list --userId '11111111-1111-1111-1111-111111111111' --appId '00000000-0000-0000-0000-000000000000'
-```
+```

package/docs/docs/cmd/onedrive/report/report-activityusercounts.md

@@ -1,4 +1,4 @@
-# onerive report activityusercounts
+# onedrive report activityusercounts
 
 Gets the trend in the number of active OneDrive users
 

package/docs/docs/cmd/planner/task/task-checklistitem-list.md

@@ -21,4 +21,4 @@ Lists the checklist items of a Planner task.
 
 ```sh
 m365 planner task checklistitem list --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
-```
+```

package/docs/docs/cmd/planner/task/task-reference-add.md

@@ -42,4 +42,4 @@ Add a new reference with the url _https://www.microsoft.com_ and with the type E
 
 ```sh
 m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
-```
+```

package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md

@@ -0,0 +1,33 @@
+# pp dataverse table list
+
+Lists dataverse tables in a given environment
+
+## Usage
+
+```sh
+pp dataverse table list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+The name of the environment to list all tables for
+
+`-a, --asAdmin`
+Set, to retrieve the dataverse tables as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all tables for the given environment
+
+```sh
+m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all tables for the given environment as Admin
+
+```sh
+m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
+```

package/docs/docs/cmd/pp/tenant/tenant-settings-list.md

@@ -0,0 +1,26 @@
+# pp tenant settings list
+
+Lists the global Power Platform tenant settings
+
+## Usage
+
+```sh
+m365 pp tenant settings list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+## Examples
+
+Lists the global Power Platform settings of the tenant
+
+```sh
+m365 pp tenant settings list
+```

package/docs/docs/cmd/search/externalconnection/externalconnection-remove.md

@@ -37,4 +37,4 @@ Removes external connection with name _Test_. Will NOT prompt for confirmation b
 
 ```sh
 m365 search externalconnection remove --name "Test" --confirm
-```
+```

package/docs/docs/cmd/spo/file/file-roleassignment-remove.md

@@ -0,0 +1,54 @@
+# spo file roleassignment remove
+
+Removes a role assignment from a file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId`.
+
+`--upn [upn]`
+: Upn/email of the user. Specify either `upn`, `groupName`, or `principalId`.
+
+`--groupName [groupName]`
+: The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId`.
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a role assignment by principal id from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
+```
+
+Remove a role assignment by upn from a file by url
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
+```
+
+Remove a role assignment by group name from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
+```

package/docs/docs/cmd/spo/file/file-roleinheritance-reset.md

@@ -0,0 +1,39 @@
+# spo file roleinheritance reset
+
+Restores the role inheritance of a file
+
+## Usage
+
+```sh
+m365 spo file roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`i, --fileId [fileId]`
+: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Reset inheritance of file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+Reset inheritance of file with server-relative url _/sites/project-x/documents/Test1_.docx located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --confirm
+```

package/docs/docs/cmd/spo/folder/folder-get.md

@@ -13,8 +13,11 @@ m365 spo folder get [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the folder is located
 
-`-f, --folderUrl <folderUrl>`
-: Site-relative URL of the folder
+`-f, --folderUrl [folderUrl]`
+: The server-relative URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both
+
+`-i, --id [id]`
+: The UniqueId (GUID) of the folder to retrieve. Specify either `folderUrl` or `id` but not both
 
 --8<-- "docs/cmd/_global.md"
 
@@ -24,8 +27,14 @@ If no folder exists at the specified URL, you will get a `Please check the folde
 
 ## Examples
 
-Get folder properties for folder with site-relative url _'/Shared Documents'_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Get folder properties for folder with server-relative url _'/Shared Documents'_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl "/Shared Documents"
+```
+
+Get folder properties for folder with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents'
+m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
 ```

package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md

@@ -0,0 +1,36 @@
+# spo folder roleinheritance reset
+
+Restores the role inheritance of a folder.
+
+## Usage
+
+```sh
+m365 spo folder roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the folder is located.
+
+`-f, --folderUrl <folderUrl>`
+: The site-relative URL of the folder.
+
+`--confirm`
+: Don't prompt for confirmation to reset role inheritance of the folder.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Reset inheritance of folder with site-relative url _Shared Documents/TestFolder_ located in site _https://contoso.sharepoint.com/sites/project-x_.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
+```
+
+Reset inheritance of folder with server-relative url _/sites/project-x/Shared Documents/TestFolder_ located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
+```

package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md

@@ -1,6 +1,6 @@
 # spo hubsite disconnect
 
-Disconnects the specifies site collection from its hub site
+Disconnects the specified site collection from its hub site
 
 ## Usage
 

package/docs/docs/cmd/spo/hubsite/hubsite-get.md

@@ -11,13 +11,13 @@ m365 spo hubsite get [options]
 ## Options
 
 `-i, --id [id]`
-: ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
+: ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
 
 `-t, --title [title]`
-: Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
+: Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
 
 `-u, --url [url]`
-: URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
+: URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
 
 `--includeAssociatedSites`
 : Include the associated sites in the result (only in JSON output)

package/docs/docs/cmd/spo/list/list-roleassignment-add.md

@@ -75,4 +75,4 @@ add role assignment to list _someList_ located in site _https://contoso.sharepoi
 
 ```sh
 m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --principalId 11 --roleDefinitionName "Full Control"
-```
+```

package/docs/docs/cmd/spo/list/list-roleassignment-remove.md

@@ -54,4 +54,4 @@ Remove roleassignment from list by url based on principal Id
 
 ```sh
 m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --principalId 2
-```
+```

package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.md

@@ -64,4 +64,4 @@ Remove roleassignment from listitem getting list by url based on principal Id wi
 
 ```sh
 m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --listItemId 1 --principalId 2 --confirm
-```
+```

package/docs/docs/cmd/spo/roledefinition/roledefinition-add.md

@@ -40,4 +40,4 @@ Adds the role definition for site _https://contoso.sharepoint.com/sites/project-
 
 ```sh
 m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test --description "test description" --rights "ViewListItems,AddListItems,EditListItems,DeleteListItems"
-```
+```

package/docs/docs/cmd/spo/web/web-roleassignment-add.md

@@ -35,23 +35,23 @@ m365 spo web roleassignment add [options]
 add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
 
 ```sh
-m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionId 1073741829
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionId 1073741829
 ```
 
 add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for upn _someaccount@tenant.onmicrosoft.com_ and role definition id _1073741829_
 
 ```sh
-m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
 ```
 
 add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for group _someGroup_ and role definition id _1073741829_
 
 ```sh
-m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --groupName "someGroup" --roleDefinitionId 1073741829
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --groupName "someGroup" --roleDefinitionId 1073741829
 ```
 
 add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition name _Full Control_
 
 ```sh
-m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionName "Full Control"
-```
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionName "Full Control"
+```

package/docs/docs/cmd/spo/web/web-roleassignment-remove.md

@@ -32,23 +32,23 @@ m365 spo web roleassignment remove [options]
 Remove roleassignment from web based on group name
 
 ```sh
-m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --groupName "saleGroup"
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --groupName "saleGroup"
 ```
 
 Remove roleassignment from web based on principal Id
 
 ```sh
-m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2
 ```
 
 Remove roleassignment from web based on upn
 
 ```sh
-m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --upn "someaccount@tenant.onmicrosoft.com"
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --upn "someaccount@tenant.onmicrosoft.com"
 ```
 
 Remove roleassignment from web based on principal Id without prompting for confirmation
 
 ```sh
-m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2 --confirm
-```
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2 --confirm
+```

package/docs/docs/cmd/spo/web/web-roleinheritance-reset.md

@@ -21,4 +21,4 @@ Restore role inheritance of subsite _https://contoso.sharepoint.com/sites/projec
 
 ```sh
 m365 spo web roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x
-```
+```

package/docs/docs/cmd/teams/cache/cache-remove.md

@@ -43,4 +43,4 @@ m365 teams cache remove
 
 ## More information
 
-- [Clear the Teams client cache guidance](https://docs.microsoft.com/microsoftteams/troubleshoot/teams-administration/clear-teams-cache)
+- [Clear the Teams client cache guidance](https://docs.microsoft.com/microsoftteams/troubleshoot/teams-administration/clear-teams-cache)

package/docs/docs/cmd/teams/channel/channel-add.md

@@ -58,4 +58,4 @@ Add private channel to the specified Microsoft Teams team with owner ID
 
 ```sh
 m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --type private --owner cc693a7d-4833-4911-a89a-f0fe6e49bf69
-```
+```

package/docs/docs/cmd/teams/channel/channel-list.md

@@ -17,7 +17,7 @@ m365 teams channel list [options]
 : The display name of the team to list the channels of. Specify either `teamId` or `teamName` but not both
 
 `--type [type]`
-: Filter the results to only channels of a given type: `standard, private`. By default all channels are listed.
+: Filter the results to only channels of a given type: `standard`, `private`, `shared`. By default all channels are listed.
 
 --8<-- "docs/cmd/_global.md"
 

package/docs/docs/cmd/teams/channel/channel-member-set.md

@@ -48,4 +48,4 @@ Updates the role of the user with id 00000000-0000-0000-0000-000000000000 to mem
 
 ```sh
 m365 teams channel member set --teamName "Team Name" --channelName "Channel Name" --userId 00000000-0000-0000-0000-000000000000 --role member
-```
+```

package/docs/docs/cmd/teams/funsettings/funsettings-set.md

@@ -1,11 +1,11 @@
-# graph teams funsettings set
+# teams funsettings set
 
 Updates fun settings of a Microsoft Teams team
 
 ## Usage
 
 ```sh
-m365 graph teams funsettings set [options]
+m365 teams funsettings set [options]
 ```
 
 ## Options
@@ -32,23 +32,23 @@ m365 graph teams funsettings set [options]
 Allow giphy usage within a given Microsoft Teams team, setting the content rating for giphy to Moderate
 
 ```sh
-m365 graph teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowGiphy true --giphyContentRating Moderate
+m365 teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowGiphy true --giphyContentRating Moderate
 ```
 
 Disable usage of giphy within a given Microsoft Teams team
 
 ```sh
-m365 graph teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowGiphy false
+m365 teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowGiphy false
 ```
 
 Allow usage of stickers and memes within a given Microsoft Teams team
 
 ```sh
-m365 graph teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowStickersAndMemes true
+m365 teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowStickersAndMemes true
 ```
 
 Disable usage custom memes within a given Microsoft Teams team
 
 ```sh
-m365 graph teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowCustomMemes false
+m365 teams funsettings set --teamId 83cece1e-938d-44a1-8b86-918cf6151957 --allowCustomMemes false
 ```

package/docs/docs/cmd/tenant/security/security-alerts-list.md

@@ -27,4 +27,4 @@ Get security alerts for a vendor with name _Azure Sentinel_
 
 ```sh
 m365 tenant security alerts list --vendor "Azure Sentinel"
-```
+```

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md

@@ -1,4 +1,4 @@
-# tenant service announcement health get
+# tenant serviceannouncement health get
 
 Get the health report of a specified service for a tenant
 

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md

@@ -1,4 +1,4 @@
-# tenant service announcement health list
+# tenant serviceannouncement health list
 
 Gets the health report of all subscribed services for a tenant