@pnp/cli-microsoft365 6.1.0-beta.f818fbb → 6.1.0

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

@@ -11,13 +11,25 @@ m365 aad user set [options]
 ## Options
 
 `-i, --objectId [objectId]`
-: The object ID of the user to update. Specify `objectId` or `userPrincipalName` but not both
+: The object ID of the user to update. Specify `objectId` or `userPrincipalName` but not both.
 
 `-n, --userPrincipalName [userPrincipalName]`
-: User principal name of the user to update. Specify `objectId` or `userPrincipalName` but not both
+: User principal name of the user to update. Specify `objectId` or `userPrincipalName` but not both.
 
 `--accountEnabled [accountEnabled]`
-: Boolean value specifying whether the account is enabled. Valid values are `true,false`
+: Boolean value specifying whether the account is enabled. Valid values are `true` or `false`.
+
+`--resetPassword`
+: If specified, the password of the user will be reset. This will make the parameter `newPassword` required.
+
+`--forceChangePasswordNextSignIn`
+: If specified, the user will have to change his password the next time they log in. Can only be set in combination with `resetPassword`.
+
+`--currentPassword [currentPassword]`
+: Current password of the user that is signed in. If this parameter is set, `newPassword` is mandatory. Can't be combined with `resetPassword`.
+
+`--newPassword [newPassword]`
+: New password to be set. Must be set when specifying either `resetPassword` or `currentPassword`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -58,3 +70,19 @@ Enable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
 ```sh
 m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled true
 ```
+
+Reset password of a given user by userPrincipalName and require the user to change the password on the next sign in
+
+```sh
+m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --password 6NLUId79Lc24 --forceChangePasswordNextSignIn
+```
+
+Change password of the currently logged in user
+
+```sh
+m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --currentPassword SLBF5gnRtyYc --newPassword 6NLUId79Lc24
+```
+
+### Response
+
+The command won't return a response on success.

package/docs/docs/cmd/context/context-init.md

@@ -0,0 +1,25 @@
+# context init
+
+Initiates CLI for Microsoft 365 context in the current working folder
+
+## Usage
+
+```sh
+m365 context init [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Initiates CLI for Microsoft 365 context in the current working folder
+
+```sh
+m365 context init
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/context/context-remove.md

@@ -0,0 +1,34 @@
+# context remove
+
+Removes the CLI for Microsoft 365 context in the current working folder
+
+## Usage
+
+```sh
+m365 context remove [options]
+```
+
+## Options
+
+`--confirm`
+: Don't prompt for confirmation to remove the context
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the CLI for Microsoft 365 context in the current working folder
+
+```sh
+m365 context remove
+```
+
+Removes the CLI for Microsoft 365 context in the current working folder and does not prompt for confirmation before deleting.
+
+```sh
+m365 context remove --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/environment/environment-get.md

@@ -10,11 +10,11 @@ m365 pp environment get [options]
 
 ## Options
 
-`-n, --name <name>`
-: The name of the environment to get information about
+`-n, --name [name]`
+: The name of the environment. When not specified, the default environment is retrieved.
 
 `--asAdmin`
-: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
+: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -39,6 +39,12 @@ Get information as admin about the Power Platform environment by name
 m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
 ```
 
+Get information about the default Power Platform environment
+
+```sh
+m365 pp environment get
+```
+
 ## Response
 
 === "JSON"

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md

