@pnp/cli-microsoft365 5.0.0-beta.fc638c4 → 5.1.0-beta.04832fc

package/docs/docs/cmd/planner/plan/plan-details-get.md

@@ -0,0 +1,45 @@
+# planner plan details get
+
+Retrieve the planner details about the specified plan.
+
+## Usage
+
+```sh
+m365 planner plan details get [options]
+```
+
+## Options
+
+`-i, --planId [planId]`
+: ID of the plan. Specify either `planId` or `planTitle` but not both.
+
+`-t, --planTitle [planTitle]`
+: Title of the plan. Specify either `planId` or `planTitle` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Returns the Microsoft Planner plan details with id _gndWOTSK60GfPQfiDDj43JgACDCb_
+
+```sh
+m365 planner plan details get --planId "gndWOTSK60GfPQfiDDj43JgACDCb"
+```
+
+Returns the Microsoft Planner plan details with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
+
+```sh
+m365 planner plan details get --planTitle "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
+```
+
+Returns the Microsoft Planner plan details with title _MyPlan_ for Group _My Planner Group_
+
+```sh
+m365 planner plan details get --planTitle "MyPlan" --ownerGroupName "My Planner Group"
+```

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

@@ -0,0 +1,24 @@
+# planner task details get
+
+Retrieve the details of the specified planner task
+
+## Usage
+
+```sh
+m365 planner task details get [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the details of the specified planner task
+
+```sh
+m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

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

@@ -0,0 +1,29 @@
+# planner task get
+
+Retrieve the the specified planner task
+
+## Usage
+
+```sh
+m365 planner task get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
+## Examples
+
+Retrieve the the specified planner task
+
+```sh
+m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

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

@@ -30,6 +30,11 @@ m365 planner task list [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! attention
+    This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
 ## Examples
 
 List tasks for the currently logged in user

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

@@ -27,6 +27,10 @@ m365 spo group user add [options]
 
 --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 with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_

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-restore.md

@@ -0,0 +1,27 @@
+# spo site recyclebinitem restore
+
+Restores given items from the site recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem restore [options]
+```
+
+## Options
+
+`-u, --siteUrl <siteUrl>`
+: URL of the site for which to restore the recycle bin items
+
+`-i, --ids <ids>`
+: List of ids of items which will be restored from the site recycle bin
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Restore specific items by given ids from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem restore --siteUrl https://contoso.sharepoint.com/site --ids "ae6f97a7-280e-48d6-b481-0ea986c323da,aadbf916-1f71-42ee-abf2-8ee4802ae291"
+```

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/app/app-update.md

@@ -10,8 +10,11 @@ m365 teams app update [options]
 
 ## Options
 
-`-i, --id <id>`
-: ID of the app to update
+`-i, --id [id]`
+: ID of the app to update. Specify either id or name, but not both
+
+`-n, --name [name]`
+: The display name of the app to update. Specify either id or name, but not both
 
 `-p, --filePath <filePath>`
 : Absolute or relative path to the Teams manifest zip file to update in the app catalog
@@ -28,4 +31,10 @@ Update the Teams app with ID _83cece1e-938d-44a1-8b86-918cf6151957_ from file _t
 
 ```sh
 m365 teams app update --id 83cece1e-938d-44a1-8b86-918cf6151957 --filePath ./teams-manifest.zip
-```
+```
+
+Update the Teams app with name _Test app_ from file _teams-manifest.zip_
+
+```sh
+m365 teams app update --name "Test app" --filePath ./teams-manifest.zip
+```

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-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 --message "Welcome to Teams"
+```
+
+Send a message to a single person
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com --message "Welcome to Teams"
+```
+
+Send a message to a group of people
+
+```sh
+m365 teams chat message send --userEmails alexw@contoso.com,meganb@contoso.com --message "Welcome to Teams"
+```
+
+Send a message to a chat conversation finding it by display name
+
+```sh
+m365 teams chat message send --chatName "Just a conversation" --message "Welcome to Teams"
+```

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

@@ -1,6 +1,6 @@
 # tenant serviceannouncement healthissue get
 
-Gets a specified service health issue for the tenant.
+Gets a specified service health issue for tenant.
 
 ## Usage
 
@@ -10,19 +10,15 @@ m365 tenant serviceannouncement healthissue get [options]
 
 ## Options
 
-`-i, --issueId <issueId>`
+`-i, --id <id>`
 : The issue id to get details for
 
---8<-- "docs/cmd/\_global.md"
+--8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Get specified service health issue for tenant with issueId _MO226784_
+Gets information about issue with ID _MO226784_
 
 ```sh
-m365 tenant serviceannouncement healthissue get --issueId MO226784
+m365 tenant serviceannouncement healthissue get --id MO226784
 ```
-
-## More information
-
-- Get serviceHealthIssue: [https://docs.microsoft.com/en-us/graph/api/servicehealthissue-get](https://docs.microsoft.com/en-us/graph/api/servicehealthissue-get)