@pnp/cli-microsoft365 6.0.0-beta.dc71aa3 → 6.0.0-beta.dc8d53d

package/docs/docs/cmd/flow/run/run-resubmit.md

@@ -48,3 +48,7 @@ Resubmits a specific flow run for the specified Microsoft Flow without prompting
 ```sh
 m365 flow run resubmit --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62 --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/card/card-clone.md

@@ -22,7 +22,7 @@ pp card clone [options]
 `-n, --name [name]`
 : The name of the card. Specify either `id` or `name` but not both.
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

package/docs/docs/cmd/pp/card/card-get.md

@@ -19,7 +19,7 @@ pp card get [options]
 `-n, --name [name]`
 : The name of the card. Specify either `id` or `name` but not both.
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

package/docs/docs/cmd/pp/card/card-list.md

@@ -13,7 +13,7 @@ pp card list [options]
 `-e, --environment <environment>`
 : The name of the environment.
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -16,7 +16,7 @@ pp dataverse table get [options]
 `-n, --name<name>`
 : The name of the dataverse table to retrieve rows from.
 
-`-a, --asAdmin`
+`--asAdmin`
 : Set, to retrieve the dataverse table as admin for environments you are not a member of.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -13,7 +13,7 @@ pp dataverse table list [options]
 `-e, --environment <environment>`
 : The name of the environment to list all tables for
 
-`-a, --asAdmin`
+`--asAdmin`
 : Set, to retrieve the dataverse tables as admin for environments you are not a member of.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -19,7 +19,7 @@ pp dataverse table remove [options]
 `--confirm`
 : Don't prompt for confirmation
 
-`-a, --asAdmin`
+`--asAdmin`
 : Set, to remove the dataverse table as admin for environments you are not a member of.
 
 --8<-- "docs/cmd/_global.md"

package/docs/docs/cmd/pp/environment/environment-get.md

@@ -13,7 +13,7 @@ m365 pp environment get [options]
 `-n, --name <name>`
 : The name of the environment to get information about
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
 
 ## Remarks

package/docs/docs/cmd/pp/environment/environment-list.md

@@ -10,7 +10,7 @@ m365 pp environment list [options]
 
 ## Options
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -19,7 +19,7 @@ m365 pp solution get [options]
 `-n, --name [name]`
 : The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -13,7 +13,7 @@ m365 pp solution list [options]
 `-e, --environment <environment>`
 : The name of the environment
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -19,7 +19,7 @@ m365 pp solution publisher get [options]
 `-n, --name [name]`
 : The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

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

@@ -16,7 +16,7 @@ m365 pp solution publisher list [options]
 `--includeMicrosoftPublishers`
 : Include the Microsoft Publishers
 
-`-a, --asAdmin`
+`--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"

package/docs/docs/cmd/spfx/package/package-generate.md

