@pnp/cli-microsoft365 9.0.0-beta.e69e8d0 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +11 -12
  4. package/dist/Command.js +1 -3
  5. package/dist/cli/cli.js +68 -14
  6. package/dist/config.js +60 -5
  7. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  8. package/dist/m365/base/SpoCommand.js +1 -1
  9. package/dist/m365/cli/commands/cli-consent.js +2 -2
  10. package/dist/m365/cli/commands/cli-doctor.js +2 -2
  11. package/dist/m365/cli/commands/cli-reconsent.js +2 -3
  12. package/dist/m365/cli/commands/config/config-set.js +12 -3
  13. package/dist/m365/commands/login.js +38 -14
  14. package/dist/m365/commands/setup.js +256 -33
  15. package/dist/m365/commands/status.js +2 -2
  16. package/dist/m365/connection/commands/connection-list.js +4 -4
  17. package/dist/m365/entra/commands/app/app-add.js +52 -288
  18. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
  19. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
  20. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
  21. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-remove.js +123 -0
  22. package/dist/m365/entra/commands/group/group-set.js +256 -0
  23. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  24. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  25. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  26. package/dist/m365/entra/commands/m365group/m365group-user-list.js +9 -6
  27. package/dist/m365/entra/commands.js +3 -0
  28. package/dist/m365/onenote/commands/notebook/notebook-add.js +132 -0
  29. package/dist/m365/onenote/commands.js +1 -0
  30. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  31. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  32. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +10 -1
  33. package/dist/m365/spo/commands/file/file-copy.js +34 -55
  34. package/dist/m365/spo/commands/folder/folder-set.js +4 -0
  35. package/dist/m365/spo/commands/list/list-list.js +4 -1
  36. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +24 -48
  37. package/dist/m365/spo/commands/site/site-get.js +12 -16
  38. package/dist/m365/spo/commands/site/site-remove.js +7 -1
  39. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +22 -2
  40. package/dist/m365/spo/commands.js +1 -0
  41. package/dist/m365/teams/commands/message/message-restore.js +106 -0
  42. package/dist/m365/teams/commands.js +1 -0
  43. package/dist/settingsNames.js +7 -1
  44. package/dist/utils/entraApp.js +283 -0
  45. package/dist/utils/spo.js +0 -74
  46. package/docs/docs/_clisettings.mdx +6 -0
  47. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  48. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  49. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  50. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  51. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-remove.mdx +65 -0
  52. package/docs/docs/cmd/entra/group/group-add.mdx +0 -4
  53. package/docs/docs/cmd/entra/group/group-set.mdx +89 -0
  54. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  55. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  56. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  57. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  58. package/docs/docs/cmd/onenote/notebook/notebook-add.mdx +169 -0
  59. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  60. package/docs/docs/cmd/setup.mdx +16 -3
  61. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +12 -11
  62. package/docs/docs/cmd/spo/file/file-copy.mdx +12 -119
  63. package/docs/docs/cmd/spo/folder/folder-set.mdx +6 -0
  64. package/docs/docs/cmd/spo/list/list-list.mdx +7 -5
  65. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +2 -11
  66. package/docs/docs/cmd/spo/site/site-remove.mdx +3 -0
  67. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +49 -2
  68. package/docs/docs/cmd/teams/message/message-remove.mdx +2 -1
  69. package/docs/docs/cmd/teams/message/message-restore.mdx +62 -0
  70. package/npm-shrinkwrap.json +0 -1
  71. package/package.json +2 -3
