@pnp/cli-microsoft365 5.3.0-beta.ebb13d0 → 5.4.0-beta.0f3627d

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

@@ -17,10 +17,10 @@ m365 planner task list [options]
 : Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
 
 `--planId [planId]`
-: ID of the plan to list the tasks of. Specify `planId` or `planName` when using `bucketName`.
+: ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
 
 `--planName [planName]`
-: Name of the plan to list the tasks of. Specify `planId` or `planName` when using `bucketName`.
+: Name of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
 
 `--ownerGroupId [ownerGroupId]`
 : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.

package/docs/docs/cmd/planner/task/task-reference-remove.md

@@ -0,0 +1,39 @@
+# planner task reference remove
+
+Removes the reference from the Planner task.
+
+## Usage
+
+```sh
+m365 planner task reference remove [options]
+```
+
+## Options
+
+`-u, --url [url]`
+: URL location of the reference. Specify either `alias` or `url` but not both.
+
+`--alias [alias]`
+: The alias of the reference. Specify either `alias` or `url` but not both.
+
+`-i, --taskId <taskId>`
+: ID of the task.
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes a reference with the url _https://www.microsoft.com_ from the Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
+
+```sh
+m365 planner task reference remove --url "https://www.microsoft.com" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" 
+```
+
+Removes a reference with the alias _Parker_ from the Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
+
+```sh
+m365 planner task reference remove --alias "Parker" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
+```

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

@@ -0,0 +1,78 @@
+# planner task remove
+
+Removes the Microsoft Planner task from a plan
+
+## Usage
+
+```sh
+m365 planner task remove [options]
+```
+
+## Options
+
+`--id [id]`
+: ID of the task to remove. Specify either `id` or `title` but not both.
+
+`--title [title]`
+: Title of the task to remove. Specify either `id` or `title` but not both.
+
+`--bucketId [bucketId]`
+: ID of the bucket to which the task to remove belongs. Specify either `bucketId` or `bucketName` but not both.
+
+`--bucketName [bucketName]`
+: Name of the bucket to which the task to remove belongs. Specify either `bucketId` or `bucketName` but not both.
+
+`--planId [planId]`
+: ID of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
+
+`--planTitle [planTitle]`
+: Title of the plan to which the task to remove belongs. Specify either `planId` or `planTitle` when using `title`.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the Microsoft Planner task by ID
+
+```sh
+m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
+```
+
+Removes the Microsoft Planner task by ID without confirmation
+
+```sh
+m365 planner task remove --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --confirm
+```
+
+Removes the Microsoft Planner task with title _My Task_ in the bucket with ID _vncYUXCRBke28qMLB-d4xJcACtNz_
+
+```sh
+m365 planner task remove --title "My Task" --bucketId "vncYUXCRBke28qMLB-d4xJcACtNz" 
+```
+
+Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
+
+```sh
+m365 planner task remove --title "My Task" --bucketName "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
+```
+
+Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
+
+```sh
+m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
+```
+
+Removes the Microsoft Planner task with title _My Task_ in the bucket with name _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
+
+```sh
+m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupId "00000000-0000-0000-0000-000000000000"
+```

package/docs/docs/cmd/planner/task/task-set.md

@@ -17,10 +17,10 @@ m365 planner task set [options]
 : New title of the task.
 
 `--bucketId [bucketId]`
-: ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
+: ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` when using `title`.
 
 `--bucketName [bucketName]`
-: Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+: Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` when using `title`.
 
 `--planId [planId]`
 : ID of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.

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

@@ -0,0 +1,28 @@
+# planner tenant settings list
+
+Lists the Microsoft Planner configuration of the tenant
+
+## Usage
+
+```sh
+m365 planner tenant settings list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a global administrator.
+
+After executing the command `planner tenant settings set`, it can take some time for all changes to propagate across the tenant. Because of this, executing this command right away can return some unexpected results.
+
+## Examples
+
+Lists the Microsoft Planner settings of the tenant
+
+```sh
+m365 planner tenant settings list
+```

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

@@ -0,0 +1,21 @@
+# search externalconnection list
+
+Lists external connections defined in Microsoft Search
+
+## Usage
+
+```sh
+m365 search externalconnection list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List external connections defined in Microsoft Search
+
+```sh
+m365 search externalconnection list
+```

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.14.0). If you specify the `preview` option without a specific version, the command will upgrade your project to the latest preview version v1.15.0-beta.6.
+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.14.0). If you specify the `preview` option without a specific version, the command will upgrade your project to the latest preview version v1.15.0-rc.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

@@ -0,0 +1,70 @@
+# spo eventreceiver get
+
+Retrieves specific event receiver for the specified web, site or list by event receiver name or id.
+
+## Usage
+
+```sh
+m365 spo eventreceiver get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the web for which to retrieve the event receivers.
+
+`--listTitle [listTitle]`
+: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`-n, --name [name]`
+The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
+
+`-i, --id [id]`
+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.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
+```
+
+Retrieve event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Retrieve event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
+```
+
+Retrieve event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
+```

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

@@ -0,0 +1,64 @@
+# spo eventreceiver list
+
+Retrieves event receivers for the specified web, site or list.
+
+## Usage
+
+```sh
+m365 spo eventreceiver list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the web for which to retrieve the event receivers.
+
+`--listTitle [listTitle]`
+: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`-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.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieves event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
+```
+
+Retrieves event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site
+```
+
+Retrieves event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
+```
+
+Retrieves event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
+```
+
+Retrieves event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
+```

package/docs/docs/cmd/spo/file/file-checkout.md

@@ -32,5 +32,5 @@ m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x -
 Checks out file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
+m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx'
 ```

