@pnp/cli-microsoft365 5.0.0-beta.aff293c → 5.0.0-beta.c4100fe

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

@@ -0,0 +1,39 @@
+# spo listitem attachment list
+
+Gets the attachments associated to a list item
+
+## Usage
+
+```sh
+m365 spo listitem attachment list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+URL of the site from which the item should be retrieved
+
+`--listId [listId]`
+: ID of the list from which to retrieve the item. Specify listId or listTitle but not both
+
+`--listTitle [listTitle]`
+: Title of the list from which to retrieve the item. Specify listId or listTitle but not both
+
+`--itemId <itemId>`
+ID of the list item to in question
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets the attachments from list item with itemId _147_ in list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --itemId 147
+```
+
+Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-afce-4e55-b836-fce03286cccf_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
+```

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

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)