@pnp/cli-microsoft365 9.0.0-beta.0d94b15 → 9.0.0-beta.1516729

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 (85) 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 +57 -8
  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 +9 -5
  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/group/group-user-list.js +4 -4
  22. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  23. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  24. package/dist/m365/entra/commands/m365group/m365group-user-list.js +9 -6
  25. package/dist/m365/onenote/commands/notebook/notebook-add.js +132 -0
  26. package/dist/m365/onenote/commands.js +1 -0
  27. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  28. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  29. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +10 -1
  30. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +1 -0
  31. package/dist/m365/spo/commands/file/file-copy.js +34 -55
  32. package/dist/m365/spo/commands/folder/folder-set.js +4 -0
  33. package/dist/m365/spo/commands/list/list-list.js +4 -1
  34. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +24 -48
  35. package/dist/m365/spo/commands/site/site-get.js +12 -16
  36. package/dist/m365/spo/commands/site/site-remove.js +7 -1
  37. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +22 -2
  38. package/dist/m365/spo/commands.js +1 -0
  39. package/dist/m365/viva/commands/engage/engage-group-list.js +5 -0
  40. package/dist/m365/viva/commands/engage/engage-group-user-add.js +5 -0
  41. package/dist/m365/viva/commands/engage/engage-group-user-remove.js +5 -0
  42. package/dist/m365/viva/commands/engage/engage-message-add.js +5 -0
  43. package/dist/m365/viva/commands/engage/engage-message-get.js +5 -0
  44. package/dist/m365/viva/commands/engage/engage-message-like-set.js +5 -0
  45. package/dist/m365/viva/commands/engage/engage-message-list.js +5 -0
  46. package/dist/m365/viva/commands/engage/engage-message-remove.js +5 -0
  47. package/dist/m365/viva/commands/engage/engage-network-list.js +5 -0
  48. package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +8 -0
  49. package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +8 -0
  50. package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +8 -0
  51. package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +8 -0
  52. package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +8 -0
  53. package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +8 -0
  54. package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +8 -0
  55. package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +8 -0
  56. package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +8 -0
  57. package/dist/m365/viva/commands/engage/engage-search.js +5 -0
  58. package/dist/m365/viva/commands/engage/engage-user-get.js +5 -0
  59. package/dist/m365/viva/commands/engage/engage-user-list.js +5 -0
  60. package/dist/m365/viva/commands/engage/yammerCommands.js +25 -0
  61. package/dist/settingsNames.js +7 -1
  62. package/dist/utils/entraApp.js +283 -0
  63. package/dist/utils/spo.js +0 -74
  64. package/docs/docs/_clisettings.mdx +6 -0
  65. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  66. package/docs/docs/cmd/cli/cli-consent.mdx +1 -1
  67. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  68. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  69. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  70. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  71. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  72. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  73. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  74. package/docs/docs/cmd/onenote/notebook/notebook-add.mdx +169 -0
  75. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  76. package/docs/docs/cmd/setup.mdx +16 -3
  77. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +12 -11
  78. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +5 -6
  79. package/docs/docs/cmd/spo/file/file-copy.mdx +12 -119
  80. package/docs/docs/cmd/spo/folder/folder-set.mdx +6 -0
  81. package/docs/docs/cmd/spo/list/list-list.mdx +7 -5
  82. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +2 -11
  83. package/docs/docs/cmd/spo/site/site-remove.mdx +3 -0
  84. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +49 -2
  85. package/package.json +1 -1
@@ -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"
@@ -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
@@ -18,6 +18,9 @@ m365 setup [options]
18
18
 
19
19
  `--scripting`
20
20
  : Configure CLI for Microsoft 365 for use in scripts without prompting for additional information.
