@pnp/cli-microsoft365 6.0.0-beta.f76b591 → 6.0.0-beta.f782445

package/docs/docs/cmd/onenote/notebook/notebook-list.md

@@ -0,0 +1,70 @@
+# onenote notebook list
+
+Retrieve a list of notebooks.
+
+## Usage
+
+```sh
+m365 onenote notebook list [options]
+```
+
+## Options
+
+`--userId [userId]`
+: Id of the user. Use either userId or userName, but not both.
+
+`--userName [userName]`
+: Name of the user. Use either userId or userName, but not both.
+
+`--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.
+
+`-u, --webUrl [webUrl]`
+: URL of the SharePoint site.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List Microsoft OneNote notebooks for the currently logged in user
+
+```sh
+m365 onenote notebook list
+```
+
+List Microsoft OneNote notebooks in group 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
+
+```sh
+m365 onenote notebook list --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
+```
+
+List Microsoft OneNote notebooks in group My Group
+
+```sh
+m365 onenote notebook list --groupName "MyGroup"
+```
+
+List Microsoft OneNote notebooks for user user1@contoso.onmicrosoft.com
+
+```sh
+m365 onenote notebook list --userName user1@contoso.onmicrosoft.com
+```
+
+List Microsoft OneNote notebooks for user 2609af39-7775-4f94-a3dc-0dd67657e900
+
+```sh
+m365 onenote notebook list --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+```
+
+List Microsoft OneNote notebooks for site https://contoso.sharepoint.com/sites/testsite
+
+```sh
+m365 onenote notebook list --webUrl https://contoso.sharepoint.com/sites/testsite
+```
+
+## More information
+
+- List notebooks (MS Graph docs): [https://docs.microsoft.com/en-us/graph/api/onenote-list-notebooks?view=graph-rest-1.0&tabs=http](https://docs.microsoft.com/en-us/graph/api/onenote-list-notebooks?view=graph-rest-1.0&tabs=http)

package/docs/docs/cmd/outlook/mail/mail-send.md

@@ -1,4 +1,4 @@
-# outlook sendmail
+# outlook mail send
 
 Sends e-mail on behalf of the current user
 
@@ -8,12 +8,6 @@ Sends e-mail on behalf of the current user
 m365 outlook mail send [options]
 ```
 
-## Alias
-
-```sh
-m365 outlook sendmail [options]
-```
-
 ## Options
 
 `-s, --subject <subject>`

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

@@ -10,7 +10,7 @@ m365 pp environment list [options]
 
 ## Options
 
-`-a, --asAdmin [teamId]`
+`-a, --asAdmin`
 Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
 
 --8<-- "docs/cmd/_global.md"

package/docs/docs/cmd/request.md

@@ -0,0 +1,76 @@
+# request
+
+Executes the specified web request using CLI for Microsoft 365
+
+## Usage
+
+```sh
+m365 request [options]
+```
+
+## Options
+
+`-u, --url <url>`
+: The request URL.
+
+`-m, --method [method]`
+: The HTTP request method. Accepted values are `get, post, put, patch, delete, head, options`. The default value is `get`.
+
+`-r, --resource [resource]`
+: The resource uri for which the CLI should acquire a token from AAD in order to access
+the service.
+
+`-b, --body [body]`
+: The request body. Optionally use `@example.json` to load the body from a file.
+
+`-p, --filePath [filePath]`
+: The file path to save the response to. This option can be used when downloading files.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When executing a request, CLI will take care of the very basic configuration, and you'll need to specify all additional information, such as headers, method and body. CLI will take care for you of:
+
+- applying compression and handling throttling,
+- setting the `accept` to `application/json` if you don't specify it yourself,
+- setting the `authorization` header to the bearer token obtained for the resource determined from the request URL
+
+If you specify the `resource` option, the CLI will try to retrieve a valid token for the resource instead of determining the resource based on the url. The value doesn't have to be a URL. It can be also a URI like `app://<guid>`.
+
+Specify additional headers by typing them as options, for example: `--content-type "application/json"`, `--if-match "*"`, `--x-requestdigest "somedigest"`.
+
+!!! important
+    When building the request, depending on the shell you use, you might need to escape all `$` characters in the URL, request headers, and the body. If you don't do it, the shell will treat it as a variable and will remove the following word from the request, breaking the request.
+
+## Examples
+
+Call the SharePoint Rest API using a GET request with a constructed URL containing expands, filters and selects.
+
+```sh
+m365 request --url "https://contoso.sharepoint.com/sites/project-x/_api/web/siteusers?\$filter=IsShareByEmailGuestUser eq true&\$expand=Groups&\$select=Title,LoginName,Email,Groups/LoginName" --accept "application/json;odata=nometadata"
+```
+
+Call the Microsoft Graph beta endpoint using a GET request.
+
+```sh
+m365 request --url "https://graph.microsoft.com/beta/me"
+```
+
+Call the SharePoint API to retrieve a form digest.
+
+```sh
+m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/contextinfo"
+```
+
+Call the SharePoint API to update a site title.
+
+```sh
+m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/web" --body '{ "Title": "New title" }' --content-type "application/json" --x-http-method "PATCH"
+```
+
+Call the Microsoft Graph to get a profile photo.
+
+```sh
+m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
+```

