@pnp/cli-microsoft365 5.0.0-beta.014983c → 5.0.0-beta.1d35279

package/docs/docs/cmd/aad/app/app-delete.md

@@ -0,0 +1,51 @@
+# aad app delete
+
+Removes an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app delete [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--confirm`:
+: Don't prompt for confirmation to delete the app
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to delete. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Delete the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app delete --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its object ID
+
+```sh
+m365 aad app delete --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
+
+```sh
+m365 aad app delete --name "My app" --confirm
+```

package/docs/docs/cmd/aad/group/group-list.md

@@ -10,6 +10,9 @@ m365 aad group list [options]
 
 ## Options
 
+`-d, --deleted`
+: Use to retrieve deleted groups
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -18,4 +21,10 @@ Lists all groups defined in Azure Active Directory.
 
 ```sh
 m365 aad group list
+```
+
+List all recently deleted groups in the tenant
+
+```sh
+m365 aad group list --deleted
 ```

package/docs/docs/cmd/aad/user/user-list.md

@@ -13,6 +13,9 @@ m365 aad user list [options]
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve
 
+`-d, --deleted`
+: Use to retrieve deleted users
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -31,6 +34,12 @@ List all users in the tenant
 m365 aad user list
 ```
 
+List all recently deleted users in the tenant
+
+```sh
+m365 aad user list --deleted
+```
+
 List all users in the tenant. For each one return the display name and e-mail address
 
 ```sh

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/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/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/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/channel/channel-get.md

@@ -16,7 +16,7 @@ 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]`

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

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

@@ -0,0 +1,34 @@
+# tenant serviceannouncement healthissue list
+
+Gets all service health issues for the tenant.
+
+## Usage
+
+```sh
+m365 tenant serviceannouncement healthissue list [options]
+```
+
+## Options
+
+`-s, --service [service]`
+: Retrieve service health issues for the particular service. If not provided, retrieves health issues for all services
+
+--8<-- "docs/cmd/\_global.md"
+
+## Examples
+
+Get service health issues of all services in Microsoft 365
+
+```sh
+m365 tenant serviceannouncement healthissue list
+```
+
+Get service health issues for Microsoft Forms
+
+```sh
+m365 tenant serviceannouncement healthissue list --service "Microsoft Forms"
+```
+
+## More information
+
+- List serviceAnnouncement issues: [https://docs.microsoft.com/en-us/graph/api/serviceannouncement-list-issues](https://docs.microsoft.com/en-us/graph/api/serviceannouncement-list-issues)

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

@@ -0,0 +1,28 @@
+# tenant serviceannouncement message get
+
+Retrieves a specified service update message for the tenant
+
+## Usage
+
+```sh
+m365 tenant serviceannouncement message get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The ID of the service update message.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get service update message with ID MC001337
+
+```sh
+m365 tenant serviceannouncement message get --id MC001337
+```
+
+## More information
+
+- Microsoft Graph REST API reference: [https://docs.microsoft.com/en-us/graph/api/serviceupdatemessage-get](https://docs.microsoft.com/en-us/graph/api/serviceupdatemessage-get)

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

@@ -0,0 +1,34 @@
+# tenant serviceannouncement message list
+
+Gets all service update messages for the tenant.
+
+## Usage
+
+```sh
+m365 tenant serviceannouncement message list [options]
+```
+
+## Options
+
+`-s, --service [service]`
+: Retrieve service update messages for the particular service. If not provided, retrieves messages for all services
+
+--8<-- "docs/cmd/\_global.md"
+
+## Examples
+
+Get service update messages of all services in Microsoft 365
+
+```sh
+m365 tenant serviceannouncement message list
+```
+
+Get service update messages for Microsoft Teams
+
+```sh
+m365 tenant serviceannouncement message list --service "Microsoft Teams"
+```
+
+## More information
+
+- List serviceAnnouncement messages: [https://docs.microsoft.com/en-us/graph/api/serviceannouncement-list-messages](https://docs.microsoft.com/en-us/graph/api/serviceannouncement-list-messages)