21
+
22
+ `--skipApp`
23
+ : Skip configuring an Entra app for use with CLI for Microsoft 365.
21
24
  ```
22
25
 
23
26
  <Global />
@@ -28,6 +31,10 @@ The `m365 setup` command is a wizard that helps you configure the CLI for Micros
28
31
 
29
32
  The command will ask you the following questions:
30
33
 
34
+ - _CLI for Microsoft 365 requires a Microsoft Entra app. Do you want to create a new app registration or use an existing one?_
35
+
36
+ You can choose between using an existing Entra app or creating a new one. If you choose to create a new app, the CLI will ask you to choose between a minimal and a full set of permissions. It then signs in as Azure CLI to your tenant, creates a new app registration, and stores its information in the CLI configuration.
37
+
31
38
  - _How do you plan to use the CLI?_
32
39
 
33
40
  You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors and show spinners. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
@@ -71,24 +78,30 @@ The `m365 setup` command uses the following presets:
71
78
 
72
79
  ## Examples
73
80
 
74
- Configure CLI for Microsoft based on your preferences interactively
81
+ Configure CLI for Microsoft 365 based on your preferences interactively
75
82
 
76
83
  ```sh
77
84
  m365 setup
78
85
  ```
79
86
 
80
- Configure CLI for Microsoft for interactive use without prompting for additional information
87
+ Configure CLI for Microsoft 365 for interactive use without prompting for additional information
81
88
 
82
89
  ```sh
83
90
  m365 setup --interactive
84
91
  ```
85
92
 
86
- Configure CLI for Microsoft for use in scripts without prompting for additional information
93
+ Configure CLI for Microsoft 365 for use in scripts without prompting for additional information
87
94
 
88
95
  ```sh
89
96
  m365 setup --scripting
90
97
  ```
91
98
 
99
+ Configure CLI for Microsoft 365 without setting up an Entra app
100
+
101
+ ```sh
102
+ m365 setup --skipApp
103
+ ```
104
+
92
105
  ## Response
93
106
 
94
107
  The command won't return a response on success.
@@ -14,25 +14,28 @@ m365 spfx project github workflow add [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-n, --name [name]`
17
- : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'.
17
+ : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'
18
18
 
19
19
  `-b, --branchName [branchName]`
20
- : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'.
20
+ : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'
21
21
 
22
22
  `-m, --manuallyTrigger`
23
- : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`.
23
+ : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`
24
24
 
25
25
  `-l, --loginMethod [loginMethod]`
26
- : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`.
26
+ : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`'
27
27
 
28
28
  `-s, --scope [scope]`
29
- : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`.
29
+ : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`
30
30
 
31
31
  `-u, --siteUrl [siteUrl]`
32
- : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`.
32
+ : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`
33
33
 
34
34
  `--skipFeatureDeployment`
35
- : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant.
35
+ : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant
36
+
37
+ `--overwrite`
38
+ : When specified the workflow will overwrite the existing .sppkg if it is already deployed in the app catalog.
36
39
  ```
37
40
 
38
41
  <Global />
@@ -56,8 +59,6 @@ For the `user` login method you will need to create the following secrets in Git
56
59
 
57
60
  This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
58
61
 
59
- The workflow will overwrite the existing .sppkg if it is already deployed in the app catalog. Overwriting your sppkg file on every deployment is required to make continuous delivery of the latest version of your app which is the aim of the continuous delivery pipeline.
60
-
61
62
  :::info
62
63
 
63
64
  Run this command in the SPFx solution folder.
@@ -66,7 +67,7 @@ Run this command in the SPFx solution folder.
66
67
 
67
68
  ## Examples
68
69
 
69
- Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main.
70
+ Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main
70
71
 
71
72
  ```sh
72
73
  m365 spfx project github workflow add
@@ -78,7 +79,7 @@ Adds a GitHub workflow for a SharePoint Framework project with `user` login meth
78
79
  m365 spfx project github workflow add --manuallyTrigger --loginMethod "user"
79
80
  ```
80
81
 
81
- Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog.
82
+ Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog
82
83
 
83
84
  ```sh
84
85
  m365 spfx project github workflow add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"
@@ -93,10 +93,7 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
93
93
  "Name": "{4a428b32-08cf-45c7-9986-17585af38806}",
94
94
  "RegistrationId": null,
95
95
  "RegistrationType": 0,
96
- "Rights": {
97
- "High": 0,
98
- "Low": 0
99
- },
96
+ "Rights": "{\"High\":\"0\",\"Low\":\"0\"}",
100
97
  "Scope": "Web",
101
98
  "ScriptBlock": null,