package/docs/docs/cmd/search/externalconnection/externalconnection-remove.md

@@ -0,0 +1,40 @@
+# search externalconnection remove
+
+Allow the administrator to remove a specific external connection used in Microsoft Search.
+
+## Usage
+
+```sh
+m365 search externalconnection remove [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the External Connection to remove. Specify either `id` or `name`
+
+`-n, --name [name]`
+: Name of the External Connection to remove. Specify either `id` or `name`
+
+`--confirm`
+: Don't prompt for confirming removing the connection
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the command finds multiple external connections used in Microsoft Search with the specified name, it will prompt you to disambiguate which external connection it should remove, listing the discovered IDs.
+
+## Examples
+
+Removes external connection with id _MyApp_
+
+```sh
+m365 search externalconnection remove --id "MyApp"
+```
+
+Removes external connection with name _Test_. Will NOT prompt for confirmation before removing.
+
+```sh
+m365 search externalconnection remove --name "Test" --confirm
+```

package/docs/docs/cmd/spfx/project/project-upgrade.md

@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.15.2).
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0-beta.1).
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
 

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -37,7 +37,7 @@ This commands helps you to verify if your environment meets all prerequisites fo
 
 The command starts by detecting the version of SharePoint Framework that you want to use. First, it looks at the current project. If you didn't run the command in the context of a SharePoint Framework project, the command will try to determine the SharePoint Framework version based on the SharePoint Framework Yeoman generator that you have installed either in the current directory or globally.
 
-Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
+Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp CLI and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
 
 If you miss any required tools or use a version that doesn't meet the SharePoint Framework requirements, the command will give you a list of recommendation how to address these issues.
 
@@ -51,11 +51,11 @@ Next to verifying the readiness of your environment to use a particular version
 Verify if your environment meets the requirements to work with the SharePoint Framework
 
 ```sh
-m365 spfx doctor
+m365 spfx doctor --output text
 ```
 
 Verify if your environment meets the requirements to work with the SharePoint Framework and also if the version of the SharePoint Framework that you're using is compatible with SharePoint 2019
 
 ```sh
-m365 spfx doctor --env sp2019
+m365 spfx doctor --env sp2019 --output text
 ```

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

@@ -1,6 +1,6 @@
 # spo hubsite unregister
 
-Unregisters the specifies site collection as a hub site
+Unregisters the specified site collection as a hub site
 
 ## Usage
 
@@ -33,7 +33,7 @@ Unregister the site collection with URL _https://contoso.sharepoint.com/sites/sa
 m365 spo hubsite unregister --url https://contoso.sharepoint.com/sites/sales
 ```
 
