@pnp/cli-microsoft365 6.0.0-beta.09b5216 → 6.0.0-beta.443926a

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

@@ -0,0 +1,69 @@
+# spo group set
+
+Updates a group in the specified site
+
+## Usage
+
+```sh
+m365 spo group set [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the group is located.
+
+`-i, --id [id]`
+: ID of the group to update. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: Name of the group. Specify either `id` or `name` but not both.
+
+`--newName [newName]`
+: New name for the group.
+
+`--description [description]`
+: The description for the group.
+
+`--allowMembersEditMembership [allowMembersEditMembership]`
+: Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this.
+
+`--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
+: Who can view the membership of the group? When `true` only group members can view the membership, otherwise everyone can.
+
+`--allowRequestToJoinLeave [allowRequestToJoinLeave]`
+: Specify whether to allow users to request membership in this group and allow users to request to leave the group.
+
+`--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
+: If auto-accept is enabled, users will automatically be added or removed when they make a request.
+
+`--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
+: All membership requests will be sent to the email address specified.
+
+`--ownerEmail [ownerEmail]`
+: Set user with this email as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
+
+`--ownerUserName [ownerUserName]`
+: Set user with this login name as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Update group title and description
+
+```sh
+m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --newTitle "Project leaders" --description "This group contains all project leaders"
+```
+
+Update group with membership requests
+
+```sh
+m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --title "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
+```
+
+Sets a specified user as group owner
+
+```sh
+m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --ownerEmail john.doe@contoso.com
+```

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

@@ -10,17 +10,19 @@ m365 spo hubsite get [options]
 
 ## Options
 
-`-i, --id <id>`
-: Hub site ID
+`-i, --id [id]`
+: ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
 
---8<-- "docs/cmd/_global.md"
+`-t, --title [title]`
+: Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
 
-## Remarks
+`-u, --url [url]`
+: URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+`--includeAssociatedSites`
+: Include the associated sites in the result (only in JSON output)
 
-If the specified `id` doesn't refer to an existing hub site, you will get a `ResourceNotFoundException` error.
+--8<-- "docs/cmd/_global.md"
 
 ## Examples
 
@@ -30,6 +32,36 @@ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
 m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
 ```
 
+Get information about the hub site with Title _My Hub Site_
+
+```sh
+m365 spo hubsite get --title 'My Hub Site'
+```
+
+Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
+
+```sh
+m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
+```
+
+Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_, including its associated sites. Associated site info is only shown in JSON output.
+
+```sh
+m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
+```
+
+Get information about the hub site with Title _My Hub Site_
+
+```sh
+m365 spo hubsite get --title "My Hub Site"
+```
+
+Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
+
+```sh
+m365 spo hubsite get --url "https://contoso.sharepoint.com/sites/HubSite"
+```
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

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

@@ -27,6 +27,10 @@ m365 spo listitem get [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
+
 ## Examples
 
 Get an item with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -35,9 +39,14 @@ Get an item with ID _147_ from list with title _Demo List_ in site _https://cont
 m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-
-Get an items Title and Created column and with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+Get an items _Title_ and _Created_ column with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
 m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
 ```
+
+Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
+```

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

@@ -16,15 +16,9 @@ m365 spo listitem list [options]
 `-i, --listId [listId]`
 : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
 
-`--id [id]`
-: (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
-
 `-t, --listTitle [listTitle]`
 : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
 
-`--title [title]`
-: (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
-
 `-q, --camlQuery [camlQuery]`
 : CAML query to use to query the list of items with
 
@@ -46,6 +40,8 @@ m365 spo listitem list [options]
 
 `pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
 
+If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
+
 ## Examples
 
 Get all items from a list named Demo List
@@ -72,6 +68,12 @@ Get all items from list named _Demo List_. For each item, retrieve the value of
 m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
 ```
 
+Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_, _Modified_ fields, and the value of lookup field _Company_
+
+```sh
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
+```
+
 From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
 
 ```sh

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

@@ -0,0 +1,27 @@
+# spo roledefinition get
+
+Gets specified role definition from web by id
+
+## Usage
+
+```sh
+m365 spo roledefinition get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve the role definition
+
+`-i, --id <id>`
+: The Id of the role definition to retrieve.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with id _1_
+
+```sh
+m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
+```

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

@@ -24,6 +24,9 @@ m365 spo site classic list [options]
 !!! important
     To use this command you have to have permissions to access the tenant admin site.
 
+!!! important
+    This command is deprecated. Please use [spo site list](./site-list.md) instead.
+
 ## Remarks
 
 Using the `-t, --webTemplate` option you can specify which sites you want to retrieve. For example, to get sites with the `STS#0` as their web template, use `--webTemplate STS#0` as the option.

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

@@ -10,12 +10,18 @@ m365 spo site list [options]
 
 ## Options
 
-`--type [type]`
-: type of modern sites to list. Allowed values `TeamSite,CommunicationSite`, default `TeamSite`
+`-t, --type [type]`
+: type of sites to list. Allowed values are `TeamSite,CommunicationSite,All`. The default value is `TeamSite`. 
+
+`--webTemplate [webTemplate]`
+: types of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both.  
 
 `-f, --filter [filter]`
 : filter to apply when retrieving sites
 
+`--includeOneDriveSites`
+: use this switch to include OneDrive sites in the result when retrieving sites. Can only be used in combination with `type` All.
+
 `--deleted`
 : use this switch to only return deleted sites
 
@@ -32,30 +38,36 @@ When using the text output type (default), the command lists only the values of
 
 ## Examples
 