@@ -56,3 +56,7 @@ Generate a web part that shows the weather for Amsterdam. Load web part contents
 ```sh
 m365 spfx package generate --webPartTitle "Amsterdam weather" --webPartDescription "Shows weather in Amsterdam" --name amsterdam-weather --html @amsterdam-weather.html --allowTenantWideDeployment --enableForTeams all
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -62,3 +62,95 @@ Validate if your project is correctly set up and get instructions to fix any iss
 ```sh
 m365 spfx project doctor --output tour
 ```
+
+## Response
+
+### Response with no issues
+
+=== "JSON"
+
+    ```json
+    []
+    ```
+
+=== "Text"
+
+    ```text
+    ✅ CLI for Microsoft 365 has found no issues in your project
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Validate project spfx-solution
+
+    Date: 11/7/2022
+
+    ## Findings
+
+    ✅ CLI for Microsoft 365 has found no issues in your project
+    ````
+
+### Response with issues reported
+
+When the npm packages related issues are reported. 
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "description": "Install supported version of the office-ui-fabric-react package",
+        "id": "FN001022",
+        "file": "./package.json",
+        "position": {
+          "line": 24,
+          "character": 5
+        },
+        "resolution": "npm i -SE office-ui-fabric-react@7.174.1",
+        "resolutionType": "cmd",
+        "severity": "Required",
+        "title": "office-ui-fabric-react"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Execute in command line
+    -----------------------
+    npm i -SE office-ui-fabric-react@7.174.1
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Validate project react-page-navigator
+
+    Date: 11/15/2022
+
+    ## Findings
+
+    Following is the list of issues found in your project. [Summary](#Summary) of the recommended fixes is included at the end of the report.
+
+    ### FN001022 office-ui-fabric-react | Required
+
+    Install supported version of the office-ui-fabric-react package
+
+    Execute the following command:
+
+    ```sh
+    npm i -SE office-ui-fabric-react@7.174.1
+    ```
+
+    File: [./package.json:24:5](./package.json)
+
+    ## Summary
+
+    ### Execute script
+
+    ```sh
+    npm i -SE office-ui-fabric-react@7.174.1
+    ```
+    ````

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

@@ -40,6 +40,8 @@ The `spfx project externalize` command helps you externalize your SharePoint Fra
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to externalize your project dependencies. Externalizing project dependencies 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 changes and verify that everything is working as expected.
 
+Supported SharePoint Framework versions are 1.0.0, 1.0.1, 1.0.2, 1.1.0, 1.1.1, 1.1.3, 1.2.0, 1.3.0, 1.3.1, 1.3.2, 1.3.4, 1.4.0, 1.4.1, 1.5.0, 1.5.1, 1.6.0, 1.7.0, 1.7.1, 1.8.0, 1.8.1, 1.8.2, 1.9.1.
+
 ## Examples
 
 Get instructions to externalize the current SharePoint Framework project dependencies and save the findings in a Markdown file
@@ -53,3 +55,117 @@ Get instructions to externalize the current SharePoint Framework project depende
 ```sh
 m365 spfx project externalize
 ```
+
+## Response
+
+Below output will be produced to externalize the SharePoint Framework project dependencies.
+
+=== "JSON"
+
+    ```json
+    {
+      "externalConfiguration": {
+        "externals": {
+          "@pnp/sp": {
+            "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+            "globalName": "pnp.sp",
+            "globalDependencies": [
+              "@pnp/logging",
+              "@pnp/common",
+              "@pnp/odata",
+              "tslib"
+            ]
+          },
+          "tslib": {
+            "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+            "globalName": "tslib"
+          }
+        }
+      },
+      "edits": [
+        {
+          "action": "add",
+          "path": "C:\\react-global-news-sp2019\\src\\webparts\\news\\NewsWebPart.ts",
+          "targetValue": "require(\"tslib\");"
+        }
+      ]
+    }
+    ```
+
+
+=== "Text"
+
+    ```text
+    In the config/config.json file update the externals property to:
+
+    {
+      "externalConfiguration": {
+        "externals": {
+          "@pnp/sp": {
+            "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+            "globalName": "pnp.sp",
+            "globalDependencies": [
+              "@pnp/logging",
+              "@pnp/common",
+              "@pnp/odata",
+              "tslib"
+            ]
+          },
+          "tslib": {
+            "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+            "globalName": "tslib"
+          }
+        }
+      },
+      "edits": [
+        {
+          "action": "add",
+          "path": "C:\\react-global-news-sp2019\\src\\webparts\\news\\NewsWebPart.ts",
+          "targetValue": "require(\"tslib\");"
+        }
+      ]
+    }
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Externalizing dependencies of project react-global-news-sp2019
+
+    Date: 11/7/2022
+
+    ## Findings
+
+    ### Modify files
+
+    #### [config.json](config/config.json)
+
+    Replace the externals property (or add if not defined) with
+    
+    ```json
+    {
+      "externals": {
+        "@pnp/sp": {
+          "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+          "globalName": "pnp.sp",
+          "globalDependencies": [
+            "@pnp/logging",
+            "@pnp/common",
+            "@pnp/odata",
+            "tslib"
+          ]
+        },
+        "tslib": {
+          "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+          "globalName": "tslib"
+        }
+      }
+    }
+    ```
+    
+    #### [C:\react-global-news-sp2019\src\webparts\news\NewsWebPart.ts](C:\react-global-news-sp2019\src\webparts\news\NewsWebPart.ts)
+    add
+    ```JavaScript
+    require("tslib");
+    ```
+    ````

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

@@ -18,11 +18,11 @@ m365 spfx project rename [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
 !!! important
     Run this command in the folder where the project that you want to rename is located.
 
-## Remarks
-
 This command will update the project name in: _package.json_, _.yo-rc.json_, _package-solution.json_, _deploy-azure-storage.json_ and _README.md_.
 
 ## Examples
@@ -38,3 +38,7 @@ Renames SharePoint Framework project to contoso with new solution ID
 ```sh
 m365 spfx project rename --newName contoso --generateNewId
 ```
+
+## 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.
 
@@ -85,3 +85,103 @@ Get instructions to upgrade the current SharePoint Framework project to the late
 ```sh
 m365 spfx project upgrade --output tour
 ```
+
+## Response
+
+When upgrading an SPFx project built using version 1.15.0 to SPFx version 1.15.2, you'll get output similar to following (output is truncated):
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "description": "Upgrade SharePoint Framework dependency package @microsoft/sp-core-library",
+        "id": "FN001001",
+        "file": "./package.json",
+        "position": {
+          "line": 15,
+          "character": 5
+        },
+        "resolution": "npm i -SE @microsoft/sp-core-library@1.15.2",
+        "resolutionType": "cmd",
+        "severity": "Required",
+        "title": "@microsoft/sp-core-library"
+      },
+      {
+        "description": "Update version in .yo-rc.json",
+        "id": "FN010001",
+        "file": "./.yo-rc.json",
+        "position": {
+          "line": 5,
+          "character": 5
+        },
+        "resolution": "{\\\n  \"@microsoft/generator-sharepoint\": {\\\n    \"version\": \"1.15.2\"\\\n  }\\\n}",
+        "resolutionType": "json",
+        "severity": "Recommended",
+        "title": ".yo-rc.json version"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Execute in bash
+    -----------------------
+    npm i -SE @microsoft/sp-core-library@1.15.2
+
+    ./.yo-rc.json
+    -------------
+    Update version in .yo-rc.json:
+    {
+      "@microsoft/generator-sharepoint": {
+        "version": "1.15.2"
+      }
+    }
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Upgrade project HelloWorld to v1.15.2
+
+    Date: 20/11/2022
+
+    ## Findings
+
+    Following is the list of steps required to upgrade your project to SharePoint Framework version 1.15.2. [Summary](#Summary) of the modifications is included at the end of the report.
+
+    ### FN001001 @microsoft/sp-core-library | Required
+
+    Upgrade SharePoint Framework dependency package @microsoft/sp-core-library
+
+    Execute the following command:
+
+    ```sh
+    npm i -SE @microsoft/sp-core-library@1.15.2
+    ```
+
+    File: [./package.json:17:5](./package.json)
+
+    ## Summary
+
+    ### Execute script
+
+    ```sh
+    npm i -SE @microsoft/sp-core-library@1.15.2
+    ```
+
+    ### Modify files
+
+    #### [./.yo-rc.json](./.yo-rc.json)
+
+    Update version in .yo-rc.json:
+
+    ```json
+    {
+      "@microsoft/generator-sharepoint": {
+        "version": "1.15.2"
+      }
+    }
+    ```
+    ````

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -68,3 +68,41 @@ Verify if your environment meets the requirements to work with SharePoint Framew
 ```sh
 m365 spfx doctor --spfxVersion 1.11.0 --output text
 ```
+
+## Response
+
+### Response with no issues
+
+=== "Text"
+
+    ```text
+    CLI for Microsoft 365 SharePoint Framework doctor
+    Verifying configuration of your system for working with the SharePoint Framework
+
+    √ SharePoint Framework v1.15.0
+    √ Node v16.13.0    
+    √ yo v4.3.0
+    √ gulp-cli v2.3.0
+    √ bundled typescript used
+    ```
+
+### Response with issues reported
+
+When the installed version of Yeoman is lower than expected to run SharePoint Framework v1.15.0
+
+=== "Text"
+
+    ```text
+    CLI for Microsoft 365 SharePoint Framework doctor
+    Verifying configuration of your system for working with the SharePoint Framework
+
+    √ SharePoint Framework v1.15.0
+    √ Node v16.16.0
+    × yo v3.1.1 found, v^4 required
+    √ gulp-cli v2.3.0
+    √ bundled typescript used
+
+    Recommended fixes:
+
+    - npm i -g yo@4
+    ```

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
+    ```
+
+
+
+