-Unregister the site collection with URL _https://contoso.sharepoint.com/sites/sales_ as a hub site without prompting for confirmation
+Unregister the site collection with URL _https://contoso.sharepoint.com/sites/sales_ as a hub site without prompting for confirmation.
 
 ```sh
 m365 spo hubsite unregister --url https://contoso.sharepoint.com/sites/sales --confirm

package/docs/docs/cmd/spo/list/list-roleassignment-add.md

@@ -26,10 +26,10 @@ m365 spo list roleassignment add [options]
 : SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify principalId only when upn or groupName are not used.
 
 `--upn [upn]`
-: Upn/email of user to assign role to. Specify either upn or princpialId
+: Upn/email of user to assign role to. Specify either upn or principalId
 
 `--groupName [groupName]`
-: Enter group name of Azure AD or SharePoint group.. Specify either groupName or princpialId
+: Enter group name of Azure AD or SharePoint group.. Specify either groupName or principalId
 
 `--roleDefinitionId [roleDefinitionId]`
 : ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both

package/docs/docs/cmd/spo/list/list-roleassignment-remove.md

@@ -26,10 +26,13 @@ m365 spo list roleassignment remove [options]
 : SharePoint ID of principal it may be either user id or group id we want to remove permissions Specify principalId only when upn or groupName are not used.
 
 `--upn [upn]`
-: upn/email of user. Specify either upn or princpialId.
+: upn/email of user. Specify either upn or principalId.
 
 `--groupName [groupName]`
-: enter group name of Azure AD or SharePoint group. Specify either groupName or princpialId.
+: enter group name of Azure AD or SharePoint group. Specify either groupName or principalId.
+
+`--confirm`
+: Don't prompt for confirming removing the role assignment
 
 --8<-- "docs/cmd/_global.md"
 

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

@@ -0,0 +1,67 @@
+# spo listitem roleassignment remove
+
+Removes a role assignment from a listitem.
+
+## Usage
+
+```sh
+m365 spo listitem roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the listitem is located
+
+`-i, --listId [listId]`
+: ID of the list. Specify either listId, listTitle or listUrl but not multiple.
+
+`-t, --listTitle [listTitle]`
+: Title of the list. Specify either listId, listTitle or listUrl but not multiple.
+
+`--listUrl [listUrl]`
+: Relative URL of the list. Specify either listId, listTitle or listUrl but not multiple.
+
+`--listItemId <listItemId>`
+: Id of the listitem to remove the role from.
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we want to remove permissions Specify principalId only when upn or groupName are not used.
+
+`--upn [upn]`
+: upn/email of user. Specify either upn or principalId.
+
+`--groupName [groupName]`
+: enter group name of Azure AD or SharePoint group. Specify either groupName or principalId.
+
+`--confirm`
+: Don't prompt for confirming removing the role assignment
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove roleassignment from listitem getting list by title based on group name
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listTitle "someList" --listItemId 1 --groupName "saleGroup"
+```
+
+Remove roleassignment from listitem getting list by title based on principal Id
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listTitle "Events" --listItemId 1 --principalId 2
+```
+
+Remove roleassignment from listitem getting list by url based on principal Id
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --listItemId 1 --principalId 2
+```
+
+
+Remove roleassignment from listitem getting list by url based on principal Id without prompting for confirmation
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --listItemId 1 --principalId 2 --confirm
+```

package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md

@@ -36,23 +36,23 @@ By default, when breaking permissions inheritance, the list item will retain exi
 Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --id 1
+m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --listItemId 1
 ```
 
 Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --id 1
+m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --listItemId 1
 ```
 
-Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
 
 ```sh
-m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --id 1 --clearExistingPermissions
+m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --listItemId 1 --clearExistingPermissions
 ```
 
-Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
 
 ```sh
-m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --id 1 --clearExistingPermissions
+m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --listItemId 1 --clearExistingPermissions
 ```

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

@@ -87,9 +87,9 @@ The value of the `--storageQuota` option must not exceed the company's available
 
 The value of the `--storageQuotaWarningLevel` option must not exceed the the value of the `--storageQuota` option.
 
-If you try to create a site with the same URL as a site that has been previously moved to the recycle bin, you will get an error. To avoid this error, you can use the `--removeDeletedSite` option. Prior to creating the site, the spo site classic add command will check if the site with the specified URL has been previously moved to the recycle bin and if so, will remove it. Because removing sites from the recycle bin might take a moment, it should be used in conjunction with the `--wait` option so that the new site is not created before the old site is fully removed.
+If you try to create a site with the same URL as a site that has been previously moved to the recycle bin, you will get an error. To avoid this error, you can use the `--removeDeletedSite` option. Prior to creating the site, the spo site add command will check if the site with the specified URL has been previously moved to the recycle bin and if so, will remove it. Because removing sites from the recycle bin might take a moment, it should be used in conjunction with the `--wait` option so that the new site is not created before the old site is fully removed.
 
