@pnp/cli-microsoft365 5.0.0-beta.2e2ba7d → 5.0.0-beta.30c8613

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

@@ -0,0 +1,99 @@
+# planner task set
+
+Updates a Microsoft Planner task
+
+## Usage
+
+```sh
+m365 planner task set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task.
+
+`-t, --title [title]`
+: New title of the task.
+
+`--bucketId [bucketId]`
+: ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
+
+`--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.
+
+`--planId [planId]`
+: ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
+
+`--planName [planName]`
+: Name of the plan to move the task to. 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`.
+
+`--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.
+
+`--assignedToUserIds [assignedToUserIds]`
+: Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--assignedToUserNames [assignedToUserNames]`
+: Comma-separated UPNs of the assignees that should be added to the task assignment. 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
+
+`--assigneePriority [assigneePriority]`
+: Hint used to order items of this type in a list view
+
+`--appliedCategories [appliedCategories]`
+: Comma-separated categories that should be added to the task
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When you specify the value for `percentageComplete`, consider the following:
+
+- 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_
+
+You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
+
+## Examples
+
+Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
+
+```sh
+m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
+```
+
+Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to 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 set  --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+```
+
+Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
+
+```sh
+m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"  --percentComplete 50 --appliedCategories "category1,category3"
+```
+
+## Additional information
+
+- Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
+- Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)

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

@@ -30,14 +30,14 @@ The `id` must be at least 3 and no more than 32 characters long. It can contain
 
 ## Examples
 
-Adds a new external connection with name and description of test
+Adds a new external connection with name and description of test app
 
 ```sh
-m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
+m365 search externalconnection add --id MyApp --name "Test" --description "Test"
 ```
 
 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"
+m365 search externalconnection add --id MyApp --name "Test" --description "Test" --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.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).
 
 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.
 
@@ -47,41 +47,41 @@ m365 spfx project upgrade --toVersion 1.5.0 --output md > "upgrade-report.md"
 Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and show the summary of the findings in the shell
 
 ```sh
-m365 spfx project upgrade --toVersion 1.5.0
+m365 spfx project upgrade --toVersion 1.5.0 --output text
 ```
 
 Get instructions to upgrade the current SharePoint Framework project to the latest preview version
 
 ```sh
-m365 spfx project upgrade --preview
+m365 spfx project upgrade --preview --output text
 ```
 
 Get instructions to upgrade the current SharePoint Framework project to the specified preview version
 
 ```sh
-m365 spfx project upgrade --toVersion 1.12.1-rc.0
+m365 spfx project upgrade --toVersion 1.12.1-rc.0 --output text
 ```
 
 Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using pnpm
 
 ```sh
-m365 spfx project upgrade --packageManager pnpm
+m365 spfx project upgrade --packageManager pnpm --output text
 ```
 
 Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365
 
 ```sh
-m365 spfx project upgrade
+m365 spfx project upgrade --output text
 ```
 
 Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using PowerShell
 
 ```sh
-m365 spfx project upgrade --shell powershell
+m365 spfx project upgrade --shell powershell --output text
 ```
 
 Get instructions to upgrade the current SharePoint Framework project to the latest version of SharePoint Framework and save the findings in a [CodeTour](https://aka.ms/codetour) file
 
 ```sh
-m365 spfx project upgrade  --output tour
+m365 spfx project upgrade --output tour
 ```

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/group/group-user-add.md

@@ -13,24 +13,46 @@ 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"
 
+## Remarks
+
+For the `--userName` or `--email` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list invalid values.
+
 ## 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/group/group-user-remove.md

@@ -0,0 +1,39 @@
+# spo group user remove
+
+Removes the specified user from a SharePoint group
+
+## Usage
+
+```sh
+m365 spo group user remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the SharePoint group is available
+
+`--groupId [groupId]`
+: Id of the SharePoint group from which user has to be removed from. Use either `groupName` or `groupId`, but not both
+
+`--groupName  [groupName]`
+: Name of the SharePoint group from which user has to be removed from. Use either `groupName` or `groupId`, but not both
+
+`--userName <userName>`
+: User's UPN (user principal name, eg. megan.bowen@contoso.com).
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a user from SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group user remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
+```
+
+Remove a user from SharePoint group with Name _Site A Visitors_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group user remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userName "Alex.Wilber@contoso.com"
+```

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

@@ -0,0 +1,40 @@
+# spo site recyclebinitem list
+
+Lists items from recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem list [options]
+```
+
+## Options
+
+`-u, --siteUrl <siteUrl>`
+: URL of the site for which to retrieve the recycle bin items
+
+`--type [type]`
+: Type of items which should be retrieved (listItems, folders, files)
+
+`--secondary`
+: Use this switch to retrieve items from secondary recycle bin
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When type is not specified then the command will return all items in the recycle bin
+
+## Examples
+
+Lists all files, items and folders from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site
+```
+
+Lists only files from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files
+```

package/docs/docs/cmd/teams/app/app-install.md

@@ -1,6 +1,6 @@
 # teams app install
 
-Installs an app from the catalog to a Microsoft Teams team
+Installs a Microsoft Teams team app from the catalog in the specified team or for the specified user
 
 ## Usage
 
@@ -13,14 +13,20 @@ m365 teams app install [options]
 `--appId <appId>`
 : The ID of the app to install
 
-`--teamId <teamId>`
+`--teamId [teamId]`
 : The ID of the Microsoft Teams team to which to install the app
 
+`--userId [userId]`
+: The ID of the user for who to install the app. Specify either `userId` or `userName` to install a personal app for a user.
+
+`--userName [userName]`
+: The UPN of the user for who to install the app. Specify either `userId` or `userName` to install a personal app for a user.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
-The `appId` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.md) command to get this ID.
+The `appId` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.md) command to get this ID instead.
 
 ## Examples
 