102
99
  "ScriptSrc": null,
@@ -123,6 +120,7 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
123
120
  Name : {4a428b32-08cf-45c7-9986-17585af38806}
124
121
  RegistrationId : null
125
122
  RegistrationType : 0
123
+ Rights : {"High":"0","Low":"0"}
126
124
  Scope : Web
127
125
  ScriptBlock : null
128
126
  ScriptSrc : null
@@ -136,8 +134,8 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
136
134
  <TabItem value="CSV">
137
135
 
138
136
  ```csv
139
- ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
140
- 9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}",,,,4a428b32-08cf-45c7-9986-17585af38806,,ClientSideExtension.ApplicationCustomizer,Some customizer,,0,Web,,,0,Some customizer,,16.0.1.0
137
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
138
+ 9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}",,,,,4a428b32-08cf-45c7-9986-17585af38806,,ClientSideExtension.ApplicationCustomizer,{4a428b32-08cf-45c7-9986-17585af38806},,0,"{""High"":""0"",""Low"":""0""}",Web,,,65536,HelloWorld,,1.0.1.0
141
139
  ```
142
140
 
143
141
  </TabItem>
@@ -159,6 +157,7 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
159
157
  Location | ClientSideExtension.ApplicationCustomizer
160
158
  Name | {4a428b32-08cf-45c7-9986-17585af38806}
161
159
  RegistrationType | 0
160
+ Rights | {"High":"0","Low":"0"}
162
161
  Scope | Web
163
162
  Sequence | 65536
164
163
  Title | HelloWorld
@@ -1,6 +1,4 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
- import Tabs from '@theme/Tabs';
3
- import TabItem from '@theme/TabItem';
4
2
 
5
3
  # spo file copy
6
4
 
@@ -33,14 +31,11 @@ m365 spo file copy [options]
33
31
  `--nameConflictBehavior [nameConflictBehavior]`
34
32
  : Behavior when a document with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`.
35
33
 
34
+ `--resetAuthorAndCreated`
35
+ : Use this option to clear the author and created date. When not specified, the values from the source file are used.
36
+
36
37
  `--bypassSharedLock`
37
38
  : This indicates whether a file with a share lock can still be copied. Use this option to copy a file that is locked.
38
-
39
- `--ignoreVersionHistory`
40
- : Only copy the most recent version of the file and ignore the version history.
41
-
42
- `--skipWait`
43
- : Don't wait for the copy operation to complete.
44
39
  ```
45
40
 
46
41
  <Global />
@@ -48,6 +43,7 @@ m365 spo file copy [options]
48
43
  ## Remarks
49
44
 
50
45
  When you specify a value for `nameConflictBehavior`, consider the following:
46
+
51
47
  - `fail` will throw an error when the destination file already exists.
52
48
  - `replace` will replace the destination file if it already exists.
53
49
  - `rename` will add a suffix (e.g. Document1.pdf) when the destination file already exists.
@@ -60,16 +56,16 @@ Copy a file by server-relative URL to a document library in another site collect
60
56
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
61
57
  ```
62
58
 
63
- Copy a file by site-relative URL to a document library in another site collection and ignore the file history.
59
+ Copy a file by site-relative URL to a document library in another site collection and clear the author and created date.
64
60
 
65
61
  ```sh
66
- m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --ignoreVersionHistory
62
+ m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --resetAuthorAndCreated
67
63
  ```
68
64
 
69
- Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file (without specifying the file extension).
65
+ Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file.
70
66
 
71
67
  ```sh