-Deleting and creating classic site collections is by default asynchronous and depending on the current state of Office 365, might take up to few minutes. If you're building a script with steps that require the site to be fully provisioned, you should use the `--wait` flag. When using this flag, the spo site classic add command will keep running until it received confirmation from Office 365 that the site has been fully provisioned.
+Deleting and creating classic site collections is by default asynchronous and depending on the current state of Office 365, might take up to few minutes. If you're building a script with steps that require the site to be fully provisioned, you should use the `--wait` flag. When using this flag, the spo site add command will keep running until it received confirmation from Office 365 that the site has been fully provisioned.
 
 ## Remarks for modern sites
 

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

@@ -11,12 +11,6 @@ Connects site collection to an Microsoft 365 Group
 m365 spo site groupify [options]
 ```
 
-## Alias
-
-```sh
-m365 spo site groupify
-```
-
 ## Options
 
 `-u, --url <url>`

package/docs/docs/cmd/spo/web/web-roleassignment-add.md

@@ -0,0 +1,57 @@
+# spo web roleassignment add
+
+Adds a role assignment to web permissions.
+
+## Usage
+
+```sh
+m365 spo web roleassignment add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify principalId only when upn or groupName are not used.
+
+`--upn [upn]`
+: upn/email of user to assign role to. Specify either upn or principalId
+
+`--groupName [groupName]`
+: enter group name of Azure AD or SharePoint group.. Specify either groupName or principalId
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
+
+`--roleDefinitionName [roleDefinitionName]`
+: enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionId 1073741829
+```
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for upn _someaccount@tenant.onmicrosoft.com_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
+```
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for group _someGroup_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --groupName "someGroup" --roleDefinitionId 1073741829
+```
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition name _Full Control_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionName "Full Control"
+```

package/docs/docs/cmd/spo/web/web-roleassignment-remove.md

@@ -0,0 +1,54 @@
+# spo web roleassignment remove
+
+Removes a role assignment from web permissions.
+
+## Usage
+
+```sh
+m365 spo web roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify principalId only when upn or groupName are not used.
+
+`--upn [upn]`
+: Upn/email of user to assign role to. Specify upn only when principalId or groupName are not used.
+
+`--groupName [groupName]`
+: Enter group name of Azure AD or SharePoint group. Specify groupName only when principalId or upn are not used.
+
+`--confirm [confirm]`
+: Don't prompt for confirming removing the roleassignment.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove roleassignment from web based on group name
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --groupName "saleGroup"
+```
+
+Remove roleassignment from web based on principal Id
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2
+```
+
+Remove roleassignment from web based on upn
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --upn "someaccount@tenant.onmicrosoft.com"
+```
+
+Remove roleassignment from web based on principal Id without prompting for confirmation
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2 --confirm
+```

package/docs/docs/cmd/teams/channel/channel-member-add.md

@@ -8,12 +8,6 @@ Adds a specified member in the specified Microsoft Teams private team channel
 m365 teams channel member add [options]
 ```
 
-## Alias
-
-```sh
-m365 teams conversationmember add [options]
-```
-
 ## Options
 
 `-i, --teamId [teamId]`

package/docs/docs/cmd/teams/channel/channel-member-list.md

@@ -8,12 +8,6 @@ Lists members of the specified Microsoft Teams team channel
 m365 teams channel member list [options]
 ```
 
-## Alias
-
-```sh
-m365 teams conversationmember list [options]
-```
-
 ## Options
 
 `-i, --teamId [teamId]`

package/docs/docs/cmd/teams/channel/channel-member-remove.md

@@ -8,12 +8,6 @@ Remove the specified member from the specified Microsoft Teams private team chan
 m365 teams channel member remove [options]
 ```
 
-## Alias
-
-```sh
-m365 teams conversationmember remove [options]
-```
-
 ## Options
 
 `--teamId [teamId]`