@pnp/cli-microsoft365 5.3.0-beta.f028e14 → 5.4.0-beta.d01ee78

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

@@ -0,0 +1,24 @@
+# planner task reference list
+
+Retrieve the references associated to a Planner task.
+
+## Usage
+
+```sh
+m365 planner task reference list [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task to retrieve references from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the references of the specified planner task
+
+```sh
+m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM
+```

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

@@ -0,0 +1,21 @@
+# pp gateway list
+
+Returns a list of gateways for which the user is an admin
+
+## Usage
+
+```sh
+m365 pp gateway list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List gateways for which the user is an admin
+
+```sh
+m365 pp gateway 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/field/field-list.md

@@ -0,0 +1,51 @@
+# spo field list
+
+Retrieves columns for the specified list or site
+
+## Usage
+
+```sh
+m365 spo field list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where fields are located
+
+`-t, --listTitle [listTitle]`
+: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`-i --listId [listId]`
+: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
+```
+
+Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
+```
+
+Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
+```
+
+Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
+```

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

@@ -0,0 +1,55 @@
+# spo list roleinheritance break
+
+Breaks role inheritance on list or library
+
+## Usage
+
+```sh
+m365 spo list roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list to retrieve is located
+
+`-i, --listId [listId]`
+: ID of the list to retrieve information for. Specify either id or title but not both
+
+`-t, --listTitle [listTitle]`
+: Title of the list to retrieve information for. Specify either id or title but not both
+
+`-c, --clearExistingPermissions`
+: Flag if used clears all roles from the list
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+By default, when breaking permissions inheritance, the list will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
+
+## Examples
+
+Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
+```
+
+Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
+```
+
+Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
+```
+
+Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
+```

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

@@ -0,0 +1,36 @@
+# spo list roleinheritance reset
+
+Restores role inheritance on list or library
+
+## Usage
+
+```sh
+m365 spo list roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located
+
+`-i, --listId [listId]`
+: ID of the list. Specify either id or title but not both
+
+`-t, --listTitle [listTitle]`
+: Title of the list. Specify either id or title but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
+```
+
+Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
+```

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-roleinheritance-break.md

@@ -0,0 +1,58 @@
+# spo listitem roleinheritance break
+
+Break inheritance of list item.
+
+## Usage
+
+```sh
+m365 spo listitem roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the item for which to break role inheritance is located
+
+`--listItemId <listItemId>`
+: ID of the item for which to break role inheritance
+
+`-l, --listId [listId]`
+: 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
+
+`-c, --clearExistingPermissions`
+: Set to clear existing roles from the list item
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+By default, when breaking permissions inheritance, the list item will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
+
+## Examples
+
+Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --id 1
+```
+
+Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --id 1
+```
+
+Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+
+```sh
+m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --id 1 --clearExistingPermissions
+```
+
+Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+
+```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/listitem/listitem-roleinheritance-reset.md

@@ -0,0 +1,39 @@
+# spo listitem roleinheritance reset
+
+Restores the role inheritance of list item, file, or folder
+
+## Usage
+
+```sh
+m365 spo listitem roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the item for which to reset role inheritance is located
+
+`--listItemId <listItemId>`
+: ID of the item for which to reset role inheritance
+
+`--listId [listId]`
+: ID of the list. Specify listId or listTitle but not both
+
+`--listTitle [listTitle]`
+: Title of the list. Specify listId or listTitle but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Restore role inheritance of list item with id 8 from list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listId 0cd891ef-afce-4e55-b836-fce03286cccf
+```
+
+Restore role inheritance of list item with id 8 from list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listTitle test
+```

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

@@ -0,0 +1,24 @@
+# spo roledefinition list
+
+Gets list of role definitions for the specified site
+
+## Usage
+
+```sh
+m365 spo roledefinition list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve role definitions
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Return list of role definitions for site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/project-x
+```

package/docs/docs/cmd/spo/userprofile/userprofile-get.md

@@ -1,4 +1,4 @@
-# spo userprofile set
+# spo userprofile get
 
 Get SharePoint user profile properties for the specified user
 

package/docs/docs/cmd/teams/channel/channel-member-list.md

@@ -35,10 +35,10 @@ m365 teams conversationmember list [options]
 
 ## Examples
   
-List the members of a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+List the members of a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype
+m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype
 ```
 
 List the members of a specified Microsoft Teams team with name _Team Name_ and channel with name _Channel Name_
@@ -47,8 +47,8 @@ List the members of a specified Microsoft Teams team with name _Team Name_ and c
 m365 teams channel member list --teamName "Team Name" --channelName "Channel Name"
 ```
 
-List all owners of the specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+List all owners of the specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype --role owner
+m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --role owner
 ```

package/docs/docs/cmd/teams/channel/channel-member-remove.md

@@ -44,10 +44,10 @@ m365 teams conversationmember remove [options]
 
 ## Examples
   
-Remove the user _johndoe@example.com_ from the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+Remove the user _johndoe@example.com_ from the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member remove --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com"
+m365 teams channel member remove --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com"
 ```
 
 Remove the user with id 00000000-0000-0000-0000-000000000000 from the Microsoft Teams team with name _Team Name_ and channel with name _Channel Name_

package/docs/docs/cmd/teams/channel/channel-member-set.md

@@ -38,10 +38,10 @@ m365 teams channel member set [options]
 
 ## Examples
   
-Updates the role of the user _johndoe@example.com_ to owner in the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+Updates the role of the user _johndoe@example.com_ to owner in the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member set --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com" --role owner
+m365 teams channel member set --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com" --role owner
 ```
 
 Updates the role of the user with id 00000000-0000-0000-0000-000000000000 to member in the Microsoft Teams team with name _Team Name_ and channel with name _Channel Name_

package/docs/docs/cmd/tenant/security/security-alerts-list.md

@@ -0,0 +1,30 @@
+# tenant security alerts list
+
+Gets the security alerts for a tenant
+
+## Usage
+
+```sh
+m365 tenant security alerts list [options]
+```
+
+## Options
+
+`--vendor [vendor]`
+: The vendor to return alerts for. Possible values `Azure Advanced Threat Protection`, `Azure Security Center`, `Microsoft Cloud App Security`, `Azure Active Directory Identity Protection`, `Azure Sentinel`, `Microsoft Defender ATP`. If omitted, all alerts are returned
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all security alerts for a tenant
+
+```sh
+m365 tenant security alerts list
+```
+
+Get security alerts for a vendor with name _Azure Sentinel_
+
+```sh
+m365 tenant security alerts list --vendor "Azure Sentinel"
+```