@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.17b053d

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

@@ -0,0 +1,88 @@
+# 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
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "walkMeOptOut": false,
+      "disableNPSCommentsReachout": false,
+      "disableNewsletterSendout": false,
+      "disableEnvironmentCreationByNonAdminUsers": false,
+      "disablePortalsCreationByNonAdminUsers": false,
+      "disableSurveyFeedback": false,
+      "disableTrialEnvironmentCreationByNonAdminUsers": false,
+      "disableCapacityAllocationByEnvironmentAdmins": false,
+      "disableSupportTicketsVisibleByAllUsers": false,
+      "powerPlatform": {
+        "search": {
+          "disableDocsSearch": false,
+          "disableCommunitySearch": false,
+          "disableBingVideoSearch": false
+        },
+        "teamsIntegration": {
+          "shareWithColleaguesUserLimit": 10000
+        },
+        "powerApps": {
+          "disableShareWithEveryone": false,
+          "enableGuestsToMake": false,
+          "disableMembersIndicator": false
+        },
+        "environments": {},
+        "governance": {
+          "disableAdminDigest": false,
+          "allowDeveloperEnvironmentProvisioning": false
+        },
+        "licensing": {
+          "disableBillingPolicyCreationByNonAdminUsers": false
+        },
+        "powerPages": {}
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    disableCapacityAllocationByEnvironmentAdmins  : false
+    disableEnvironmentCreationByNonAdminUsers     : false
+    disableNPSCommentsReachout                    : false
+    disablePortalsCreationByNonAdminUsers         : false
+    disableSupportTicketsVisibleByAllUsers        : false
+    disableSurveyFeedback                         : false
+    disableTrialEnvironmentCreationByNonAdminUsers: false
+    walkMeOptOut                                  : false
+    ```
+
+=== "CSV"
+
+    ```csv
+    disableCapacityAllocationByEnvironmentAdmins,disableEnvironmentCreationByNonAdminUsers,disableNPSCommentsReachout,disablePortalsCreationByNonAdminUsers,disableSupportTicketsVisibleByAllUsers,disableSurveyFeedback,disableTrialEnvironmentCreationByNonAdminUsers,walkMeOptOut
+    false,false,false,false,false,false,false,false
+    ```

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md

@@ -0,0 +1,81 @@
+# purview retentionlabel list
+
+Get a list of retention labels
+
+## Usage
+
+```sh
+m365 purview retentionlabel list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention labels
+
+```sh
+m365 purview retentionlabel list
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "displayName": "Some label",
+        "descriptionForAdmins": "",
+        "descriptionForUsers": null,
+        "isInUse": true,
+        "retentionTrigger": "dateCreated",
+        "behaviorDuringRetentionPeriod": "retainAsRecord",
+        "actionAfterRetentionPeriod": "delete",
+        "createdDateTime": "2022-11-03T10:28:15Z",
+        "lastModifiedDateTime": "2022-11-03T10:28:15Z",
+        "labelToBeApplied": null,
+        "defaultRecordBehavior": "startLocked",
+        "id": "dc67203a-6cca-4066-b501-903401308f98",
+        "retentionDuration": {
+          "days": 365
+        },
+        "createdBy": {
+          "user": {
+            "id": "b52ffd35-d6fe-4b70-86d8-91cc01d76333",
+            "displayName": null
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": "b52ffd35-d6fe-4b70-86d8-91cc01d76333",
+            "displayName": null
+          }
+        },
+        "dispositionReviewStages": []
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName     isInUse
+    ------------------------------------  --------------  --------
+    dc67203a-6cca-4066-b501-903401308f98  Some label      true
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,isInUse
+    dc67203a-6cca-4066-b501-903401308f98,Some label,true
+    ```

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md

@@ -0,0 +1,36 @@
+# purview retentionlabel remove
+
+Delete a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention label.
+
+`--confirm`
+: Don't prompt for confirming to remove the label.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention label
+
+```sh
+m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/request.md

@@ -0,0 +1,76 @@
+# request
+
+Executes the specified web request using CLI for Microsoft 365
+
+## Usage
+
+```sh
+m365 request [options]
+```
+
+## Options
+
+`-u, --url <url>`
+: The request URL.
+
+`-m, --method [method]`
+: The HTTP request method. Accepted values are `get, post, put, patch, delete, head, options`. The default value is `get`.
+
+`-r, --resource [resource]`
+: The resource uri for which the CLI should acquire a token from AAD in order to access
+the service.
+
+`-b, --body [body]`
+: The request body. Optionally use `@example.json` to load the body from a file.
+
+`-p, --filePath [filePath]`
+: The file path to save the response to. This option can be used when downloading files.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When executing a request, CLI will take care of the very basic configuration, and you'll need to specify all additional information, such as headers, method and body. CLI will take care for you of:
+
+- applying compression and handling throttling,
+- setting the `accept` to `application/json` if you don't specify it yourself,
+- setting the `authorization` header to the bearer token obtained for the resource determined from the request URL
+
+If you specify the `resource` option, the CLI will try to retrieve a valid token for the resource instead of determining the resource based on the url. The value doesn't have to be a URL. It can be also a URI like `app://<guid>`.
+
+Specify additional headers by typing them as options, for example: `--content-type "application/json"`, `--if-match "*"`, `--x-requestdigest "somedigest"`.
+
+!!! important
+    When building the request, depending on the shell you use, you might need to escape all `$` characters in the URL, request headers, and the body. If you don't do it, the shell will treat it as a variable and will remove the following word from the request, breaking the request.
+
+## Examples
+
+Call the SharePoint Rest API using a GET request with a constructed URL containing expands, filters and selects.
+
+```sh
+m365 request --url "https://contoso.sharepoint.com/sites/project-x/_api/web/siteusers?\$filter=IsShareByEmailGuestUser eq true&\$expand=Groups&\$select=Title,LoginName,Email,Groups/LoginName" --accept "application/json;odata=nometadata"
+```
+
+Call the Microsoft Graph beta endpoint using a GET request.
+
+```sh
+m365 request --url "https://graph.microsoft.com/beta/me"
+```
+
+Call the SharePoint API to retrieve a form digest.
+
+```sh
+m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/contextinfo"
+```
+
+Call the SharePoint API to update a site title.
+
+```sh
+m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/web" --body '{ "Title": "New title" }' --content-type "application/json" --x-http-method "PATCH"
+```
+
+Call the Microsoft Graph to get a profile photo.
+
+```sh
+m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
+```

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

@@ -41,3 +41,7 @@ Adds a new external connection with a limited number of authorized apps
 ```sh
 m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -31,3 +31,41 @@ Get the External Connection by its name
 ```sh
 m365 search externalconnection get --name "Test"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "CLITest",
+      "name": "CLI-Test",
+      "description": "CLI Test",
+      "state": "draft",
+      "configuration": {
+        "authorizedApps": [
+          "31359c7f-bd7e-475c-86db-fdb8c937548e"
+        ],
+        "authorizedAppIds": [
+          "31359c7f-bd7e-475c-86db-fdb8c937548e"
+        ]
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    configuration: {"authorizedApps":["31359c7f-bd7e-475c-86db-fdb8c937548e"],"authorizedAppIds":["31359c7f-bd7e-475c-86db-fdb8c937548e"]}
+    description  : CLI Test
+    id           : CLITest
+    name         : CLI-Test
+    state        : draft
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,description,state,configuration
+    CLITest,CLI-Test,CLI Test,draft,"{""authorizedApps"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""],""authorizedAppIds"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""]}"
+    ```

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

@@ -19,3 +19,41 @@ List external connections defined in Microsoft Search
 ```sh
 m365 search externalconnection list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "CLITest",
+        "name": "CLI-Test",
+        "description": "CLI Test",
+        "state": "draft",
+        "configuration": {
+          "authorizedApps": [
+            "31359c7f-bd7e-475c-86db-fdb8c937548e"
+          ],
+          "authorizedAppIds": [
+            "31359c7f-bd7e-475c-86db-fdb8c937548e"
+          ]
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id       name      state
+    -------  --------  -----
+    CLITest  CLI-Test  draft
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,state
+    CLITest,CLI-Test,draft
+    ```

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

@@ -0,0 +1,44 @@
+# search externalconnection remove
+
+Allow the administrator to remove a specific external connection used in Microsoft Search.
+
+## Usage
+
+```sh
+m365 search externalconnection remove [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the External Connection to remove. Specify either `id` or `name`
+
+`-n, --name [name]`
+: Name of the External Connection to remove. Specify either `id` or `name`
+
+`--confirm`
+: Don't prompt for confirming removing the connection
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the command finds multiple external connections used in Microsoft Search with the specified name, it will prompt you to disambiguate which external connection it should remove, listing the discovered IDs.
+
+## Examples
+
+Removes external connection with id _MyApp_
+
+```sh
+m365 search externalconnection remove --id "MyApp"
+```
+
+Removes external connection with name _Test_. Will NOT prompt for confirmation before removing.
+
+```sh
+m365 search externalconnection remove --name "Test" --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -16,7 +16,7 @@ m365 spfx package generate
 `-d, --webPartDescription <webPartDescription>`
 : Description of the web part to generate. Displayed in the tool box when adding web part to page
 
-`-n, --packageName <packageName>`
+`-n, --name <name>`
 : Name of the package to generate. Used among others for the .sppkg file. Must be unique in the app catalog to avoid collisions with other solutions.
 
 `--html <html>`
@@ -54,5 +54,9 @@ m365 spfx package generate
 Generate a web part that shows the weather for Amsterdam. Load web part contents from a local file. Allow the web part to be deployed to all sites. Expose the web part in Teams as a personal tab.
 
 ```sh
-m365 spfx package generate --webPartTitle "Amsterdam weather" --webPartDescription "Shows weather in Amsterdam" --packageName amsterdam-weather --html @amsterdam-weather.html --allowTenantWideDeployment --enableForTeams all
+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

@@ -16,26 +16,13 @@ m365 spfx project rename [options]
 `--generateNewId`
 : Generate a new solution ID for the project
 
-`-h, --help`
-: output usage information
+--8<-- "docs/cmd/_global.md"
 
-`--query [query]`
-: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
-
-`-o, --output [output]`
-: Output type. `json,text,csv,md`. Default `json`
-
-`--verbose`
-: Runs command with verbose logging
-
-`--debug`
-: Runs command with debug logging
+## 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
@@ -51,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.