@pnp/cli-microsoft365 6.0.0-beta.c377306 → 6.0.0-beta.c561c1f

package/docs/docs/cmd/graph/changelog/changelog-list.md

@@ -0,0 +1,53 @@
+# graph changelog list
+
+Gets an overview of specific API-level changes in Microsoft Graph v1.0 and beta
+
+## Usage
+
+```sh
+m365 graph changelog list [options]
+```
+
+## Options
+
+`-v, --versions [versions]`
+: Comma-separated list of versions to show changes for. `Beta, v1.0`. When no version is selected all versions are returned.
+
+`-c, --changeType [changeType]`
+: Change type to show changes for. `Addition, Change, Deletion`. When no changeType is selected all change types are returned.
+
+`-s, --services [services]`
+: Comma-separated list of services to show changes for. `Applications, Calendar, Change notifications, Cloud communications, Compliance, Cross-device experiences, Customer booking, Device and app management, Education, Files, Financials, Groups, Identity and access, Mail, Notes, Notifications, People and workplace intelligence, Personal contacts, Reports, Search, Security, Sites and lists, Tasks and plans, Teamwork, To-do tasks, Users, Workbooks and charts`. When no service is selected all services are returned.
+
+`--startDate [startDate]`
+: The startdate used to query for changes. Supported date format is `YYYY-MM-DD`. When no date is specified all changes are returned.
+
+`--endDate [endDate]`
+: The enddate used to query for changes. Supported date format is `YYYY-MM-DD`. When no date is specified all changes are returned.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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.
+
+## Examples
+
+Get all changes within Microsoft Graph.
+
+```sh
+m365 graph changelog list
+```
+
+Get all changes within Microsoft Graph for the services _Groups_ and _Users_.
+
+```sh
+m365 graph changelog list --services 'Groups,Users'
+```
+
+Get all changes within Microsoft Graph that happend between _2021-01-01_ and _2021-05-01_.
+
+```sh
+m365 graph changelog list --startDate '2021-01-01' --endDate '2021-05-01'
+```

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/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/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-remove.md

@@ -31,6 +31,9 @@ m365 spo list roleassignment remove [options]
 `--groupName [groupName]`
 : enter group name of Azure AD or SharePoint group. Specify either groupName or princpialId.
 
+`--confirm`
+: Don't prompt for confirming removing the role assignment
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples

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 princpialId.
+
+`--groupName [groupName]`
+: enter group name of Azure AD or SharePoint group. Specify either groupName or princpialId.
+
+`--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/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 princpialId
+
+`--groupName [groupName]`
+: enter group name of Azure AD or SharePoint group.. Specify either groupName or princpialId
+
+`--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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.0.0-beta.c377306",
+  "version": "6.0.0-beta.c561c1f",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -138,6 +138,7 @@
     "Kelkar, Vipul <vipul.kelkar@outlook.com>",
     "Kesavanarayanan, Sudharsan <10280385+sudharsank@users.noreply.github.com>",
     "Khalil, Bassem <bk@bassems-air.home>",
+    "Kirkham, Don <donkirkham@live.com>",
     "Kumar, Shantha <34408892+ktskumar@users.noreply.github.com>",
     "Lamber, Patrick <patrick@nubo.eu>",
     "Laskewitz, Daniel <daniel@laskewitz.nl>",