72
- m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report"
68
+ m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf"
73
69
  ```
74
70
 
75
71
  Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists.
@@ -80,111 +76,8 @@ m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourc
80
76
 
81
77
  ## Response
82
78
 
83
- ### Standard Response
84
-
85
- <Tabs>
86
- <TabItem value="JSON">
87
-
88
- ```json
89
- {
90
- "CheckInComment": "",
91
- "CheckOutType": 2,
92
- "ContentTag": "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",
93
- "CustomizedPageStatus": 0,
94
- "ETag": "\"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1\"",
95
- "Exists": true,
96
- "IrmEnabled": false,
97
- "Length": "5987",
98
- "Level": 1,
99
- "LinkingUri": null,
100
- "LinkingUrl": "",
101
- "MajorVersion": 1,
102
- "MinorVersion": 0,
103
- "Name": "Test1.docx",
104
- "ServerRelativeUrl": "/sites/project-x/documents/Test1.docx",
105
- "TimeCreated": "2022-10-30T10:16:18Z",
106
- "TimeLastModified": "2022-10-30T10:16:18Z",
107
- "Title": null,
108
- "UIVersion": 512,
109
- "UIVersionLabel": "1.0",
110
- "UniqueId": "b2307a39-e878-458b-bc90-03bc578531d6"
111
- }
112
- ```
113
-
114
- </TabItem>
115
- <TabItem value="Text">
116
-
117
- ```text
118
- CheckInComment :
119
- CheckOutType : 2
120
- ContentTag : {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
121
- CustomizedPageStatus: 0
122
- ETag : "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
123
- Exists : true
124
- IrmEnabled : false
125
- Length : 5987
126
- Level : 1
127
- LinkingUri : null
128
- LinkingUrl :
129
- MajorVersion : 1
130
- MinorVersion : 0
131
- Name : Test1.docx
132
- ServerRelativeUrl : /sites/project-x/documents/Test1.docx
133
- TimeCreated : 2022-10-30T10:16:18Z
134
- TimeLastModified : 2022-10-30T10:16:18Z
135
- Title : null
136
- UIVersion : 512
137
- UIVersionLabel : 1.0
138
- UniqueId : b2307a39-e878-458b-bc90-03bc578531d6
139
- ```
140
-
141
- </TabItem>
142
- <TabItem value="CSV">
143
-
144
- ```csv
145
- CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,IrmEnabled,Length,Level,LinkingUri,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId
146
- ,2,"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",0,"""{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1""",1,,5987,1,,,1,0,Test1.docx,/sites/project-x/documents/Test1.docx,2022-10-30T10:16:18Z,2022-10-30T10:16:18Z,,512,1.0,b2307a39-e878-458b-bc90-03bc578531d6
147
- ```
148
-
149
- </TabItem>
150
- <TabItem value="Markdown">
151
-
152
- ```md
153
- # spo file copy --webUrl "https://contoso.sharepoint.com/sites/IT" --sourceUrl "/Shared Documents/Document.docx" --targetUrl "/sites/project-x/Shared Documents"
154
-
155
- Date: 10/3/2023
156
-
157
- ## b2307a39-e878-458b-bc90-03bc578531d6
158
-
159
- Property | Value
160
- ---------|-------
161
- CheckInComment |
162
- CheckOutType | 2
163
- ContentTag | {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
164
- CustomizedPageStatus | 0
165
- ETag | "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
166
- Exists | true
167
- ExistsAllowThrowForPolicyFailures | true
168
- IrmEnabled | false
169
- Length | 5987
170
- Level | 1
171
- LinkingUri | https://contoso.sharepoint.com/sites/project-x/shared%20documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
172
- LinkingUrl | https://contoso.sharepoint.com/sites/project-x/shared documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
173
- MajorVersion | 1
174
- MinorVersion | 0
175
- Name | Document.docx
176
- ServerRelativeUrl | /sites/project-x/shared documents/Document.docx
177
- TimeCreated | 2023-05-23T09:51:34Z
178
- TimeLastModified | 2023-05-23T10:13:01Z
179
- Title |
180
- UIVersion | 1536
181
- UIVersionLabel | 1.0
182
- UniqueId | b2307a39-e878-458b-bc90-03bc578531d6
183
- ```
184
-
185
- </TabItem>
186
- </Tabs>
187
-
188
- ### `skipWait` response
189
-
190
79
  The command won't return a response on success.
80
+
81
+ ## More information
82
+
83
+ - Copy items from a SharePoint document library: [https://support.office.com/en-us/article/move-or-copy-items-from-a-sharepoint-document-library-00e2f483-4df3-46be-a861-1f5f0c1a87bc](https://support.office.com/en-us/article/move-or-copy-items-from-a-sharepoint-document-library-00e2f483-4df3-46be-a861-1f5f0c1a87bc)