@pnp/cli-microsoft365 6.0.0-beta.37b9374 → 6.0.0-beta.3a04435

package/docs/docs/cmd/planner/plan/plan-list.md

@@ -31,3 +31,48 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
 ```sh
 m365 planner plan list --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ``` json
+    [
+      {
+        "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+        "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "title": "My Planner Plan",
+        "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+        "createdBy": {
+          "user": {
+            "displayName": null,
+            "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+          },
+          "application": {
+            "displayName": null,
+            "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+          }
+        },
+        "container": {
+          "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+          "type": "group",
+          "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ``` text
+    id                            title            createdDateTime               owner
+    ----------------------------  ---------------  ----------------------------  ------------------------------------
+    xqQg5FS2LkCp935s-FIFm2QAFkHM  My Planner Plan  2015-03-30T18:36:49.2407981Z  ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```

package/docs/docs/cmd/planner/plan/plan-remove.md

@@ -46,3 +46,7 @@ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My P
 ```sh
 m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

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-get.md

@@ -22,9 +22,6 @@ m365 planner task details get [options]
 `-t, --title [title]`
 : Title of the task. Specify either `id` or `title` but not both.
 
-`--taskId [taskId]`
-: (deprecated. Use `id` instead) ID of the task.
-
 `--bucketId [bucketId]`
 : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
 

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/card/card-get.md

@@ -0,0 +1,51 @@
+# pp card get
+
+Gets a specific Microsoft Power Platform card in the specified Power Platform environment
+
+## Usage
+
+```sh
+pp card get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the card. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the card. 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
+
+Get a specific card in a specific environment based on name
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card"
+```
+
+Get a specific card in a specific environment based on name as admin
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --asAdmin
+```
+
+Get a specific card in a specific environment based on id
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa"
+```
+
+Get a specific card in a specific environment based on id as admin
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --asAdmin
+```

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

@@ -0,0 +1,33 @@
+# pp card list
+
+Lists Microsoft Power Platform cards in the specified Power Platform environment.
+
+## Usage
+
+```sh
+pp card list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List cards in a specific environment.
+
+```sh
+m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
+```
+
+List cards in a specific environment as admin.
+
+```sh
+m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
+```

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/environment/environment-get.md

@@ -0,0 +1,38 @@
+# pp environment get
+
+Gets information about the specified Power Platform environment
+
+## Usage
+
+```sh
+m365 pp environment get [options]
+```
+
+## Options
+
+`-n, --name <name>`
+: The name of the environment to get information about
+
+`-a, --asAdmin`
+: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
+
+## 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.
+    Register CLI for Microsoft 365 or Azure AD application as a management application for the Power Platform using 
+    m365 pp managementapp add [options] 
+
+## Examples
+
+Get information about the Power Platform environment by name
+
+```sh
+m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+```
+
+Get information as admin about the Power Platform environment by name 
+
+```sh
+m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
+```

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

@@ -10,8 +10,8 @@ m365 pp environment list [options]
 
 ## Options
 
-`-a, --asAdmin [teamId]`
-Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
+`-a, --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/gateway/gateway-get.md

@@ -0,0 +1,24 @@
+# pp gateway get
+
+Get information about the specified gateway
+
+## Usage
+
+```sh
+m365 pp gateway get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the Gateway.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get information about the specified gateway.
+
+```sh
+m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
+```

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

@@ -0,0 +1,51 @@
+# pp solution get
+
+Gets a specific solution in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution 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 solution in a specific environment based on name
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default"
+```
+
+Gets a specific solution in a specific environment based on name as Admin
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default" --asAdmin
+```
+
+Gets a specific solution in a specific environment based on id
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
+```
+
+Gets a specific solution in a specific environment based on id as Admin
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
+```

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

@@ -0,0 +1,33 @@
+# pp solution list
+
+Lists solutions in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment
+
+`-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 solutions in a specific environment
+
+```sh
+m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all solutions in a specific environment as Admin
+
+```sh
+m365 pp solution list --environment "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/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/project/project-rename.md

@@ -16,20 +16,7 @@ m365 spfx project rename [options]
 `--generateNewId`
 : Generate a new solution ID for the project
 
-`-h, --help`
-: output usage information
-
-`--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
+--8<-- "docs/cmd/_global.md"
 
 !!! important
     Run this command in the folder where the project that you want to rename is located.

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.15.2).
+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-beta.1).
 
 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/spfx/spfx-doctor.md

@@ -13,6 +13,9 @@ m365 spfx doctor [options]
 `-e, --env [env]`
 : Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
 
+`-v, --spfxVersion [spfxVersion]`
+: Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
+
 `-h, --help`
 : output usage information
 
@@ -37,7 +40,7 @@ This commands helps you to verify if your environment meets all prerequisites fo
 
 The command starts by detecting the version of SharePoint Framework that you want to use. First, it looks at the current project. If you didn't run the command in the context of a SharePoint Framework project, the command will try to determine the SharePoint Framework version based on the SharePoint Framework Yeoman generator that you have installed either in the current directory or globally.
 
-Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
+Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp CLI and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
 
 If you miss any required tools or use a version that doesn't meet the SharePoint Framework requirements, the command will give you a list of recommendation how to address these issues.
 
@@ -48,14 +51,20 @@ Next to verifying the readiness of your environment to use a particular version
 
 ## Examples
 
-Verify if your environment meets the requirements to work with the SharePoint Framework
+Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
 
 ```sh
-m365 spfx doctor
+m365 spfx doctor --output text
 ```
 
 Verify if your environment meets the requirements to work with the SharePoint Framework and also if the version of the SharePoint Framework that you're using is compatible with SharePoint 2019
 
 ```sh
-m365 spfx doctor --env sp2019
+m365 spfx doctor --env sp2019 --output text
+```
+
+Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
+
+```sh
+m365 spfx doctor --spfxVersion 1.11.0 --output text
 ```

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

@@ -14,7 +14,13 @@ m365 spo contenttype add [options]
 : Absolute URL of the site where the content type should be created
 
 `-l, --listTitle [listTitle]`
-: Title of the list where the content type should be created (if it should be created as a list content type)
+: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
 
 `-i, --id <id>`
 : The ID of the content type. Determines the parent content type
@@ -44,12 +50,24 @@ Create a site content type that inherits from the List item content type
 m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types'
 ```
 
-Create a list content type that inherits from the List item content type
+Create a list (retrieved by Title) content type that inherits from the List item content type
 
 ```sh
 m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
 ```
 
+Create a list (retrieved by ID) content type that inherits from the List item content type
+
+```sh
+m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
+```
+
+Create a list (retrieved by URL) content type that inherits from the List item content type
+
+```sh
+m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
+```
+
 ## More information
 
 - Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14))