-List all modern team sites in the currently connected tenant
+List all sites in the currently connected tenant
 
 ```sh
-m365 spo site list
+m365 spo site list --type All
 ```
 
-List all modern team sites in the currently connected tenant
+List all group connected team sites in the currently connected tenant
 
 ```sh
 m365 spo site list --type TeamSite
 ```
 
-List all modern communication sites in the currently connected tenant
+List all communication sites in the currently connected tenant
 
 ```sh
 m365 spo site list --type CommunicationSite
 ```
 
-List all modern team sites that contain _project_ in the URL
+List all group connected team sites that contain _project_ in the URL
 
 ```sh
 m365 spo site list --type TeamSite --filter "Url -like 'project'"
 ```
 
+List all sites in the currently connected tenant including OneDrive sites
+
+```sh
+m365 spo site list --type All --includeOneDriveSites
+```
+
 List all deleted sites in the tenant you're logged in to
 
 ```sh

package/docs/docs/cmd/teams/team/team-archive.md

@@ -10,8 +10,14 @@ m365 teams team archive [options]
 
 ## Options
 
-`-i, --teamId <teamId>`
-: The ID of the Microsoft Teams team to archive
+`-i, --id [id]`
+: The ID of the Microsoft Teams team to archive. Specify either id or name but not both
+
+`-n, --name [name]`
+: The display name of the Microsoft Teams team to archive. Specify either id or name but not both
+
+`--teamId [teamId]`
+: (deprecated. Use `id` instead) The ID of the Microsoft Teams team to archive
 
 `--shouldSetSpoSiteReadOnlyForMembers`
 : Sets the permissions for team members to read-only on the SharePoint Online site associated with the team
@@ -22,18 +28,27 @@ m365 teams team archive [options]
 
 Using this command, global admins and Microsoft Teams service admins can access teams that they are not a member of.
 
+If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
+
 When a team is archived, users can no longer send or like messages on any channel in the team, edit the team's name, description, or other settings, or in general make most changes to the team. Membership changes to the team continue to be allowed.
 
+
 ## Examples
 
-Archive the specified Microsoft Teams team
+Archive the specified Microsoft Teams team with id _6f6fd3f7-9ba5-4488-bbe6-a789004d0d55_
+
+```sh
+m365 teams team archive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
+```
+
+Archive the specified Microsoft Teams team with name _Team Name_
 
 ```sh
-m365 teams team archive --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
+m365 teams team archive --name "Team Name"
 ```
 
 Archive the specified Microsoft Teams team and set permissions for team members to read-only on the SharePoint Online site associated with the team
 
 ```sh
-m365 teams team archive --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55 --shouldSetSpoSiteReadOnlyForMembers
+m365 teams team archive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55 --shouldSetSpoSiteReadOnlyForMembers
 ```

package/docs/docs/cmd/teams/team/team-remove.md

@@ -10,8 +10,14 @@ m365 teams team remove [options]
 
 ## Options
 
-`-i, --teamId <teamId>`
-: The ID of the Teams team to remove
+`-i, --id [id]`
+: The ID of the Microsoft Teams team to remove. Specify either id or name but not both
+
+`-n, --name [name]`
+: The display name of the Microsoft Teams team to remove. Specify either id or name but not both
+
+`--teamId [teamId]`
+: (deprecated. Use `id` instead) The ID of the Teams team to remove
 
 `--confirm`
 : Don't prompt for confirming removing the specified team
@@ -22,18 +28,26 @@ m365 teams team remove [options]
 
 When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This applies only to Microsoft 365 groups.
 
+If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
+
 ## Examples
 
-Removes the specified team
+Removes the specified Microsoft Teams team with id _00000000-0000-0000-0000-000000000000_
+
+```sh
+m365 teams team remove --id 00000000-0000-0000-0000-000000000000
+```
+
+Removes the specified Microsoft Teams team with name _Team Name_
 
 ```sh
-m365 teams team remove --teamId '00000000-0000-0000-0000-000000000000'
+m365 teams team remove --name "Team Name"
 ```
 
 Removes the specified team without confirmation
 
 ```sh
-m365 teams team remove --teamId '00000000-0000-0000-0000-000000000000' --confirm
+m365 teams team remove --id 00000000-0000-0000-0000-000000000000 --confirm
 ```
 
 ## More information

package/docs/docs/cmd/teams/team/team-unarchive.md

@@ -10,8 +10,14 @@ m365 teams team unarchive [options]
 
 ## Options
 
-`-i, --teamId <teamId>`
-: The ID of the Microsoft Teams team to restore
+`-i, --id [id]`
+: The ID of the Microsoft Teams team to restore. Specify either id or name but not both
+
+`-n, --name [name]`
+: The display name of the Microsoft Teams team to restore. Specify either id or name but not both
+
+`--teamId [teamId]`
+: (deprecated. Use `id` instead) The ID of the Microsoft Teams team to restore
 
 --8<-- "docs/cmd/_global.md"
 
@@ -19,12 +25,20 @@ m365 teams team unarchive [options]
 
 This command supports admin permissions. Global admins and Microsoft Teams service admins can restore teams that they are not a member of.
 
+If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
+
 This command restores users' ability to send messages and edit the team, abiding by tenant and team settings.
 
 ## Examples
 
-Restore an archived Microsoft Teams team
+Restore an archived Microsoft Teams team with id _6f6fd3f7-9ba5-4488-bbe6-a789004d0d55_
+
+```sh
+m365 teams team unarchive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
+```
+
+Restore an archived Microsoft Teams team with name _Team Name_
 
 ```sh
-m365 teams team unarchive --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
+m365 teams team unarchive --name "Team Name"
 ```