@pnp/cli-microsoft365 6.0.0-beta.b62b543 → 6.0.0-beta.ba3c436

package/dist/m365/yammer/commands/yammer-search.js

@@ -16,6 +16,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _YammerSearchCommand_instances, _YammerSearchCommand_initTelemetry, _YammerSearchCommand_initOptions, _YammerSearchCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../request");
+const formatting_1 = require("../../../utils/formatting");
 const YammerCommand_1 = require("../../base/YammerCommand");
 const commands_1 = require("../commands");
 class YammerSearchCommand extends YammerCommand_1.default {
@@ -44,10 +45,13 @@ class YammerSearchCommand extends YammerCommand_1.default {
     }
     getAllItems(logger, args, page) {
         return new Promise((resolve, reject) => {
-            const endpoint = `${this.resource}/v1/search.json?search=${encodeURIComponent(args.options.queryText)}&page=${page}`;
+            const endpoint = `${this.resource}/v1/search.json?search=${formatting_1.formatting.encodeQueryParameter(args.options.queryText)}&page=${page}`;
             const requestOptions = {
                 url: endpoint,
-                responseType: 'json'
+                responseType: 'json',
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                }
             };
             request_1.default
                 .get(requestOptions)

package/dist/utils/aadGroup.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.aadGroup = void 0;
 const request_1 = require("../request");
+const formatting_1 = require("./formatting");
 const odata_1 = require("./odata");
 const graphResource = 'https://graph.microsoft.com';
 exports.aadGroup = {
@@ -33,7 +34,7 @@ exports.aadGroup = {
      * @param displayName Group display name.
      */
     getGroupsByDisplayName(displayName) {
-        return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(displayName)}'`);
+        return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups?$filter=displayName eq '${formatting_1.formatting.encodeQueryParameter(displayName)}'`);
     },
     /**
      * Get a single group by its display name.

package/dist/utils/powerPlatform.js

@@ -11,16 +11,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.powerPlatform = void 0;
 const request_1 = require("../request");
+const formatting_1 = require("./formatting");
 const powerPlatformResource = 'https://api.bap.microsoft.com';
 exports.powerPlatform = {
     getDynamicsInstanceApiUrl(environment, asAdmin) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = '';
             if (asAdmin) {
-                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/${encodeURIComponent(environment)}`;
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/${formatting_1.formatting.encodeQueryParameter(environment)}`;
             }
             else {
-                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/environments/${encodeURIComponent(environment)}`;
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/environments/${formatting_1.formatting.encodeQueryParameter(environment)}`;
             }
             const requestOptions = {
                 url: `${url}?api-version=2020-10-01&$select=properties.linkedEnvironmentMetadata.instanceApiUrl`,

package/dist/utils/spo.js

@@ -8,6 +8,7 @@ const Auth_1 = require("../Auth");
 const config_1 = require("../config");
 const base_permissions_1 = require("../m365/spo/base-permissions");
 const request_1 = require("../request");
+const formatting_1 = require("./formatting");
 exports.spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -285,7 +286,7 @@ exports.spo = {
             nextFolder += `/${folders[folderIndex]}`;
             const folderServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webFullUrl, nextFolder);
             const requestOptions = {
-                url: `${webFullUrl}/_api/web/GetFolderByServerRelativeUrl('${encodeURIComponent(folderServerRelativeUrl)}')`,
+                url: `${webFullUrl}/_api/web/GetFolderByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(folderServerRelativeUrl)}')`,
                 headers: {
                     'accept': 'application/json;odata=nometadata'
                 }
@@ -299,7 +300,7 @@ exports.spo = {
                 .catch(() => {
                 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`,
+                    url: `${webFullUrl}/_api/web/GetFolderByServerRelativePath(DecodedUrl=@a1)/AddSubFolderUsingPath(DecodedUrl=@a2)?@a1=%27${formatting_1.formatting.encodeQueryParameter(prevFolderServerRelativeUrl)}%27&@a2=%27${formatting_1.formatting.encodeQueryParameter(folders[folderIndex])}%27`,
                     headers: {
                         'accept': 'application/json;odata=nometadata'
                     },

package/docs/docs/cmd/flow/flow-get.md

@@ -13,7 +13,7 @@ m365 flow get [options]
 `-n, --name <name>`
 : The name of the Power Automate flow to get information about
 
-`-e, --environmentNameName <environmentName>`
+`-e, --environmentName <environmentName>`
 : The name of the environment for which to retrieve available flows
 
 `--asAdmin`

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

@@ -0,0 +1,120 @@
+# pp dataverse table get
+
+List a dataverse table in a given environment
+
+## Usage
+
+```sh
+pp dataverse table get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment to list a table for.
+
+`-n, --name<name>`
+: The name of the dataverse table to retrieve rows from.
+
+`-a, --asAdmin`
+: Set, to retrieve the dataverse table as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List a table for the given environment
+
+```sh
+m365 pp dataverse table get -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser"
+```
+
+List a table for the given environment as Admin
+
+```sh
+m365 pp dataverse table get -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "MetadataId": "84f4c125-474d-ed11-bba1-000d3a2caf7f",
+      "IsCustomEntity": true,
+      "IsManaged": false,
+      "SchemaName": "aaduser",
+      "IconVectorName": null,
+      "LogicalName": "aaduser",
+      "EntitySetName": "aadusers",
+      "IsActivity": false,
+      "DataProviderId": null,
+      "IsRenameable": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "isrenameable"
+      },
+      "IsCustomizable": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "iscustomizable"
+      },
+      "CanCreateForms": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "cancreateforms"
+      },
+      "CanCreateViews": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "cancreateviews"
+      },
+      "CanCreateCharts": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "cancreatecharts"
+      },
+      "CanCreateAttributes": {
+        "Value": true,
+        "CanBeChanged": false,
+        "ManagedPropertyLogicalName": "cancreateattributes"
+      },
+      "CanChangeTrackingBeEnabled": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "canchangetrackingbeenabled"
+      },
+      "CanModifyAdditionalSettings": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "canmodifyadditionalsettings"
+      },
+      "CanChangeHierarchicalRelationship": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "canchangehierarchicalrelationship"
+      },
+      "CanEnableSyncToExternalSearchIndex": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "canenablesynctoexternalsearchindex"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    EntitySetName: aadusers
+    IsManaged    : false
+    LogicalName  : aaduser
+    SchemaName   : aaduser
+    ```
+
+=== "CSV"
+
+    ```csv
+    SchemaName,EntitySetName,LogicalName,IsManaged
+    aaduser,aadusers,aaduser,
+    ```

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

@@ -0,0 +1,49 @@
+# pp dataverse table remove
+
+Removes a dataverse table in a given environment
+
+## Usage
+
+```sh
+pp dataverse table remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment to remove a table from.
+
+`-n, --name<name>`
+: The name of the dataverse table to remove.
+
+`--confirm`
+: Don't prompt for confirmation
+
+`-a, --asAdmin`
+: Set, to remove the dataverse table as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes a dataverse table in a given environment
+
+```sh
+m365 pp dataverse table remove -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser"
+```
+
+Removes a dataverse table in a given environment as Admin
+
+```sh
+m365 pp dataverse table remove -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --asAdmin
+```
+
+Removes a dataverse table in a given environment without prompting for confirmation
+
+```sh
+m365 pp dataverse table remove -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "aaduser" --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/solution/solution-publisher-get.md

@@ -0,0 +1,83 @@
+# pp solution publisher get
+
+Get information about the specified publisher in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution publisher get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i --id [id]`
+: The ID of the solution. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets a specific publisher in a specific environment based on name
+
+```sh
+m365 pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "MicrosoftCorporation"
+```
+
+Gets a specific publisher in a specific environment based on name as Admin
+
+```sh
+m365 pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "MicrosoftCorporation" --asAdmin
+```
+
+Gets a specific publisher in a specific environment based on id
+
+```sh
+m365 pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
+```
+
+Gets a specific publisher in a specific environment based on id as Admin
+
+```sh
+m365 pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "publisherid": "d21aab70-79e7-11dd-8874-00188b01e34f",
+      "uniquename": "MicrosoftCorporation",
+      "friendlyname": "MicrosoftCorporation",
+      "versionnumber": 1226559,
+      "isreadonly": false,
+      "description": "Uitgever van Microsoft-oplossingen",
+      "customizationprefix": "",
+      "customizationoptionvalueprefix": 0
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    friendlyname: MicrosoftCorporation
+    publisherid : d21aab70-79e7-11dd-8874-00188b01e34f
+    uniquename  : MicrosoftCorporation
+    ```
+
+=== "CSV"
+
+    ```csv
+    publisherid,uniquename,friendlyname
+    d21aab70-79e7-11dd-8874-00188b01e34f,MicrosoftCorporation,MicrosoftCorporation
+    ```

package/docs/docs/cmd/pp/solution/solution-publisher-list.md

@@ -0,0 +1,71 @@
+# pp solution publisher list
+
+Lists publishers in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution publisher list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment
+
+`--includeMicrosoftPublishers`
+: Include the Microsoft Publishers
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all publishers in a specific environment
+
+```sh
+m365 pp solution publisher list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all publishers in a specific environment as Admin
+
+```sh
+m365 pp solution publisher list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "publisherid": "00000001-0000-0000-0000-00000000005a",
+        "uniquename": "Cree38e",
+        "friendlyname": "CDS Default Publisher",
+        "versionnumber": 1074060,
+        "isreadonly": false,
+        "description": null,
+        "customizationprefix": "cr6c3",
+        "customizationoptionvalueprefix": 43186
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    publisherid                           uniquename                     friendlyname
+    ------------------------------------  -----------------------------  ----------------------------------
+    00000001-0000-0000-0000-00000000005a  Cree38e                        CDS Default Publisher
+    ```
+
+=== "CSV"
+
+    ```csv
+    publisherid,uniquename,friendlyname
+    00000001-0000-0000-0000-00000000005a,Cree38e,CDS Default Publisher
+    ```
+

package/docs/docs/cmd/pp/solution/solution-publisher-remove.md

@@ -0,0 +1,58 @@
+# solution remove
+
+Removes the specified publisher in the specified Power Platform environment
+
+## Usage
+
+```sh
+m365 pp solution publisher remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the solution. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the solution. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the specified publisher based on the name parameter
+
+```sh
+m365 pp solution publisher remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Publisher Name"
+```
+
+Removes the specified publisher based on the name parameter without confirmation
+
+```sh
+m365 pp solution publisher remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Publisher Name" --confirm
+```
+
+Removes the specified publisher based on the name parameter as admin
+
+```sh
+m365 pp solution publisher remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Publisher Name" --asAdmin
+```
+
+Removes the specified publisher owned by the currently signed-in user based on the id parameter
+
+```sh
+m365 pp solution publisher remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spfx/project/project-upgrade.md

@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0-rc.0).
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0).
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
 

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

@@ -32,8 +32,7 @@ Specify either `listTitle`, `listId` or `listUrl`.
 : The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
 
 `-s, --scope [scope]`
-: The scope of which to retrieve the Event Receivers.
-Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
+: The scope of which to retrieve the event receivers. Can be either `site` or `web`. Defaults to `web`. Only applicable when not specifying any of the list properties.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -68,3 +67,44 @@ Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ i
 ```sh
 m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ReceiverAssembly": "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",
+      "ReceiverClass": "Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver",
+      "ReceiverId": "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec",
+      "ReceiverName": "PnP Test Receiver",
+      "SequenceNumber": 10000,
+      "Synchronization": 2,
+      "EventType": 10204,
+      "ReceiverUrl": "https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    EventType       : 10204
+    ReceiverAssembly: Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c
+    ReceiverClass   : Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver
+    ReceiverId      : c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+    ReceiverName    : PnP Test Receiver
+    ReceiverUrl     : https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b
+    SequenceNumber  : 10000
+    Synchronization : 2
+    ```
+
+=== "CSV"
+
+    ```csv
+    ReceiverAssembly,ReceiverClass,ReceiverId,ReceiverName,SequenceNumber,Synchronization,EventType,ReceiverUrl
+    "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver,c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec,PnP Test Receiver,10000,2,10204,https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b
+    ```
+
+
+
+

package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md

@@ -32,10 +32,15 @@ m365 spo eventreceiver remove [options]
 : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
 
 `--confirm`
-: Don't prompt for confirming removing the event receiver
+: Don't prompt for confirmation.
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! attention
+    You can only remove an event receiver if it has been registered by an app with the same ID.
+
 ## Examples
 
 Remove event receiver in a specific web by name.

package/docs/docs/cmd/spo/file/file-version-clear.md

@@ -0,0 +1,55 @@
+# spo file version clear
+
+Removes all version history of a specified file
+
+## Usage
+
+```sh
+m365 spo file version clear [options]
+```
+
+## Options
+
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-u, --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 [confirm]`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes all file version history in a specific site based on fileId and prompts for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+Removes all file version history in a specific site based on fileUrl and prompts for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx'
+```
+
+Removes all file version history in a specific site based on fileId without prompting for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6' --confirm
+```
+
+Removes all file version history in a specific site based on fileUrl without prompting for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx' --confirm
+```
+
+## Response
+
+The command won't return a response on success.