@pnp/cli-microsoft365 5.2.0-beta.dc50ce6 → 5.3.0-beta.24cd8e4

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

@@ -10,8 +10,29 @@ m365 planner task get [options]
 
 ## Options
 
-`-i, --id <id>`
-: ID of the task to retrieve details from
+`-i, --id  [id]`
+: ID of the task. Specify either `id` or `title` but not both. When you specify the task ID, you no longer need to provide the information for `bucket`, `plan`, and `ownerGroup`.
+
+`-t, --title [title]`
+: Title of the task. Specify either `id` or `title` but not both.
+
+`--bucketId [bucketId]`
+: Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
+
+`--bucketName [bucketName]`
+: Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
+
+`--planId [planId]`
+: Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
+
+`--planName [planName]`
+: Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -22,8 +43,14 @@ m365 planner task get [options]
 
 ## Examples
 
-Retrieve the the specified planner task
+Retrieve the the specified planner task by id.
 
 ```sh
 m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
 ```
+
+Retrieve the the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_.
+
+```sh
+m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+```

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

@@ -23,10 +23,10 @@ m365 planner task set [options]
 : 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.
 
 `--planId [planId]`
-: ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
+: ID of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
 
 `--planName [planName]`
-: Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
+: Name of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
 
 `--ownerGroupId [ownerGroupId]`
 : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.

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.1.
+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.
 
 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

@@ -37,7 +37,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, React 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 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.
 

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/listitem/listitem-list.md

@@ -13,10 +13,10 @@ m365 spo listitem list [options]
 `-u, --webUrl <webUrl>`
 : URL of the site from which the item should be retrieved
 
-`-i, --id <id>`
+`-i, --id [id]`
 : ID of the list to retrieve items from. Specify `id` or `title` but not both
 
-`-t, --title [listTitle]`
+`-t, --title [title]`
 : Title of the list from which to retrieve the item. Specify `id` or `title` but not both
 
 `-q, --camlQuery [camlQuery]`

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/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

@@ -0,0 +1,57 @@
+# teams channel member remove
+
+Remove the specified member from the specified Microsoft Teams private team channel
+
+## Usage
+
+```sh
+m365 teams channel member remove [options]
+```
+
+## Alias
+
+```sh
+m365 teams conversationmember remove [options]
+```
+
+## Options
+
+`--teamId [teamId]`
+: The Id of the Microsoft Teams team. Specify either `teamId` or `teamName` but not both
+
+`--teamName [teamName]`
+: The display name of the Microsoft Teams team. Specify either `teamId` or `teamName` but not both
+
+`--channelId [channelId]`
+: The Id of the Microsoft Teams team channel. Specify either `channelId` or `channelName` but not both
+
+`--channelName [channelName]`
+: The display name of the Microsoft Teams team channel. Specify either `channelId` or `channelName` but not both
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Specify either userName, userId or id but not multiple.
+
+`--userId [userId]`
+: User's Azure AD Id. Specify either userName, userId or id but not multiple.
+
+`--id [id]`
+: Channel member Id of a user. Specify either userName, userId or id but not multiple.
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+  
+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 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_
+
+```sh
+m365 teams channel member remove --teamName "Team Name" --channelName "Channel Name" --userId 00000000-0000-0000-0000-000000000000
+```

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