@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.3158148

package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx

@@ -0,0 +1,46 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo folder roleinheritance reset
+
+Restores the role inheritance of a folder.
+
+## Usage
+
+```sh
+m365 spo folder roleinheritance reset [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the folder is located.
+
+`-f, --folderUrl <folderUrl>`
+: The server- or site-relative URL of the folder.
+
+`--confirm`
+: Don't prompt for confirmation to reset role inheritance of the folder.
+```
+
+<Global />
+
+## Examples
+
+Reset inheritance of folder with a specific site-relative URL
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
+```
+
+Reset inheritance of folder with a specific server-relative URL. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
+```
+
+Reset inheritance of the specified root folder for the library with a specific server-relative URL. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --confirm
+```

package/docs/docs/cmd/spo/group/group-add.mdx

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group add
+
+Creates group in the specified site
+
+## Usage
+
+```sh
+m365 spo group add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the group should be added.
+
+`-n, --name <name>`
+: Name of the group to add.
+
+`--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. Default `false`.
+
+`--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
+: Who can view the membership of the group? When `false` everyone can view the group membership, otherwise only group members can. Default `true`.
+
+`--allowRequestToJoinLeave [allowRequestToJoinLeave]`
+: Specify whether to allow users to request membership in this group and allow users to request to leave the group. Default `false`.
+
+`--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
+: If auto-accept is enabled, users will automatically be added or removed when they make a request. Default `false`.
+
+`--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
+: All membership requests will be sent to the email address specified.
+```
+
+<Global />
+
+## Examples
+
+Create group with title and description
+
+```sh
+m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --description "This group contains all project leaders"
+```
+
+Create group with membership requests
+
+```sh
+m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
+```

package/docs/docs/cmd/spo/group/group-get.mdx

@@ -0,0 +1,49 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group get
+
+Gets site group
+
+## Usage
+
+```sh
+m365 spo group get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the group is located.
+
+`-i, --id [id]`
+: ID of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.
+
+`--name [name]`
+: Name of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.
+
+`--associatedGroup [associatedGroup]`
+: Type of the associated group to get. Available values: `Owner`, `Member`, `Visitor`. Use either `id`, `name` or `associatedGroup` but not multiple.
+```
+
+<Global />
+
+## Examples
+
+Get group with ID _7_ for web _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --id 7
+```
+
+Get group with name _Team Site Members_ for web _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --name "Team Site Members"
+```
+
+Get the associated owner group of a specified site
+
+```sh
+m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --associatedGroup Owner
+```

package/docs/docs/cmd/spo/group/group-list.mdx

@@ -0,0 +1,37 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group list
+
+Lists all the groups within specific web
+
+## Usage
+
+```sh
+m365 spo group list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Url of the web to list the group within
+
+`--associatedGroupsOnly`
+: Get only the associated visitor, member and owner groups of the site.
+```
+
+<Global />
+
+## Examples
+
+Lists all the groups within a specific web
+
+```sh
+m365 spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso"
+```
+
+Lists the associated groups within a specific web
+
+```sh
+m365 spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso" --associatedGroupsOnly
+```

package/docs/docs/cmd/spo/group/group-member-add.mdx

@@ -0,0 +1,164 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo group member add
+
+Add members to a SharePoint Group
+
+## Usage
+
+```sh
+m365 spo group member add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the SharePoint group is available
+
+`--groupId [groupId]`
+: Id of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
+
+`--groupName [groupName]`
+: Name of the SharePoint Group to which the 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 need to be added, they have to be comma-separated (e.g. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
+
+`--email [email]`
+: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma-separated (e.g. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
+
+`--userId [userId]`
+: The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma-separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
+
+`--aadGroupId [aadGroupId]`
+: The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma-separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
+
+`--aadGroupName [aadGroupName]`
+: The name of the Azure AD group to add as a member. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
+```
+
+<Global />
+
+## Remarks
+
+For the `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName` 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 of invalid values.
+
+## Examples
+
+Add a user with the userName parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
+```
+
+Add multiple users with the userName parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
+```
+
+Add a user with the email parameter to a SharePoint group with the groupName parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
+```
+
+Add multiple users with the email parameter to a SharePoint group with the groupName parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
+```
+
+Add a user with the userId parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId 5
+```
+
+Add multiple users with the userId parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId "5,12"
+```
+
+Add multiple users with the aadUserId parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserId "56ca9023-3449-4e98-a96a-69e81a6f4983,a96c1755-8aec-4f4d-955f-08504510dc56"
+```
+
+Add multiple users with the aadUserName parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadUserName "Azure group one, Azure group two"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "AllowedRoles": [
+        0
+      ],
+      "CurrentRole": 0,
+      "DisplayName": "John Doe",
+      "Email": "john.doe@contoso.onmicrosoft.com",
+      "InvitationLink": null,
+      "IsUserKnown": true,
+      "Message": null,
+      "Status": true,
+      "User": "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  DisplayName  Email
+  -----------  ---------------------------------
+  John Doe     john.doe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  DisplayName,Email
+  John Doe,john.doe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo group member add --webUrl "https://contoso.sharepoint.com" --groupId "5" --aadGroupId "f2fb2f10-cfd2-4054-8ffd-64533657a5ab"
+
+  Date: 13/2/2023
+
+  ## All Company Members
+
+  Property | Value
+  ---------|-------
+  AllowedRoles | [0]
+  CurrentRole | 0
+  DisplayName | All Company Members
+  Email | allcompany@contoso.onmicrosoft.com
+  InvitationLink | null
+  IsUserKnown | true
+  Message | null
+  Status | true
+  User | c:0o.c\|federateddirectoryclaimprovider\|f2fb2f10-cfd2-4054-8ffd-64533657a5ab
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/group/group-member-list.mdx

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group member list
+
+List the members of a SharePoint Group
+
+## Usage
+
+```sh
+m365 spo group member list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the SharePoint site
+
+`--groupId [groupId]`
+: Id of the SharePoint group. Use either `groupName` or `groupId`, but not both
+
+`--groupName [groupName]`
+: Name of the SharePoint group. Use either `groupName` or `groupId`, but not both
+```
+
+<Global />
+
+## Examples
+
+List the members of the group with ID _5_ for web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5
+```
+
+List the members of the group with name _Contoso Site Members_ for web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Members"
+```

package/docs/docs/cmd/spo/group/group-member-remove.mdx

@@ -0,0 +1,77 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group member remove
+
+Removes the specified member from a SharePoint group
+
+## Usage
+
+```sh
+m365 spo group member remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the SharePoint group is available.
+
+`--groupId [groupId]`
+: Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both.
+
+`--groupName  [groupName]`
+: Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
+
+`--userName [userName]`
+: The UPN (user principal name, eg. megan.bowen@contoso.com) of the user that needs to be removed. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+
+`--email [email]`
+: The email of the user to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+
+`--userId [userId]`
+: The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+
+`--aadGroupId [aadGroupId]`
+: The object Id of the Azure AD group to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+
+`--aadGroupName [aadGroupName]`
+: The name of the Azure AD group to remove as a member. Specify either `userName`, `email`, `userId`, `aadGroupId` or `aadGroupName`.
+```
+
+<Global />
+
+## Examples
+
+Remove a user from a SharePoint group based on the id on a given web
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
+```
+
+Remove a user from a SharePoint group based on the username on a given web
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --email "Alex.Wilber@contoso.com"
+```
+
+Remove a user from a SharePoint group by email.
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
+```
+
+Remove an Azure AD group from a SharePoint group based on the Azure AD group name on a given web
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --aadGroupName "Azure AD Security Group"
+```
+
+Remove an Azure AD group from a SharePoint group based on the Azure AD group ID on a given web
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --aadGroupId "5786b8e8-c495-4734-b345-756733960730"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/group/group-remove.mdx

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group remove
+
+Removes group from specific web
+
+## Usage
+
+```sh
+m365 spo group remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Url of the web to remove the group from
+
+`--id [id]`
+: ID of the group to remove. Use ID or name but not both
+
+`--name [name]`
+: Name of the group to remove. Use ID or name but not both
+
+`--confirm`
+: Confirm removal of the group
+```
+
+<Global />
+
+## Examples
+
+Removes group with id _5_ from web _https://contoso.sharepoint.com/sites/mysite_
+
+```sh
+m365 spo group remove --webUrl https://contoso.sharepoint.com/sites/mysite --id 5
+```
+
+Removes group with name _Team Site Owners_ from web _https://contoso.sharepoint.com/sites/mysite_
+
+```sh
+m365 spo group remove --webUrl https://contoso.sharepoint.com/sites/mysite --name "Team Site Owners"
+```

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

@@ -0,0 +1,73 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo group set
+
+Updates a group in the specified site
+
+## Usage
+
+```sh
+m365 spo group set [options]
+```
+
+## Options
+
+```md definition-list
+`-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.
+```
+
+<Global />
+
+## 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/hidedefaultthemes/hidedefaultthemes-get.mdx

@@ -0,0 +1,35 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo hidedefaultthemes get
+
+Gets the current value of the HideDefaultThemes setting
+
+## Usage
+
+```sh
+m365 spo hidedefaultthemes get [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Get the current value of the HideDefaultThemes setting
+
+```sh
+m365 spo hidedefaultthemes get
+```
+
+## More information
+
+- SharePoint site theming: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)

package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo hidedefaultthemes set
+
+Sets the value of the HideDefaultThemes setting
+
+## Usage
+
+```sh
+m365 spo hidedefaultthemes set [options]
+```
+
+## Options
+
+```md definition-list
+`--hideDefaultThemes <hideDefaultThemes>`
+: Set to `true` to hide default themes and to `false` to show them
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Hide default themes and allow users to use organization themes only
+
+```sh
+m365 spo hidedefaultthemes set --hideDefaultThemes true
+```
+
+## More information
+
+- SharePoint site theming: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-overview)