@pnp/cli-microsoft365 5.0.0-beta.85f5ab3 → 5.0.0-beta.9b77e24

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

@@ -0,0 +1,78 @@
+# planner task add
+
+Adds a new Microsoft Planner task
+
+## Usage
+
+```sh
+m365 planner task add [options]
+```
+
+## Options
+
+`-t, --title <title>`
+: Title of the task to add.
+
+`--planId [planId]`
+: Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
+
+`--planName [planName]`
+: Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
+
+`--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`.
+
+`--bucketId [bucketId]`
+: Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+
+`--bucketName [bucketName]`
+: Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+
+`--startDateTime [startDateTime]`
+: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--dueDateTime [dueDateTime]`
+: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--percentComplete [percentComplete]`
+: Percentage of task completion. Number between 0 and 100.
+  - When set to 0, the task is considered _Not started_. 
+  - When set between 1 and 99, the task is considered _In progress_.
+  - When set to 100, the task is considered _Completed_.
+
+`--assignedToUserIds [assignedToUserIds]`
+: The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--assignedToUserNames [assignedToUserNames]`
+: The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--description [description]`
+: Description of the task
+
+`--orderHint [orderHint]`
+: Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
+
+```sh
+m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
+```
+
+Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
+
+```sh
+m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
+```
+
+Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
+
+```sh
+m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
+```

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

@@ -0,0 +1,43 @@
+# search externalconnection add
+
+Add a new external connection to be defined for Microsoft Search
+
+## Usage
+
+```sh
+m365 search externalconnection add [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: Developer-provided unique ID of the connection within the Azure Active Directory tenant
+
+`-n, --name <name>`
+: The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters
+
+`-d, --description <description>`
+: Description of the connection displayed in the Microsoft 365 admin center
+
+`--authorizedAppIds [authorizedAppIds]`
+: Comma-separated collection of application IDs for registered Azure Active Directory apps that are allowed to manage the external connection and to index content in the external connection.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+The `id` must be at least 3 and no more than 32 characters long. It can contain only alphanumeric characters, can't begin with _Microsoft_ and can be any of the following values: *None, Directory, Exchange, ExchangeArchive, LinkedIn, Mailbox, OneDriveBusiness, SharePoint, Teams, Yammer, Connectors, TaskFabric, PowerBI, Assistant, TopicEngine, MSFT_All_Connectors*.
+
+## Examples
+
+Adds a new external connection with name and description of test
+
+```sh
+m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
+```
+
+Adds a new external connection with a limited number of authorized apps
+
+```sh
+m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
+```

package/docs/docs/cmd/spfx/project/project-externalize.md

@@ -20,7 +20,7 @@ m365 spfx project externalize [options]
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,md`. Default `text`
+: Output type. `json,text,csv,md`. Default `json`
 
 `--verbose`
 : Runs command with verbose logging

package/docs/docs/cmd/spfx/project/project-rename.md

@@ -23,7 +23,7 @@ m365 spfx project rename [options]
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,md`. Default `text`
+: Output type. `json,text,csv,md`. Default `json`
 
 `--verbose`
 : Runs command with verbose logging

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.13.0).
+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.13.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

@@ -20,7 +20,7 @@ m365 spfx doctor [options]
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,md`. Default `text`
+: Output type. `json,text,csv,md`. Default `json`
 
 `--verbose`
 : Runs command with verbose logging

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

@@ -0,0 +1,33 @@
+# spo contenttype list
+
+Lists content types from specified site
+
+## Usage
+
+```sh
+m365 spo contenttype list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site for which to list content types
+
+`-c, --category [category]`
+: Category name of content types. When defined will return only content types from specified category
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve site content types
+
+```PowerShell
+m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
+```
+
+Retrieve site content types from the 'List Content Types' category
+
+```PowerShell
+m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
+```

package/docs/docs/cmd/spo/group/group-user-add.md

@@ -13,24 +13,42 @@ m365 spo group user add [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the SharePoint group is available
 
-`--groupId <groupId>`
-: Id of the SharePoint Group to which user needs to be added
+`--groupId [groupId]`
+: Id of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
 
-`--userName <userName>`
-: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com)
+`--groupName [groupName]`
+: Name of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
+
+`--userName [userName]`
+: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
+
+`--email [email]`
+: User's email (eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Add a user to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
 
 ```sh
 m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
 ```
 
-Add multiple users to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
 
 ```sh
 m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
 ```
+
+Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
+```
+
+Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
+```

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

@@ -22,6 +22,9 @@ m365 spo list get [options]
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.
 
+`--withPermissions`
+: Set if you want to return associated roles and permissions of the list.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -44,6 +47,12 @@ Get information about a list returning the specified list properties
 m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Id,HasUniqueRoleAssignments,AllowContentTypes"
 ```
 
+Get information about a list along with the roles and permissions
+
+```sh
+m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions
+```
+
 ## More information
 
 - List REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint](https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint)

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