@@ -28,4 +34,16 @@ Install an app from the catalog in a Microsoft Teams team
 
 ```sh
 m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
-```
+```
+
+Install a personal app for the user specified using their user name
+
+```sh
+m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --userName steve@contoso.com
+```
+
+Install a personal app for the user specified using their ID
+
+```sh
+m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+```

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

@@ -16,12 +16,15 @@ m365 teams channel get [options]
 `--teamName [teamName]`
 : The display name of the team to which the channel belongs to. Specify either teamId or teamName but not both
 
-`-c, --channelId <channelId>`
+`-c, --channelId [channelId]`
 : The ID of the channel for which to retrieve more information. Specify either channelId or channelName but not both
 
 `--channelName [channelName]`
 : The display name of the channel for which to retrieve more information. Specify either channelId or channelName but not both
 
+`--primary`
+: Gets the default channel, General, of a team. If specified, channelId or channelName are not needed
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -36,4 +39,10 @@ Get information about Microsoft Teams team channel with name _Channel Name_
 
 ```sh
 m365 teams channel get --teamName "Team Name" --channelName "Channel Name"
-```
+```
+
+Get information about Microsoft Teams team primary channel , i.e. General
+
+```sh
+m365 teams channel get --teamName "Team Name" --primary
+```

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

@@ -0,0 +1,24 @@
+# teams chat message list
+
+Lists all messages from a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat message list [options]
+```
+
+## Options
+
+`-i, --chatId <chatId>`
+: The ID of the chat conversation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List the messages from a Microsoft Teams chat conversation
+
+```sh
+m365 teams chat message list --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```

package/docs/docs/cmd/teams/chat/chat-message-send.md

@@ -0,0 +1,55 @@
+# teams chat message send
+
+Sends a chat message to a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat message send [options]
+```
+
+## Options
+
+`--chatId [chatId]`
+: The ID of the chat conversation. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`--chatName [chatName]`
+: The display name of the chat conversation. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`-e, --userEmails [userEmails]`
+: A comma-separated list of one or more e-mail addresses. Specify either `chatId`, `chatName` or `userEmails`, but not multiple.
+
+`-m, --message <message>`
+: The message to send
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+A new chat conversation will be created if no existing conversation with the participants specified with emails is found.
+
+## Examples
+
+Send a message to a Microsoft Teams chat conversation by id
+
+```sh
+m365 teams chat message send --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```
+
+Send a message to a single person
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com
+```
+
+Send a message to a group of people
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com,meganb@contoso.com
+```
+
+Send a message to a chat conversation finding it by display name
+
+```sh
+m365 teams chat message send --chatName "Just a conversation"
+```

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/tenant/serviceannouncement/serviceannouncement-health-get.md

@@ -0,0 +1,33 @@
+# tenant service announcement health get
+
+Get the health report of a specified service for a tenant
+
+## Usage
+
+```sh
+m365 tenant serviceannouncement health get [options]
+```
+
+## Options
+
+`-s, --serviceName <serviceName>`
+: The service name to retrieve the health report for.
+
+`-i, --issues`
+: Return the collection of issues that happened on the service, with detailed information for each issue. Is only returned in JSON output mode.
+
+--8<-- "docs/cmd/\_global.md"
+
+## Examples
+
+Get the health report for the service _Exchange Online_
+
+```sh
+m365 tenant serviceannouncement health get --serviceName "Exchange Online"
+```
+
+Get the health report for the service _Exchange Online_ including the issues of the service
+
+```sh
+m365 tenant serviceannouncement health get --serviceName "Exchange Online" --issues
+```

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md

@@ -0,0 +1,30 @@
+# tenant service announcement health list
+
+Gets the health report of all subscribed services for a tenant
+
+## Usage
+
+```sh
+m365 tenant serviceannouncement health list [options]
+```
+
+## Options
+
+`-i, --issues`
+: Return the collection of issues that happened on the service, with detailed information for each issue. Is only returned in JSON output mode.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get the health report of all subscribed services for a tenant
+
+```sh
+m365 tenant serviceannouncement health list
+```
+
+Get the health report of all subscribed services for a tenant including the issues that happend on each service
+
+```sh
+m365 tenant serviceannouncement health list --issues
+```

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md

@@ -0,0 +1,24 @@
+# tenant serviceannouncement healthissue get
+
+Gets a specified service health issue for tenant.
+
+## Usage
+
+```sh
+m365 tenant serviceannouncement healthissue get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The issue id to get details for
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets information about issue with ID _MO226784_
+
+```sh
+m365 tenant serviceannouncement healthissue get --id MO226784
+```