@@ -22,39 +22,39 @@ m365 entra sp add [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `-i, --id [id]`
26
- : ID of the app for which the enterprise application should be created.
25
+ `--appId [appId]`
26
+ : ID of the app for which the enterprise application should be created
27
27
 
28
- `-n, --displayName [displayName]`
29
- : Display name of the app for which the enterprise application should be created.
28
+ `--appName [appName]`
29
+ : Display name of the app for which the enterprise application should be created
30
30
 
31
31
  `--objectId [objectId]`
32
- : ObjectId of the app for which the enterprise application should be created.
32
+ : ObjectId of the app for which the enterprise application should be created
33
33
  ```
34
34
 
35
35
  <Global />
36
36
 
37
37
  ## Remarks
38
38
 
39
- Specify either the `id`, `displayName` or `objectId`. If you specify more than one option value, the command will fail with an error.
39
+ Specify either the `appId`, `appName` or `objectId`. If you specify more than one option value, the command will fail with an error.
40
40
 
41
41
  If you register an application in the portal, an application object as well as an enterprise application object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the enterprise application separately. To register/create an application using the CLI for Microsoft 365, use the [m365 entra app add](../app/app-add.mdx) command.
42
42
 
43
43
  ## Examples
44
44
 
45
- Creates an enterprise application for a registered Entra app with the specified id.
45
+ Creates an enterprise application for a registered Entra app with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
46
46
 
47
47
  ```sh
48
- m365 entra enterpriseapp add --id b2307a39-e878-458b-bc90-03bc578531d6
48
+ m365 entra enterpriseapp add --appId b2307a39-e878-458b-bc90-03bc578531d6
49
49
  ```
50
50
 
51
- Creates an enterprise application for a registered Entra app with the specified displayName.
51
+ Creates an enterprise application for a registered Entra app with appName _Microsoft Graph_.
52
52
 
53
53
  ```sh
54
- m365 entra enterpriseapp add --displayName "Microsoft Graph"
54
+ m365 entra enterpriseapp add --appName "Microsoft Graph"
55
55
  ```
56
56
 
57
- Creates an enterprise application for a registered Entra app with the specified objectId.
57
+ Creates an enterprise application for a registered Entra app with objectId _b2307a39-e878-458b-bc90-03bc578531d6_.
58
58
 
59
59
  ```sh
60
60
  m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
@@ -172,7 +172,7 @@ m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
172
172
  <TabItem value="Markdown">
173
173
 
174
174
  ```md
175
- # entra enterpriseapp add --id "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
175
+ # entra enterpriseapp add --appId "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
176
176
 
177
177
  Date: 2023-06-02
178
178
 
@@ -22,40 +22,40 @@ m365 entra sp get [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `-i, --id [id]`
26
- : ID of the application for which the enterprise application should be retrieved.
25
+ `-i, --appId [appId]`
26
+ : ID of the application for which the enterprise application should be retrieved
27
27
 
28
- `-n, --displayName [displayName]`
29
- : Display name of the application for which the enterprise application should be retrieved.
28
+ `-n, --appDisplayName [appDisplayName]`
29
+ : Display name of the application for which the enterprise application should be retrieved
30
30
 
31
- `--objectId [objectId]`
32
- : ObjectId of the application for which the enterprise application should be retrieved.
31
+ `--appObjectId [appObjectId]`
32
+ : ObjectId of the application for which the enterprise application should be retrieved
33
33
  ```
34
34
 
35
35
  <Global />
36
36
 
37
37
  ## Remarks
38
38
 
39
- Specify either the `id`, `objectId` or `displayName`. If you specify more than one option value, the command will fail with an error.
39
+ Specify either the `appId`, `appObjectId` or `appDisplayName`. If you specify more than one option value, the command will fail with an error.
40
40
 
41
41
  ## Examples
42
42
 
43
- Return details about the enterprise application with the specified id.
43
+ Return details about the enterprise application with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
44
44
 
45
45
  ```sh
46
- m365 entra enterpriseapp get --id b2307a39-e878-458b-bc90-03bc578531d6
46
+ m365 entra enterpriseapp get --appId b2307a39-e878-458b-bc90-03bc578531d6
47
47
  ```
48
48
 
49
- Return details about the enterprise application with the specified displayName.
49
+ Return details about the _Microsoft Graph_ enterprise application.
50
50
 
51
51
  ```sh
52
- m365 entra enterpriseapp get --displayName "Microsoft Graph"
52
+ m365 entra enterpriseapp get --appDisplayName "Microsoft Graph"
53
53
  ```
54
54
 
55
- Return details about the enterprise application with the specified ObjectId.
55
+ Return details about the enterprise application with ObjectId _b2307a39-e878-458b-bc90-03bc578531dd_.
56
56
 
57
57
  ```sh
58
- m365 entra enterpriseapp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
58
+ m365 entra enterpriseapp get --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
59
59
  ```
60
60
 
61
61
  ## Response
@@ -198,7 +198,7 @@ m365 entra enterpriseapp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
198
198
  <TabItem value="Markdown">
199
199
 
200
200
  ```md
201
- # entra enterpriseapp get --id "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
201
+ # entra enterpriseapp get --appId "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
202
202
 
203
203
  Date: 2023-06-02
204
204
 
@@ -22,24 +22,24 @@ m365 entra sp list [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `-n, --displayName [displayName]`
26
- : Returns only enterprise applications with the specified name.
25
+ `--displayName [displayName]`
26
+ : Returns only enterprise applications with the specified name
27
27
 
28
28
  `--tag [tag]`
29
- : Returns only enterprise applications with the specified tag.
29
+ : Returns only enterprise applications with the specified tag
30
30
  ```
31
31
 
32
32
  <Global />
33
33
 
34
34
  ## Examples
35
35
 
36
- Returns a list of all enterprise applications.
36
+ Return a list of all enterprise applications
37
37
 
38
38
  ```sh
39
39
  m365 entra enterpriseapp list
40
40
  ```
41
41
 
42
- Returns a list of all enterprise applications that comply with the specified display name and the tag parameters.
42
+ Return a list of all enterprise applications that comply with the display name and the tag parameters
43
43
 
44
44
  ```sh
45
45
  m365 entra enterpriseapp list --displayName "My custom enterprise application" --tag "WindowsAzureActiveDirectoryIntegratedApp"
@@ -0,0 +1,65 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # entra enterpriseapp remove
6
+
7
+ Deletes an enterprise application (or service principal)
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 entra enterpriseapp remove [options]
13
+ ```
14
+
15
+ ## Alias
16
+
17
+ ```sh
18
+ m365 entra sp remove [options]
19
+ ```
20
+
21
+ ## Options
22
+
23
+ ```md definition-list
24
+ `-i, --id [id]`
25
+ : ID of the enterprise application.
26
+
27
+ `-n, --displayName [displayName]`
28
+ : Display name of the enterprise application.
29
+
30
+ `--objectId [objectId]`
31
+ : ObjectId of the enterprise application.
32
+
33
+ `-f, --force`
34
+ : Don't prompt for confirmation.
35
+ ```
36
+
37
+ <Global />
38
+
39
+ ## Examples
40
+
41
+ Delete an enterprise application by application ID.
42
+
43
+ ```sh
44
+ m365 entra enterpriseapp remove --id b2307a39-e878-458b-bc90-03bc578531d6 --force
45
+ ```
46
+
47
+ Delete an enterprise application by display name.
48
+
49
+ ```sh
50
+ m365 entra enterpriseapp remove --displayName "Contoso app"
51
+ ```
52
+
53
+ Delete an enterprise application by object ID.
54
+
55
+ ```sh
56
+ m365 entra enterpriseapp remove --objectId b2307a39-e878-458b-bc90-03bc578531dd
57
+ ```
58
+
59
+ ## Response
60
+
61
+ The command won't return a response on success.
62
+
63
+ ## More information
64
+
65
+ - Application and service principal objects in Microsoft Entra ID: [https://learn.microsoft.com/azure/active-directory/develop/active-directory-application-objects](https://learn.microsoft.com/azure/active-directory/develop/active-directory-application-objects)
@@ -53,8 +53,6 @@ m365 aad group add [options]
53
53
 
54
54
  ## Remarks
55
55
 
56
- :::info
57
-
58
56
  The `visibility` option affects the behavior of the group.
59
57
 
60
58
  With the `Public` visibility:
@@ -74,8 +72,6 @@ With the `HiddenMembership` visibility:
74
72
  - Administrators (global, company, user, and helpdesk) can view the membership of the group.
75
73
  - The group appears in the global address book (GAL).
76
74
 
77
- :::
78
-
79
75
  :::note
80
76
 
81
77
  The `HiddenMembership` visibility can be set only for Microsoft 365 groups when the groups are created. It can't be updated later.
@@ -0,0 +1,89 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # entra group set
4
+
5
+ Updates a Microsoft Entra group
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 entra group set [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-i, --id [id]`
17
+ : The ID of the Microsoft Entra group to update. Specify either `id` or `displayName` but not both.
18
+
19
+ `-n, --displayName [displayName]`
20
+ : The display name of the Microsoft Entra group to update. Specify either `id` or `displayName` but not both.
21
+
22
+ `--newDisplayName [newDisplayName]`
23
+ : The new display name of the Microsoft Entra group. The maximum length is 256 characters.
24
+
25
+ `--description [description]`
26
+ : The new description for the group.
27
+
28
+ `--mailNickname [mailNickname]`
29
+ : The new mail alias for the group (part before the @). Use only for mail-enabled groups. Maximum length is 64 characters.
30
+
31
+ `--ownerIds [ownerIds]`
32
+ : Comma-separated list of IDs of Microsoft Entra users that will be the group owners. Specify either `ownerIds` or `ownerUserNames`, but not both.
33
+
34
+ `--ownerUserNames [ownerUserNames]`
35
+ : Comma-separated list of UPNs of Microsoft Entra users that will be the group owners. Specify either `ownerIds` or `ownerUserNames`, but not both.
36
+
37
+ `--memberIds [memberIds]`
38
+ : Comma-separated list of IDs of Microsoft Entra users that will be the group members. Specify either `memberIds` or `memberUserNames`, but not both.
39
+
40
+ `--memberUserNames [memberUserNames]`
41
+ : Comma-separated list of UPNs of Microsoft Entra users that will be the group members. Specify either `memberIds` or `memberUserNames`, but not both.
42
+
43
+ `--visibility [visibility]`
44
+ : Specifies the group join policy and group content visibility for Microsoft 365 groups. Possible values are: `Private` or `Public`. Specify only when targeting a Microsoft 365 group.
45
+ ```
46
+
47
+ <Global />
48
+
49
+ ## Remarks
50
+
51
+ The `visibility` option affects the behavior of the group.
52
+
53
+ With the `Public` visibility:
54
+ - Anyone can join the group without needing owner approval.
55
+ - Anyone can view the attributes of the group.
56
+ - Anyone can see the members of the group.
57
+
58
+ With the `Private` visibilty:
59
+ - Owner approval is needed to join the group.
60
+ - Anyone can view the attributes of the group.
61
+ - Anyone can see the members of the group.
62
+
63
+ If the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
64
+
65
+ Specifying `memberIds` or `memberUserNames` will make only those users members, removing all others. Similarly, specifying `ownerIds` or `ownerUserNames` will make only those users owners, removing all others.
66
+
67
+ ## Examples
68
+
69
+ Update the display name of a group specified by the display name
70
+
71
+ ```sh
72
+ m365 entra group set --displayName Devs --newDisplayName Developers
73
+ ```
74
+
75
+ Set the owners of a group to the specified people
76
+
77
+ ```sh
78
+ m365 entra group set --id 57fd6b33-54eb-42b0-9ea0-8a9ac04eab7d --ownerUserNames "john.doe@contoso.com,adele.vance@contoso.com"
79
+ ```
80
+
81
+ Update the description and mail nickname of a group
82
+
83
+ ```sh
84
+ m365 entra group set --id 57fd6b33-54eb-42b0-9ea0-8a9ac04eab7d --description "All developers of the company" --mailNickname developers
85
+ ```
86
+
87
+ ## Response
88
+
89
+ The command won't return a response on success.
@@ -22,10 +22,10 @@ m365 aad group user list [options]
22
22
 
23
23
  ```md definition-list
24
24
  `-i, --groupId [groupId]`
25
- : The ID of the Entra group. Specify `groupId` or `groupName` but not both.
25
+ : The ID of the Entra group. Specify `groupId` or `groupDisplayName` but not both.
26
26
 
27
- `-n, --groupName [groupName]`
28
- : The display name of the Entra group. Specify `groupId` or `groupName` but not both.
27
+ `-n, --groupDisplayName [groupDisplayName]`
28
+ : The display name of the Entra group. Specify `groupId` or `groupDisplayName` but not both.
29
29
 
30
30
  `-r, --role [role]`
31
31
  : Filter the results to only users with the given role: `Owner`, `Member`.
@@ -54,25 +54,25 @@ m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
54
54
  List all owners from a group specified by display name.
55
55
 
56
56
  ```sh
57
- m365 entra group user list --groupName Developers --role Owner
57
+ m365 entra group user list --groupDisplayName Developers --role Owner
58
58
  ```
59
59
 
60
60
  List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
61
61
 
62
62
  ```sh
63
- m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
63
+ m365 entra group user list --groupDisplayName Developers --properties "displayName,mail,manager/displayName"
64
64
  ```
65
65
 
66
66
  List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
67
67
 
68
68
  ```sh
69
- m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
69
+ m365 entra group user list --groupDisplayName Developers --properties "displayName,mail,manager/*"
70
70
  ```
71
71
 
72
72
  List all group members that are guest users.
73
73
 
74
74
  ```sh
75
- m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
75
+ m365 entra group user list --groupDisplayName Developers --filter "userType eq 'Guest'"
76
76
  ```
77
77
 
78
78
  ## Response
@@ -22,10 +22,10 @@ m365 aad m365group conversation post list [options]
22
22
 
23
23
  ```md definition-list
24
24
  `-i, --groupId [groupId]`
25
- : The Id of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
25
+ : The Id of the Microsoft 365 Group. You can specify the groupId or groupDisplayName, but not both.
26
26
 
27
- `-d, --groupName [groupName]`
28
- : The Displayname of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
27
+ `-d, --groupDisplayName [groupDisplayName]`
28
+ : The Displayname of the Microsoft 365 Group. You can specify the groupId or groupDisplayName, but not both.
29
29
 
30
30
  `-t, --threadId <threadId>`
31
31
  : The ID of the thread to retrieve details for
@@ -41,10 +41,10 @@ Lists the posts of the specific conversation of Microsoft 365 group by groupId
41
41
  m365 entra m365group conversation post list --groupId '00000000-0000-0000-0000-000000000000' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
42
42
  ```
43
43
 
44
- Lists the posts of the specific conversation of Microsoft 365 group by groupName
44
+ Lists the posts of the specific conversation of Microsoft 365 group by groupDisplayName
45
45
 
46
46
  ```sh
47
- m365 entra m365group conversation post list --groupName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
47
+ m365 entra m365group conversation post list --groupDisplayName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
48
48
  ```
49
49
 
50
50
  ## Response
@@ -21,7 +21,7 @@ m365 aad m365group recyclebinitem list [options]
21
21
  ## Options
22
22
 
23
23
  ```md definition-list
24
- `-d, --groupName [groupName]`
24
+ `-d, --groupDisplayName [groupDisplayName]`
25
25
  : Lists groups with DisplayName starting with the specified value
26
26
 
27
27
  `-m, --groupMailNickname [groupMailNickname]`
@@ -41,7 +41,7 @@ m365 entra m365group recyclebinitem list
41
41
  List deleted Microsoft 365 Groups with display name starting with _Project_
42
42
 
43
43
  ```sh
44
- m365 entra m365group recyclebinitem list --groupName Project
44
+ m365 entra m365group recyclebinitem list --groupDisplayName Project
45
45
  ```
46
46
 
47
47
  List deleted Microsoft 365 Groups mail nick name starting with _team_
@@ -53,7 +53,7 @@ m365 entra m365group recyclebinitem list --groupMailNickname team
53
53
  List deleted Microsoft 365 Groups mail nick name starting with _team_ and with display name starting with _Project_
54
54
 
55
55
  ```sh
56
- m365 entra m365group recyclebinitem list --groupMailNickname team --groupName Project
56
+ m365 entra m365group recyclebinitem list --groupMailNickname team --groupDisplayName Project
57
57
  ```
58
58
 
59
59
  ## Response
@@ -28,7 +28,7 @@ m365 aad m365group user list [options]
28
28
  : The display name of the Microsoft 365 group. Specify `groupId` or `groupDisplayName` but not both.
29
29
 
30
30
  `-r, --role [role]`
31
- : Filter the results to only users with the given role. Allowed values: `Owner`, `Member`.
31
+ : Filter the results to only users with the given role. Allowed values: `Owner`, `Member`, or (Deprecated) `Guest`.
32
32
 
33
33
  `-p, --properties [properties]`
34
34
  : Comma-separated list of properties to retrieve.
@@ -0,0 +1,169 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # onenote notebook add
6
+
7
+ Create a new OneNote notebook.
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 onenote notebook add [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-n, --name <name>`
19
+ : Name of the notebook. Notebook names must be unique. The name cannot contain more than 128 characters or contain the following characters: `?*/:<>`
20
+
21
+ `--userId [userId]`
22
+ : Id of the user. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
23
+
24
+ `--userName [userName]`
25
+ : Name of the user. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
26
+
27
+ `--groupId [groupId]`
28
+ : Id of the SharePoint group. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
29
+
30
+ `--groupName [groupName]`
31
+ : Name of the SharePoint group. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
32
+
33
+ `-u, --webUrl [webUrl]`
34
+ : URL of the SharePoint site. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
35
+ ```
36
+
37
+ <Global />
38
+
39
+ ## Examples
40
+
41
+ Create a Microsoft OneNote notebook for the currently logged in user
42
+
43
+ ```sh
44
+ m365 onenote notebook add --name "Private Notebook"
45
+ ```
46
+
47
+ Create a Microsoft OneNote notebook in a group specified by id.
48
+
49
+ ```sh
50
+ m365 onenote notebook add --name "Private Notebook" --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
51
+ ```
52
+
53
+ Create a Microsoft OneNote notebook in a group specified by displayName.
54
+
55
+ ```sh
56
+ m365 onenote notebook add --name "Private Notebook" --groupName "MyGroup"
57
+ ```
58
+
59
+ Create a Microsoft OneNote notebook for a user specified by name
60
+
61
+ ```sh
62
+ m365 onenote notebook add --name "Private Notebook" --userName user1@contoso.onmicrosoft.com
63
+ ```
64
+
65
+ Create a Microsoft OneNote notebook for a user specified by id
66
+
67
+ ```sh
68
+ m365 onenote notebook add --name "Private Notebook" --userId 2609af39-7775-4f94-a3dc-0dd67657e900
69
+ ```
70
+
71
+ Creates a Microsoft OneNote notebooks for a site
72
+
73
+ ```sh
74
+ m365 onenote notebook add --name "Private Notebook" --webUrl https://contoso.sharepoint.com/sites/testsite
75
+ ```
76
+
77
+ ## Response
78
+
79
+ <Tabs>
80
+ <TabItem value="JSON">
81
+
82
+ ```json
83
+ {
84
+ "id": "1-08554ffd-b769-4a4a-9563-faaa3191f253",
85
+ "self": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253",
86
+ "createdDateTime": "2024-04-05T17:58:27Z",
87
+ "displayName": "Private Notebook",
88
+ "lastModifiedDateTime": "2024-04-05T17:58:27Z",
89
+ "isDefault": false,
90
+ "userRole": "Owner",
91
+ "isShared": false,
92
+ "sectionsUrl": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253/sections",
93
+ "sectionGroupsUrl": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253/sectionGroups",
94
+ "createdBy": {
95
+ "user": {
96
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
97
+ "displayName": "John Doe"
98
+ }
99
+ },
100
+ "lastModifiedBy": {
101
+ "user": {
102
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
103
+ "displayName": "John Doe"
104
+ }
105
+ },
106
+ "links": {
107
+ "oneNoteClientUrl": {
108
+ "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"
109
+ },
110
+ "oneNoteWebUrl": {
111
+ "href": "https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"
112
+ }
113
+ }
114
+ }
115
+ ```
116
+
117
+ </TabItem>
118
+ <TabItem value="Text">
119
+
120
+ ```text
121
+ createdBy : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
122
+ createdDateTime : 2024-04-05T17:58:36Z
123
+ displayName : Private Notebook
124
+ id : 1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f
125
+ isDefault : false
126
+ isShared : false
127
+ lastModifiedBy : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
128
+ lastModifiedDateTime: 2024-04-05T17:58:36Z
129
+ links : {"oneNoteClientUrl":{"href":"onenote:https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"},"oneNoteWebUrl":{"href":"https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"}}
130
+ sectionGroupsUrl : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f/sectionGroups
131
+ sectionsUrl : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f/sections
132
+ self : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f
133
+ userRole : Owner
134
+ ```
135
+
136
+ </TabItem>
137
+ <TabItem value="CSV">
138
+
139
+ ```csv
140
+ id,self,createdDateTime,displayName,lastModifiedDateTime,isDefault,userRole,isShared,sectionsUrl,sectionGroupsUrl
141
+ 1-272a5791-2c95-45cf-b27d-7f68e07f6149,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149,2024-04-05T18:00:28Z,Private Notebook,2024-04-05T18:00:28Z,,Owner,,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149/sections,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149/sectionGroups
142
+ ```
143
+
144
+ </TabItem>
145
+ <TabItem value="Markdown">
146
+
147
+ ```md
148
+ # onenote notebook add --name "Private Notebook"
149
+
150
+ Date: 05/04/2024
151
+
152
+ ## Private Notebook (1-fa279d79-4701-43a2-9593-c2abfbe6999f)
153
+
154
+ Property | Value
155
+ ---------|-------
156
+ id | 1-fa279d79-4701-43a2-9593-c2abfbe6999f
157
+ self | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f
158
+ createdDateTime | 2024-04-05T18:00:58Z
159
+ displayName | Private Notebook
160
+ lastModifiedDateTime | 2024-04-05T18:00:58Z
161
+ isDefault | false
162
+ userRole | Owner
163
+ isShared | false
164
+ sectionsUrl | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f/sections
165
+ sectionGroupsUrl | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f/sectionGroups
166
+ ```
167
+
168
+ </TabItem>
169
+ </Tabs>
@@ -19,10 +19,10 @@ m365 outlook message get [options]
19
19
  : ID of the message.
20
20
 
21
21
  `--userId [userId]`
22
- : ID of the user from which to retrieve the message. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
22
+ : ID of the user from which to retrieve the message. Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
23
23
 
24
- `--userName [userName]`
25
- : UPN of the user from which to retrieve the message Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
24
+ `--userPrincipalName [userPrincipalName]`
25
+ : UPN of the user from which to retrieve the message Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -38,7 +38,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
38
38
  Get a specific message using delegated permissions from a shared mailbox.
39
39
 
40
40
  ```sh
41
- m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName sharedmailbox@tenant.com
41
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName sharedmailbox@tenant.com
42
42
  ```
43
43
 
44
44
  Get a specific message from a specific user retrieved by user ID using application permissions.
@@ -50,7 +50,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
50
50
  Get a specific message from a specific user retrieved by user principal name using application permissions.
51
51
 
52
52
  ```sh
53
- m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName user@tenant.com
53
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName user@tenant.com
54
54
  ```
55
55
 
56
56
  ## Response