package/docs/docs/cmd/spo/list/list-list.md

@@ -13,6 +13,9 @@ m365 spo list list [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the lists to retrieve are located
 
+`--executeWithLimitedPermissions`
+: Use this option to execute this command with site member or visitor permissions. Not specifying this option will require site owner (or admin) permissions.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples

package/docs/docs/cmd/spo/list/list-view-add.md

@@ -0,0 +1,76 @@
+# spo list view add
+
+Adds a new view to a SharePoint list
+
+## Usage
+
+```sh
+m365 spo list view add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located.
+
+`--listId [listId]`
+: ID of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--listTitle [listTitle]`
+: Title of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Relative URL of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--title <title>`
+: Title of the view to be created for the list.
+
+`--fields <fields>`
+: Comma-separated list of **case-sensitive** internal names of the fields to add to the view.
+
+`--viewQuery [viewQuery]`
+: XML representation of the list query for the underlying view.
+
+`--personal`
+: View will be created as personal view, if specified.
+
+`--default`
+: View will be set as default view, if specified.
+
+`--paged`
+: View supports paging, if specified (recommended to use this).
+
+`--rowLimit [rowLimit]`
+: Sets the number of items to display for the view. Default value is 30.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+We recommend using the `paged` option. When specified, the view supports displaying more items page by page (default behavior). When not specified, the `rowLimit` is absolute, and there is no link to see more items.
+
+## Examples
+
+Add a view called _All events_ to a list with specific title.
+
+```sh
+m365 spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "My List" --title "All events" --fields "FieldName1,FieldName2,Created,Author,Modified,Editor" --paged
+```
+
+Add a view as default view with title _All events_ to a list with a specific URL.
+
+```sh
+m365 spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/Lists/MyList" --title "All events" --fields "FieldName1,Created" --paged --default
+```
+
+Add a personal view called _All events_ to a list with a specific ID.
+
+```sh
+m365 spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listId 00000000-0000-0000-0000-000000000000 --title "All events" --fields "FieldName1,Created" --paged --personal
+```
+
+Add a view called _All events_ with defined filter and sorting.
+
+```sh
+m365 spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "My List" --title "All events" --fields "FieldName1" --viewQuery "<OrderBy><FieldRef Name='Created' Ascending='FALSE' /></OrderBy><Where><Eq><FieldRef Name='TextFieldName' /><Value Type='Text'>Field value</Value></Eq></Where>" --paged
+```

package/docs/docs/cmd/spo/listitem/listitem-list.md

@@ -13,11 +13,17 @@ m365 spo listitem list [options]
 `-u, --webUrl <webUrl>`
 : URL of the site from which the item should be retrieved
 
-`-i, --id [id]`
-: ID of the list to retrieve items from. Specify `id` or `title` but not both
+`-i, --listId [listId]`
+: ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
 
-`-t, --title [title]`
-: Title of the list from which to retrieve the item. Specify `id` or `title` but not both
+`--id [id]`
+: (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
+
+`-t, --listTitle [listTitle]`
+: Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
+
+`--title [title]`
+: (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
 
 `-q, --camlQuery [camlQuery]`
 : CAML query to use to query the list of items with
@@ -45,35 +51,35 @@ m365 spo listitem list [options]
 Get all items from a list named Demo List
 
 ```sh
-m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
 From a list named _Demo List_ get all items with title _Demo list item_ using a CAML query
 
 ```sh
-m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query></View>"
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query></View>"
 ```
 
 Get all items from a list with ID _935c13a0-cc53-4103-8b48-c1d0828eaa7f_
 
 ```sh
-m365 spo listitem list --id 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo listitem list --listId 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
 Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_ and _Modified_ fields
 
 ```sh
-m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
 ```
 
 From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
 
 ```sh
-m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"
 ```
 
 From a list named _Demo List_ get the second batch of 10 items
 
 ```sh
-m365 spo listitem list --title "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
 ```

package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md

@@ -20,7 +20,7 @@ m365 spo listitem roleinheritance break [options]
 : ID of the list. Specify listId or listTitle but not both
 
 `-t, --listTitle [listTitle]`
-Title of the list. Specify listId or listTitle but not both
+: Title of the list. Specify listId or listTitle but not both
 
 `-c, --clearExistingPermissions`
 : Set to clear existing roles from the list item
@@ -55,4 +55,4 @@ Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f21
 
 ```sh
 m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --id 1 --clearExistingPermissions
-```
+```

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

@@ -0,0 +1,36 @@
+# spo roledefinition remove
+
+Removes the role definition from the specified site
+
+## Usage
+
+```sh
+m365 spo roledefinition remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site from which role should be removed
+
+`-i, --id <id>`
+: ID of the role definition to remove
+
+`--confirm`
+: Don't prompt for confirming removing the role definition
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove the role definition from site  _https://contoso.sharepoint.com/sites/project-x_ with id _1_
+
+```sh
+m365 spo roledefinition remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
+```
+
+Remove the role definition from site  _https://contoso.sharepoint.com/sites/project-x_ with id _1_ and don't prompt for confirmation
+
+```sh
+m365 spo roledefinition remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 1 --confirm
+```