@@ -0,0 +1,63 @@
+# purview retentionlabel set
+
+Update a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention label.
+
+`--behaviorDuringRetentionPeriod [behaviorDuringRetentionPeriod]`
+: Specifies how the behavior of a document with this label should be during the retention period. Allowed values: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`.
+
+`--actionAfterRetentionPeriod [actionAfterRetentionPeriod]`
+: Specifies the action to take on a document with this label applied after the retention period. Allowed values: `none`, `delete`, `startDispositionReview`.
+
+`--retentionDuration [retentionDuration]`
+: The number of days to retain the content.
+
+`-t, --retentionTrigger [retentionTrigger]`
+: Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. Allowed values: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`.
+
+`--defaultRecordBehavior [defaultRecordBehavior]`
+: Specifies the locked or unlocked state of a record label when it is created. Allowed values: `startLocked`, `startUnlocked`.
+
+`--descriptionForUsers [descriptionForUsers]`
+: The label information for the user.
+
+`--descriptionForAdmins [descriptionForAdmins]`
+: The label information for the admin.
+
+`--labelToBeApplied [labelToBeApplied]`
+: Specifies the replacement label to be applied automatically after the retention period of the current label ends.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Update a retention label so that it retains documents as records and deletes them after one year.
+
+```sh
+m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod delete --retentionDuration 365
+```
+
+Update a retention label so that it retains documents as regulatory records and starts a disposition review one year after the last modification date.
+
+```sh
+m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRegulatoryRecord --actionAfterRetentionPeriod startDispositionReview --retentionDuration 365 --retentionTrigger dateModified
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/search/externalconnection/externalconnection-schema-add.md

@@ -0,0 +1,31 @@
+# search externalconnection schema add
+
+This command allows the administrator to add a schema to a specific external connection for use in Microsoft Search.
+
+## Usage
+
+```sh
+m365 search externalconnection schema add [options]
+```
+
+## Options
+
+`-i, --externalConnectionId  <externalConnectionId>`
+: ID of the External Connection.
+
+`-s, --schema [schema]`
+: The schema object to be added.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a new schema to a specific external connection.
+
+```sh
+m365 search externalconnection schema add --externalConnectionId 'CliConnectionId' --schema '{"baseType":"microsoft.graph.externalItem","properties":[{"name":"ticketTitle","type":"String","isSearchable":"true","isRetrievable":"true","labels":["title"]},{"name":"priority","type":"String","isQueryable":"true","isRetrievable":"true","isSearchable":"false"},{"name":"assignee","type":"String","isRetrievable":"true"}]}'
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -20,10 +20,13 @@ m365 spo group member add [options]
 : 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 (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
+: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
 
 `--email [email]`
-: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
+: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
+
+`--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 Id's have to be comma separated. Specify either `userName`, `email` or `userId`
 
 --8<-- "docs/cmd/_global.md"
 
@@ -33,26 +36,75 @@ For the `--userName` or `--email` options you can specify multiple values by sep
 
 ## 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_
+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 by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+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 email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+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 by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+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"
+```
+
+## Response
+
+=== "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"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    DisplayName  Email
+    -----------  ---------------------------------
+    John Doe     john.doe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    DisplayName,Email
+    John Doe,john.doe@contoso.onmicrosoft.com
+    ```

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

@@ -11,29 +11,45 @@ m365 spo group member remove [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the SharePoint group is available
+: 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
+: 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
+: Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
 
-`--userName <userName>`
-: The UPN of the user that needs to be removed (user principal name, eg. megan.bowen@contoso.com)
+`--userName [userName]`
+: The UPN (user principal name, eg. megan.bowen@contoso.com) of the user that needs to be removed. Specify either `userName`, `email`, or `userId`, but not multiple.
+
+`--email [email]`
+: The email of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
+
+`--userId [userId]`
+: The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
 
 --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_
+Remove a user from a SharePoint group by userName.
 
 ```sh
 m365 spo group member 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_
+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" --email "Alex.Wilber@contoso.com"
+```
+
+Remove a user from a SharePoint group by id.
 
 ```sh
-m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userName "Alex.Wilber@contoso.com"
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md

@@ -0,0 +1,65 @@
+# spo list retentionlabel ensure
+
+Sets a default retention label on the specified list or library.
+
+## Usage
+
+```sh
+m365 spo list retentionlabel ensure [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label set [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located.
+
+`--label <label>`
+: The label to set on the list.
+
+`-t, --listTitle [listTitle]`
+: The title of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`-l, --listId [listId]`
+: The ID of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--syncToItems`
+: Specify, to set the label on all existing items in the list.
+
+`--blockDelete`
+: (deprecated) Specify, to disallow deleting items in the list.
+
+`--blockEdit`
+: (deprecated) Specify, to disallow editing items in the list.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items. 
+
+## Examples
+
+Sets retention label on the list with specified site-relative URL located in the specified site.
+
+```sh
+m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
+```
+
+Sets retention label and disables editing and deleting items on the list and all existing items for the list with specified title located in the specified site.
+
+```sh
+m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,16 +11,16 @@ m365 spo listitem remove [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the list to remove is located
+: URL of the site where the list item to remove is located
 
 `-i, --id <id>`
 : The ID of the list item to remove.
 
 `-l, --listId [listId]`
-: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
+: ID of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
 
 `-t, --listTitle [listTitle]`
-: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
+: Title of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
 
 `--listUrl [listUrl]`
 : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
@@ -35,19 +35,19 @@ m365 spo listitem remove [options]
 
 ## Examples
 
-Remove the list item with ID _1_ from list with ID  _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Remove the list item located in a given site based on the list id
 
 ```sh
 m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
 ```
 
-Remove the list item with ID _1_ from list with title _List 1_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Remove the list item located in a given site based on the list title
 
 ```sh
 m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1
 ```
 
-Remove the list item with a specific ID from a list retrieved by server-relative URL located in a specific site
+Remove the list item located in a given site based on the server-relative list url
 
 ```sh
 m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1

package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.md

@@ -0,0 +1,55 @@
+# spo listitem retentionlabel remove
+
+Clears the retention label from a list item
+
+## Usage
+
+```sh
+m365 spo listitem retentionlabel remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the retentionlabel from a listitem to remove is located
+
+`-i, --listItemId <listItemId>`
+: The ID of the list item for which the retention label should be removed.
+
+`-l, --listId [listId]`
+: ID of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
+
+`-t, --listTitle [listTitle]`
+: Title of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`--confirm`
+: Don't prompt for confirming removing the retention label from a list item
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the retention label from a list item in a given site based on the list id
+
+```sh
+m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
+```
+
+Removes the retention label from a list item in a given site based on the list title
+
+```sh
+m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
+```
+
+Removes the retention label from a list item in a given site based on the server relative list url
+
+```sh
+m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,55 @@
+# spo site appcatalog list
+
+List all site collection app catalogs within the tenant
+
+## Usage
+
+```sh
+m365 spo site appcatalog list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you need to have at least read permissions on the SharePoint root site.
+
+## Examples
+
+List all site collection app catalogs within the tenant
+
+```sh
+m365 spo site appcatalog list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "AbsoluteUrl": "https://contoso.sharepoint.com/sites/site1",
+        "ErrorMessage": "Success",
+        "SiteID": "9798e615-b586-455e-8486-84913f492c49"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    AbsoluteUrl                                          SiteID
+    ---------------------------------------------------  ------------------------------------
+    https://contoso.sharepoint.com/sites/site1           9798e615-b586-455e-8486-84913f492c49
+    ```
+
+=== "CSV"
+
+    ```csv
+    AbsoluteUrl,SiteID
+    https://contoso.sharepoint.com/sites/site1,9798e615-b586-455e-8486-84913f492c49
+    ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.1.0-beta.f818fbb",
+  "version": "6.1.0",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -271,4 +271,4 @@
     "sinon": "^14.0.2",
     "source-map-support": "^0.5.21"
   }
-}
+}