@pnp/cli-microsoft365 6.0.0-beta.6a854fc → 6.0.0-beta.7920dfd

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.
+
+`--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
+
+`--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/pp/solution/solution-remove.md

@@ -0,0 +1,82 @@
+# pp solution remove
+
+Removes the specified solution in the specified Power Platform environment
+
+## Usage
+
+```sh
+m365 pp solution 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 unique name (not the display 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 solution with a specific name, owned by the currently signed-in user
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name"
+```
+
+Removes the specified solution owned by the currently signed-in user based on the name parameter without confirmation
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name" --confirm
+```
+
+Removes the specified solution owned by another user based on the name parameter
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Solution Name" --asAdmin
+```
+
+Removes the specified solution owned by another user based on the name parameter without confirmation
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "solution Name" --asAdmin --confirm
+```
+
+Removes the specified solution owned by the currently signed-in user based on the id parameter
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b
+```
+
+Removes the specified solution owned by the currently signed-in user based on the id parameter without confirmation
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b --confirm
+```
+
+Removes the specified solution owned by another user based on the id parameter
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b --asAdmin
+```
+
+Removes the specified solution owned by another user based on the id parameter without confirmation
+
+```sh
+m365 pp solution remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 00000001-0000-0000-0001-00000000009b --asAdmin --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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/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-remove.md

@@ -0,0 +1,40 @@
+# 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
+```

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