@@ -20,10 +20,10 @@ m365 spo page add [options]
 : Title of the page to create. If not specified, will use the page name as its title
 
 `-l, --layoutType [layoutType]`
-: Layout of the page. Allowed values `Article,Home`. Default `Article`
+: Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`
 
 `-p, --promoteAs [promoteAs]`
-: Create the page for a specific purpose. Allowed values `HomePage,NewsPage`
+: Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`
 
 `--commentsEnabled`
 : Set to enable comments on the page

package/docs/docs/cmd/spo/page/page-set.md

@@ -17,13 +17,13 @@ m365 spo page set [options]
 : URL of the site where the page to update is located
 
 `-l, --layoutType [layoutType]`
-: Layout of the page. Allowed values `Article,Home`
+: Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`
 
 `-p, --promoteAs [promoteAs]`
-: Update the page purpose. Allowed values `HomePage,NewsPage`
+: Update the page purpose. Allowed values `HomePage`, `NewsPage`
 
 `--commentsEnabled [commentsEnabled]`
-: Set to `true`, to enable comments on the page. Allowed values `true,false`
+: Set to `true`, to enable comments on the page. Allowed values `true`, `false`
 
 `--publish`
 : Set to publish the page

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

@@ -34,7 +34,9 @@ m365 spo site remove [options]
 
 Deleting a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully deleted, you should use the `--wait` flag. When using this flag, the `spo site remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully deleted.
 
-If the site which you have selected to remove is groupified (Modern Team Site), flags `--fromRecycleBin`, `--skipRecycleBin` and `--wait` will not be applicable
+If the site which you have selected to remove is groupified (Modern Team Site) and group exists, flags `--skipRecycleBin` and `--wait` will not be applicable. If the linked group still exists in the deleted groups, the site won't be removed. If the linked group is permanently deleted, the site will be removed like any classic site (except that flag `--wait` only will still not be applicable).
+
+If the argument `--fromRecycleBin` is passed, the selected site will be permanently removed even if it's a groupified one.
 
 ## Examples
 

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

@@ -0,0 +1,24 @@
+# spo web installedlanguage list
+
+Lists all installed languages on site
+
+## Usage
+
+```sh
+m365 spo web installedlanguage list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve the list of installed languages
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Return all installed languages from site _https://contoso.sharepoint.com/_
+
+```sh
+m365 spo web installedlanguage list --webUrl https://contoso.sharepoint.com
+```

package/docs/docs/cmd/teams/chat/chat-list.md

@@ -0,0 +1,30 @@
+# teams chat list
+
+Lists all Microsoft Teams chat conversations for the current user.
+
+## Usage
+
+```sh
+m365 teams chat list [options]
+```
+
+## Options
+
+`-t, --type [chatType]`
+: The chat type to optionally filter chat conversations by type. The value can be `oneOnOne`, `group` or `meeting`.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all the Microsoft Teams chat conversations of the current user.
+
+```sh
+m365 teams chat list
+```
+
+List only the one on one Microsoft Teams chat conversations.
+
+```sh
+m365 teams chat list --type oneOnOne
+```

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

@@ -0,0 +1,24 @@
+# teams chat member list
+
+Lists all members from a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat member list [options]
+```
+
+## Options
+
+`-i, --chatId <chatId>`
+: The ID of the chat conversation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List the members from a Microsoft Teams chat conversation
+
+```sh
+m365 teams chat member list --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces
+```

package/docs/docs/cmd/teams/message/message-get.md

@@ -23,9 +23,6 @@ m365 teams message get [options]
 
 ## 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.
-
 You can only retrieve a message from a Microsoft Teams team if you are a member of that team.
 
 ## Examples

package/docs/docs/cmd/teams/report/report-directroutingcalls.md

@@ -24,9 +24,6 @@ This command only works with app-only permissions. You will need to create your
 
 The difference between `fromDateTime` and `toDateTime` cannot exceed a period of 90 days
 
-!!! 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
 
 Get details about direct routing calls made between 2020-10-31 and today

package/docs/docs/cmd/teams/report/report-pstncalls.md

@@ -24,9 +24,6 @@ This command only works with app-only permissions. You will need to create your
 
 The difference between `fromDateTime` and `toDateTime` cannot exceed a period of 90 days
 
-!!! 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
 
 Get details about PSTN calls made between 2020-10-31 and today
@@ -46,3 +43,7 @@ Get details about PSTN calls made between 2020-10-31 and 2020-12-31 and exports
 ```sh
 m365 teams report pstncalls --fromDateTime 2020-10-31 --toDateTime 2020-12-31 --output json > "pstncalls.json"
 ```
+
+## More information
+
+- List PSTN calls: [https://docs.microsoft.com/en-us/graph/api/callrecords-callrecord-getpstncalls?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/callrecords-callrecord-getpstncalls?view=graph-rest-1.0)