@pnp/cli-microsoft365 7.5.0-beta.d4d820f → 7.6.0-beta.443bfd8

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 (191) hide show
  1. package/.devcontainer/Dockerfile +2 -2
  2. package/.eslintrc.cjs +9 -2
  3. package/.mocharc.json +3 -5
  4. package/Dockerfile +2 -5
  5. package/README.md +2 -2
  6. package/allCommands.json +1 -1
  7. package/allCommandsFull.json +1 -1
  8. package/dist/Auth.js +181 -77
  9. package/dist/AuthServer.js +3 -3
  10. package/dist/Command.js +8 -5
  11. package/dist/auth/FileTokenStorage.js +4 -1
  12. package/dist/cli/cli.js +1 -1
  13. package/dist/m365/base/AppCommand.js +2 -2
  14. package/dist/m365/base/PowerAppsCommand.js +2 -2
  15. package/dist/m365/base/PowerAutomateCommand.js +2 -2
  16. package/dist/m365/base/PowerPlatformCommand.js +2 -2
  17. package/dist/m365/base/SpoCommand.js +3 -3
  18. package/dist/m365/base/{YammerCommand.js → VivaEngageCommand.js} +2 -2
  19. package/dist/m365/cli/commands/cli-consent.js +5 -3
  20. package/dist/m365/cli/commands/cli-doctor.js +5 -5
  21. package/dist/m365/commands/ConnectionDetails.js +2 -0
  22. package/dist/m365/commands/login.js +26 -48
  23. package/dist/m365/commands/logout.js +2 -2
  24. package/dist/m365/commands/request.js +2 -2
  25. package/dist/m365/commands/status.js +15 -23
  26. package/dist/m365/connection/commands/connection-list.js +47 -0
  27. package/dist/m365/connection/commands/connection-remove.js +67 -0
  28. package/dist/m365/connection/commands/connection-set.js +56 -0
  29. package/dist/m365/connection/commands/connection-use.js +51 -0
  30. package/dist/m365/connection/commands.js +8 -0
  31. package/dist/m365/entra/aadCommands.js +3 -0
  32. package/dist/m365/entra/commands/administrativeunit/administrativeunit-member-remove.js +153 -0
  33. package/dist/m365/entra/commands/app/app-add.js +2 -2
  34. package/dist/m365/entra/commands/app/app-get.js +1 -1
  35. package/dist/m365/entra/commands/app/app-list.js +1 -1
  36. package/dist/m365/entra/commands/app/app-permission-add.js +1 -1
  37. package/dist/m365/entra/commands/app/app-permission-list.js +182 -0
  38. package/dist/m365/entra/commands/app/app-remove.js +1 -1
  39. package/dist/m365/entra/commands/app/app-role-add.js +1 -1
  40. package/dist/m365/entra/commands/app/app-role-list.js +1 -1
  41. package/dist/m365/entra/commands/app/app-role-remove.js +1 -1
  42. package/dist/m365/entra/commands/app/app-set.js +1 -1
  43. package/dist/m365/entra/commands/{sp/sp-add.js → enterpriseapp/enterpriseapp-add.js} +18 -18
  44. package/dist/m365/entra/commands/{sp/sp-get.js → enterpriseapp/enterpriseapp-get.js} +19 -19
  45. package/dist/m365/entra/commands/{sp/sp-list.js → enterpriseapp/enterpriseapp-list.js} +13 -13
  46. package/dist/m365/entra/commands/group/group-add.js +224 -0
  47. package/dist/m365/entra/commands/group/group-user-add.js +145 -0
  48. package/dist/m365/entra/commands/m365group/m365group-report-activitygroupcounts.js +1 -1
  49. package/dist/m365/entra/commands/user/user-get.js +38 -38
  50. package/dist/m365/entra/commands/user/user-license-list.js +1 -1
  51. package/dist/m365/entra/commands/user/user-registrationdetails-list.js +224 -0
  52. package/dist/m365/entra/commands/user/user-set.js +2 -2
  53. package/dist/m365/entra/commands.js +17 -0
  54. package/dist/m365/external/commands/connection/connection-doctor.js +2 -1
  55. package/dist/m365/file/commands/convert/convert-pdf.js +1 -1
  56. package/dist/m365/file/commands/file-copy.js +151 -0
  57. package/dist/m365/file/commands.js +1 -0
  58. package/dist/m365/outlook/commands/mail/mail-send.js +1 -1
  59. package/dist/m365/outlook/commands/message/message-get.js +1 -1
  60. package/dist/m365/pa/commands/app/app-permission-ensure.js +1 -1
  61. package/dist/m365/pa/commands/app/app-permission-remove.js +1 -1
  62. package/dist/m365/planner/commands/roster/roster-plan-list.js +1 -1
  63. package/dist/m365/purview/commands/auditlog/auditlog-list.js +1 -1
  64. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +1 -1
  65. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +1 -1
  66. package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +1 -1
  67. package/dist/m365/purview/commands/threatassessment/threatassessment-add.js +123 -0
  68. package/dist/m365/purview/commands/threatassessment/threatassessment-list.js +104 -0
  69. package/dist/m365/purview/commands.js +3 -1
  70. package/dist/m365/spfx/commands/project/DeployWorkflow.js +115 -3
  71. package/dist/m365/spfx/commands/project/project-azuredevops-pipeline-add.js +183 -0
  72. package/dist/m365/spfx/commands/project/project-azuredevops-pipeline-model.js +2 -0
  73. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +3 -4
  74. package/dist/m365/spfx/commands.js +1 -0
  75. package/dist/m365/spo/commands/spo-get.js +1 -1
  76. package/dist/m365/spo/commands/spo-search.js +52 -22
  77. package/dist/m365/spo/commands/spo-set.js +1 -1
  78. package/dist/m365/spo/commands/user/user-remove.js +93 -16
  79. package/dist/m365/teams/commands/chat/chat-get.js +1 -1
  80. package/dist/m365/teams/commands/chat/chat-list.js +1 -1
  81. package/dist/m365/teams/commands/chat/chat-message-send.js +1 -1
  82. package/dist/m365/teams/commands/meeting/meeting-add.js +1 -1
  83. package/dist/m365/teams/commands/meeting/meeting-attendancereport-list.js +1 -1
  84. package/dist/m365/teams/commands/meeting/meeting-get.js +1 -1
  85. package/dist/m365/teams/commands/meeting/meeting-list.js +2 -2
  86. package/dist/m365/teams/commands/meeting/meeting-transcript-list.js +1 -1
  87. package/dist/m365/tenant/commands/id/id-get.js +1 -1
  88. package/dist/m365/tenant/commands/info/info-get.js +1 -1
  89. package/dist/m365/util/commands/accesstoken/accesstoken-get.js +3 -3
  90. package/dist/m365/{yammer/commands/group/group-list.js → viva/commands/engage/engage-group-list.js} +19 -14
  91. package/dist/m365/{yammer/commands/group/group-user-add.js → viva/commands/engage/engage-group-user-add.js} +19 -14
  92. package/dist/m365/{yammer/commands/group/group-user-remove.js → viva/commands/engage/engage-group-user-remove.js} +19 -14
  93. package/dist/m365/{yammer/commands/message/message-add.js → viva/commands/engage/engage-message-add.js} +19 -14
  94. package/dist/m365/{yammer/commands/message/message-get.js → viva/commands/engage/engage-message-get.js} +17 -12
  95. package/dist/m365/{yammer/commands/message/message-like-set.js → viva/commands/engage/engage-message-like-set.js} +21 -16
  96. package/dist/m365/{yammer/commands/message/message-list.js → viva/commands/engage/engage-message-list.js} +21 -16
  97. package/dist/m365/{yammer/commands/message/message-remove.js → viva/commands/engage/engage-message-remove.js} +20 -15
  98. package/dist/m365/{yammer/commands/network/network-list.js → viva/commands/engage/engage-network-list.js} +16 -11
  99. package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +23 -0
  100. package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +23 -0
  101. package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +23 -0
  102. package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +23 -0
  103. package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +23 -0
  104. package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +23 -0
  105. package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +23 -0
  106. package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +23 -0
  107. package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +23 -0
  108. package/dist/m365/{yammer/commands/yammer-search.js → viva/commands/engage/engage-search.js} +23 -18
  109. package/dist/m365/{yammer/commands/user/user-get.js → viva/commands/engage/engage-user-get.js} +18 -13
  110. package/dist/m365/{yammer/commands/user/user-list.js → viva/commands/engage/engage-user-list.js} +18 -13
  111. package/dist/m365/{yammer/commands.js → viva/commands/engage/yammerCommands.js} +1 -1
  112. package/dist/m365/viva/commands.js +22 -1
  113. package/dist/request.js +1 -1
  114. package/dist/utils/entraUser.js +36 -0
  115. package/dist/utils/spo.js +36 -14
  116. package/dist/utils/urlUtil.js +31 -0
  117. package/dist/utils/validation.js +8 -0
  118. package/docs/docs/cmd/cli/cli-consent.mdx +9 -9
  119. package/docs/docs/cmd/connection/connection-list.mdx +100 -0
  120. package/docs/docs/cmd/connection/connection-remove.mdx +45 -0
  121. package/docs/docs/cmd/connection/connection-set.mdx +39 -0
  122. package/docs/docs/cmd/connection/connection-use.mdx +98 -0
  123. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-add.mdx +5 -3
  124. package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-remove.mdx +107 -0
  125. package/docs/docs/cmd/entra/app/app-add.mdx +2 -1
  126. package/docs/docs/cmd/entra/app/app-get.mdx +1 -0
  127. package/docs/docs/cmd/entra/app/app-list.mdx +1 -0
  128. package/docs/docs/cmd/entra/app/app-permission-add.mdx +1 -0
  129. package/docs/docs/cmd/entra/app/app-permission-list.mdx +105 -0
  130. package/docs/docs/cmd/entra/app/app-remove.mdx +1 -0
  131. package/docs/docs/cmd/entra/app/app-role-add.mdx +1 -0
  132. package/docs/docs/cmd/entra/app/app-role-list.mdx +1 -0
  133. package/docs/docs/cmd/entra/app/app-role-remove.mdx +1 -0
  134. package/docs/docs/cmd/entra/app/app-set.mdx +1 -0
  135. package/docs/docs/cmd/entra/{sp/sp-add.mdx → enterpriseapp/enterpriseapp-add.mdx} +16 -15
  136. package/docs/docs/cmd/entra/{sp/sp-get.mdx → enterpriseapp/enterpriseapp-get.mdx} +15 -14
  137. package/docs/docs/cmd/entra/{sp/sp-list.mdx → enterpriseapp/enterpriseapp-list.mdx} +22 -21
  138. package/docs/docs/cmd/entra/group/group-add.mdx +231 -0
  139. package/docs/docs/cmd/entra/group/group-user-add.mdx +62 -0
  140. package/docs/docs/cmd/entra/m365group/m365group-report-activitygroupcounts.mdx +1 -1
  141. package/docs/docs/cmd/entra/oauth2grant/oauth2grant-add.mdx +3 -3
  142. package/docs/docs/cmd/entra/oauth2grant/oauth2grant-list.mdx +1 -1
  143. package/docs/docs/cmd/entra/user/user-registrationdetails-list.mdx +246 -0
  144. package/docs/docs/cmd/external/item/item-add.mdx +1 -1
  145. package/docs/docs/cmd/file/convert/convert-pdf.mdx +4 -0
  146. package/docs/docs/cmd/file/file-add.mdx +4 -0
  147. package/docs/docs/cmd/file/file-copy.mdx +68 -0
  148. package/docs/docs/cmd/file/file-list.mdx +100 -0
  149. package/docs/docs/cmd/login.mdx +15 -0
  150. package/docs/docs/cmd/purview/threatassessment/threatassessment-add.mdx +131 -0
  151. package/docs/docs/cmd/purview/threatassessment/threatassessment-list.mdx +110 -0
  152. package/docs/docs/cmd/setup.mdx +4 -0
  153. package/docs/docs/cmd/spfx/project/project-azuredevops-pipeline-add.mdx +87 -0
  154. package/docs/docs/cmd/spo/list/list-webhook-set.mdx +1 -1
  155. package/docs/docs/cmd/spo/spo-search.mdx +6 -2
  156. package/docs/docs/cmd/spo/theme/theme-set.mdx +14 -2
  157. package/docs/docs/cmd/spo/user/user-remove.mdx +40 -9
  158. package/docs/docs/cmd/{yammer/group/group-list.mdx → viva/engage/engage-group-list.mdx} +13 -13
  159. package/docs/docs/cmd/{yammer/group/group-user-add.mdx → viva/engage/engage-group-user-add.mdx} +7 -7
  160. package/docs/docs/cmd/{yammer/group/group-user-remove.mdx → viva/engage/engage-group-user-remove.mdx} +10 -10
  161. package/docs/docs/cmd/{yammer/message/message-add.mdx → viva/engage/engage-message-add.mdx} +12 -13
  162. package/docs/docs/cmd/{yammer/message/message-get.mdx → viva/engage/engage-message-get.mdx} +10 -10
  163. package/docs/docs/cmd/{yammer/message/message-like-set.mdx → viva/engage/engage-message-like-set.mdx} +10 -10
  164. package/docs/docs/cmd/{yammer/message/message-list.mdx → viva/engage/engage-message-list.mdx} +21 -21
  165. package/docs/docs/cmd/{yammer/message/message-remove.mdx → viva/engage/engage-message-remove.mdx} +10 -10
  166. package/docs/docs/cmd/{yammer/network/network-list.mdx → viva/engage/engage-network-list.mdx} +6 -6
  167. package/docs/docs/cmd/{yammer/report/report-activitycounts.mdx → viva/engage/engage-report-activitycounts.mdx} +9 -9
  168. package/docs/docs/cmd/{yammer/report/report-activityusercounts.mdx → viva/engage/engage-report-activityusercounts.mdx} +9 -9
  169. package/docs/docs/cmd/{yammer/report/report-activityuserdetail.mdx → viva/engage/engage-report-activityuserdetail.mdx} +11 -12
  170. package/docs/docs/cmd/{yammer/report/report-deviceusagedistributionusercounts.mdx → viva/engage/engage-report-deviceusagedistributionusercounts.mdx} +5 -5
  171. package/docs/docs/cmd/{yammer/report/report-deviceusageusercounts.mdx → viva/engage/engage-report-deviceusageusercounts.mdx} +5 -5
  172. package/docs/docs/cmd/{yammer/report/report-deviceusageuserdetail.mdx → viva/engage/engage-report-deviceusageuserdetail.mdx} +11 -11
  173. package/docs/docs/cmd/{yammer/report/report-groupsactivitycounts.mdx → viva/engage/engage-report-groupsactivitycounts.mdx} +9 -9
  174. package/docs/docs/cmd/{yammer/report/report-groupsactivitydetail.mdx → viva/engage/engage-report-groupsactivitydetail.mdx} +11 -11
  175. package/docs/docs/cmd/{yammer/report/report-groupsactivitygroupcounts.mdx → viva/engage/engage-report-groupsactivitygroupcounts.mdx} +5 -5
  176. package/docs/docs/cmd/{yammer/yammer-search.mdx → viva/engage/engage-search.mdx} +10 -10
  177. package/docs/docs/cmd/{yammer/user/user-get.mdx → viva/engage/engage-user-get.mdx} +8 -8
  178. package/docs/docs/cmd/{yammer/user/user-list.mdx → viva/engage/engage-user-list.mdx} +11 -11
  179. package/npm-shrinkwrap.json +230 -168
  180. package/package.json +20 -19
  181. package/dist/m365/base/AzmgmtCommand.js +0 -18
  182. package/dist/m365/base/AzmgmtItemsListCommand.js +0 -41
  183. package/dist/m365/yammer/commands/report/report-activitycounts.js +0 -15
  184. package/dist/m365/yammer/commands/report/report-activityusercounts.js +0 -15
  185. package/dist/m365/yammer/commands/report/report-activityuserdetail.js +0 -15
  186. package/dist/m365/yammer/commands/report/report-deviceusagedistributionusercounts.js +0 -15
  187. package/dist/m365/yammer/commands/report/report-deviceusageusercounts.js +0 -15
  188. package/dist/m365/yammer/commands/report/report-deviceusageuserdetail.js +0 -15
  189. package/dist/m365/yammer/commands/report/report-groupsactivitycounts.js +0 -15
  190. package/dist/m365/yammer/commands/report/report-groupsactivitydetail.js +0 -15
  191. package/dist/m365/yammer/commands/report/report-groupsactivitygroupcounts.js +0 -15
@@ -0,0 +1,110 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # purview threatassessment list
6
+
7
+ Get a list of threat assessments
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 purview threatassessment list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-t, --type [type]`
19
+ : The type of threat assessment to retrieve. Allowed values are `mail`, `file`, `emailFile` and `url`.
20
+ ```
21
+
22
+ <Global />
23
+
24
+ ## Examples
25
+
26
+ Get a list of threat assessments
27
+
28
+ ```sh
29
+ m365 purview threatassessment list
30
+ ```
31
+
32
+ Get a list of threat assessments of type _mail_
33
+
34
+ ```sh
35
+ m365 purview threatassessment list --type mail
36
+ ```
37
+
38
+ ## Response
39
+
40
+ <Tabs>
41
+ <TabItem value="JSON">
42
+
43
+ ```json
44
+ [
45
+ {
46
+ "type": "mail",
47
+ "id": "49c5ef5b-1f65-444a-e6b9-08d772ea2059",
48
+ "createdDateTime": "2019-11-27T03:30:18.6890937Z",
49
+ "contentType": "mail",
50
+ "expectedAssessment": "block",
51
+ "category": "spam",
52
+ "status": "pending",
53
+ "requestSource": "administrator",
54
+ "recipientEmail": "john@contoso.onmicrosoft.com",
55
+ "destinationRoutingReason": "notJunk",
56
+ "messageUri": "https://graph.microsoft.com/v1.0/users/c52ce8db-3e4b-4181-93c4-7d6b6bffaf60/messages/AAMkADU3MWUxOTU0LWNlOTEt=",
57
+ "createdBy": {
58
+ "user": {
59
+ "id": "c52ce8db-3e4b-4181-93c4-7d6b6bffaf60",
60
+ "displayName": "John Doe"
61
+ }
62
+ }
63
+ }
64
+ ];
65
+ ```
66
+
67
+ </TabItem>
68
+ <TabItem value="Text">
69
+
70
+ ```text
71
+ id type category
72
+ ------------------------------------ ----------- --------
73
+ 49c5ef5b-1f65-444a-e6b9-08d772ea2059 mail spam
74
+ ```
75
+
76
+ </TabItem>
77
+ <TabItem value="CSV">
78
+
79
+ ```csv
80
+ id,type,category
81
+ 49c5ef5b-1f65-444a-e6b9-08d772ea2059,mail,spam
82
+ ```
83
+
84
+ </TabItem>
85
+ <TabItem value="Markdown">
86
+
87
+ ```md
88
+ # purview threatassessment list
89
+
90
+ Date: 16/2/2023
91
+
92
+ ## a47e428c-a7bd-4cf2-f061-08db0f58b736
93
+
94
+ Property | Value
95
+ ---------|-------
96
+ type | mail
97
+ id | 49c5ef5b-1f65-444a-e6b9-08d772ea2059
98
+ createdDateTime | 2019-11-27T03:30:18.6890937Z
99
+ contentType | mail
100
+ expectedAssessment | block
101
+ category | spam
102
+ status | pending
103
+ recipientEmail | john@contoso.onmicrosoft.com
104
+ destinationRoutingReason | notJunk
105
+ messageUri | https://graph.microsoft.com/v1.0/users/c52ce8db-3e4b-4181-93c4-7d6b6bffaf60/messages/AAMkADU3MWUxOTU0LWNlOTEt=
106
+ createdBy | {"user":{"id":"c52ce8db-3e4b-4181-93c4-7d6b6bffaf60","displayName":"John Doe"}}
107
+ ```
108
+
109
+ </TabItem>
110
+ </Tabs>
@@ -90,3 +90,7 @@ Configure CLI for Microsoft for use in scripts without prompting for additional
90
90
  ```sh
91
91
  m365 setup --scripting
92
92
  ```
93
+
94
+ ## Response
95
+
96
+ The command won't return a response on success.
@@ -0,0 +1,87 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # spfx project azuredevops pipeline add
4
+
5
+ Adds a Azure DevOps Pipeline for a SharePoint Framework project
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 spfx project azuredevops pipeline add [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-n, --name [name]`
17
+ : Name of the pipeline run that will be created. If none is specified a default name generated by Azure DevOps will be used
18
+
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'
21
+
22
+ `-l, --loginMethod [loginMethod]`
23
+ : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`
24
+
25
+ `-s, --scope [scope]`
26
+ : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`
27
+
28
+ `-u, --siteUrl [siteUrl]`
29
+ : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`
30
+
31
+ `--skipFeatureDeployment`
32
+ : When specified the app will be added to all sites. When deployed to the site app catalog it will be added to all sub-sites of that site.
33
+ ```
34
+
35
+ <Global />
36
+
37
+ ## Remarks
38
+
39
+ The `spfx project azuredevops pipeline add` will create a workflow .yml file in the `.azuredevops/pipelines` directory in your project. If such directory does not exist the command will automatically create it.
40
+
41
+ The command will not create the Azure DevOps pipeline. You will need to manually create it in Azure DevOps. The command will only create the workflow file which you can then push to your repo and create a new yaml pipline based on it.
42
+
43
+ For the `application` login method the command does not register an Entra application nor does it create the required certificate. In order to proceed, obtain (create) a self-signed certificate and register a new Entra application with certificate authentication. After that you will need to fill the following variables, or what is more preferable, create a dedicated variable group to store those properties:
44
+
45
+ - `CertificateBase64Encoded` - base 64 encoded certificate. Use either `CertificateBase64Encoded` or `CertificateSecureFileId` but not both
46
+ - `CertificateSecureFileId` - id of a certificate file in the secure files section of the DevOps library. `.pfx` file. Use either `CertificateBase64Encoded` or `CertificateSecureFileId` but not both
47
+ - `CertificatePassword` - certificate password. This applies only if the certificate is encoded which is the recommended approach
48
+ - `EntraAppId` - client id of the registered Entra application
49
+
50
+ This use case is perfect in a production context as it does not create any dependencies on an account
51
+
52
+ For the `user` login method you will need to fill the following variables, or what is more preferable, create a dedicated variable group to store those properties:
53
+
54
+ - `UserName` - user email
55
+ - `Password` - password
56
+
57
+ This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
58
+
59
+ :::info
60
+
61
+ Run this command in the SPFx solution folder.
62
+
63
+ :::
64
+
65
+ ## Examples
66
+
67
+ Adds an Azure DevOps Pipeline for a SharePoint Framework project triggered on push to main
68
+
69
+ ```sh
70
+ m365 spfx project azuredevops pipeline add
71
+ ```
72
+
73
+ Adds an Azure DevOps Pipeline for a SharePoint Framework project with `user` login method triggered on push to main
74
+
75
+ ```sh
76
+ m365 spfx project azuredevops pipeline add --loginMethod "user"
77
+ ```
78
+
79
+ Adds an Azure DevOps Pipeline for a SharePoint Framework project with deployment to a site collection app catalog
80
+
81
+ ```sh
82
+ m365 spfx project azuredevops pipeline add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"
83
+ ```
84
+
85
+ ## Response
86
+
87
+ The command won't return a response on success.
@@ -64,6 +64,6 @@ Update the notification url and clientState of a webhook with a specific ID atta
64
64
  m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02 --clientState 'My client state'
65
65
  ```
66
66
 
67
- ## Respone
67
+ ## Response
68
68
 
69
69
  The command won't return a response on success.
@@ -25,7 +25,7 @@ m365 spo search [options]
25
25
  : The web against which we want to execute the query. If the parameter is not defined, the query is executed against the web that's used when logging in to the SPO environment.
26
26
 
27
27
  `--allResults`
28
- : Set, to get all results of the search query, instead of the number specified by the `rowlimit` (default: 10)
28
+ : Set, to get all results of the search query in batches of 500.
29
29
 
30
30
  `--rowLimit [rowLimit]`
31
31
  : The number of rows to be returned. When the `allResults` option is used, the specified value will define the size of retrieved batches
@@ -55,7 +55,7 @@ m365 spo search [options]
55
55
  : The ID of the ranking model to use for the query.
56
56
 
57
57
  `--startRow [startRow]`
58
- : The first row that is included in the search results that are returned. You use this parameter when you want to implement paging for search results.
58
+ : The first row that is included in the search results that are returned. You use this parameter when you want to implement manual paging for search results.
59
59
 
60
60
  `--properties [properties]`
61
61
  : Additional properties for the query.
@@ -90,6 +90,10 @@ m365 spo search [options]
90
90
 
91
91
  <Global />
92
92
 
93
+ ## Remarks
94
+
95
+ When using the `--allResults` option, you cannot use the `--startRow` option. Only use `--startRow` for manual paging purposes.
96
+
93
97
  ## Examples
94
98
 
95
99
  Execute search query to retrieve all Document Sets (ContentTypeId = _0x0120D520_) for the English locale
@@ -76,13 +76,25 @@ To use this command you have to have permissions to access the tenant admin site
76
76
  Add or update a theme from a theme JSON file
77
77
 
78
78
  ```sh
79
- m365 spo theme set --name Contoso-Blue --theme @/Users/rjesh/themes/contoso-blue.json
79
+ m365 spo theme set --name Contoso-Blue --theme @/Users/user/themes/contoso-blue.json
80
80
  ```
81
81
 
82
82
  Add or update an inverted theme from a theme JSON file
83
83
 
84
84
  ```sh
85
- m365 spo theme set --name Contoso-Blue --theme @/Users/rjesh/themes/contoso-blue.json --isInverted
85
+ m365 spo theme set --name Contoso-Blue --theme @/Users/user/themes/contoso-blue.json --isInverted
86
+ ```
87
+
88
+ Add or update a theme from inline JSON
89
+
90
+ ```sh
91
+ m365 spo theme set --name Contoso-Red --theme '{"themePrimary":"#d81e05","themeLighterAlt":"#fdf5f4","themeLighter":"#f9d6d2","themeLight":"#f4b4ac","themeTertiary":"#e87060","themeSecondary":"#dd351e","themeDarkAlt":"#c31a04","themeDark":"#a51603","themeDarker":"#791002","neutralLighterAlt":"#eeeeee","neutralLighter":"#f5f5f5","neutralLight":"#e1e1e1","neutralQuaternaryAlt":"#d1d1d1","neutralQuaternary":"#c8c8c8","neutralTertiaryAlt":"#c0c0c0","neutralTertiary":"#c2c2c2","neutralSecondary":"#858585","neutralPrimaryAlt":"#4b4b4b","neutralPrimary":"#333333","neutralDark":"#272727","black":"#1d1d1d","white":"#f5f5f5"}'
92
+ ```
93
+
94
+ Add or update an inverted theme from inline JSON
95
+
96
+ ```sh
97
+ m365 spo theme set --name Contoso-Red --theme '{"themePrimary":"#d81e05","themeLighterAlt":"#fdf5f4","themeLighter":"#f9d6d2","themeLight":"#f4b4ac","themeTertiary":"#e87060","themeSecondary":"#dd351e","themeDarkAlt":"#c31a04","themeDark":"#a51603","themeDarker":"#791002","neutralLighterAlt":"#eeeeee","neutralLighter":"#f5f5f5","neutralLight":"#e1e1e1","neutralQuaternaryAlt":"#d1d1d1","neutralQuaternary":"#c8c8c8","neutralTertiaryAlt":"#c0c0c0","neutralTertiary":"#c2c2c2","neutralSecondary":"#858585","neutralPrimaryAlt":"#4b4b4b","neutralPrimary":"#333333","neutralDark":"#272727","black":"#1d1d1d","white":"#f5f5f5"}' --isInverted
86
98
  ```
87
99
 
88
100
  ## Response
@@ -14,13 +14,25 @@ m365 spo user remove [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the web to remove user
17
+ : URL of the web to remove user.
18
18
 
19
19
  `--id [id]`
20
- : ID of the user to remove from web
20
+ : ID of the user to remove from web. Use either `id` or `loginName` or `email`, `userName`, `entraGroupId`, or `entraGroupName`, but not all.
21
21
 
22
22
  `--loginName [loginName]`
23
- : Login name of the site user to remove
23
+ : Login name of the user to remove from web. Use either `id` or `loginName` or `email`, `userName`, `entraGroupId`, or `entraGroupName`, but not all.
24
+
25
+ `--userName [userName]`
26
+ : User name of the user to remove from web. Use either `id` or `loginName` or `email`, `userName`, `entraGroupId`, or `entraGroupName`, but not all.
27
+
28
+ `--email [email]`
29
+ : Email of the user to remove from web. Use either `id` or `loginName` or `email`, `userName`, `entraGroupId`, or `entraGroupName`, but not all.
30
+
31
+ `--entraGroupId [entraGroupId]`
32
+ : Object ID of the Entra group ID to remove. Use either `id` or `loginName` or `email`, `userName`, `entraGroupId`, or `entraGroupName`, but not all.
33
+
34
+ `--entraGroupName [entraGroupName]`
35
+ : Name of the Entra group to remove. Use either `id` or `loginName` or `email`, `userName`, `entraGroupId`, or `entraGroupName`, but not all.
24
36
 
25
37
  `-f, --force`
26
38
  : Do not prompt for confirmation before removing user from web
@@ -28,24 +40,43 @@ m365 spo user remove [options]
28
40
 
29
41
  <Global />
30
42
 
31
- ## Remarks
32
-
33
- Use either `id` or `loginName`, but not both
34
-
35
43
  ## Examples
36
44
 
37
- Removes user with id _10_ from a web without prompting for confirmation
45
+ Removes user by id from a web without prompting for confirmation
38
46
 
39
47
  ```sh
40
48
  m365 spo user remove --webUrl "https://contoso.sharepoint.com/sites/HR" --id 10 --force
41
49
  ```
42
50
 
43
- Removes user with login name _i:0#.f|membership|john.doe@mytenant.onmicrosoft.com_ from a web
51
+ Removes user by loginName from a web
44
52
 
45
53
  ```sh
46
54
  m365 spo user remove --webUrl "https://contoso.sharepoint.com/sites/HR" --loginName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
47
55
  ```
48
56
 
57
+ Removes user by userName from a web
58
+
59
+ ```sh
60
+ m365 spo user remove --webUrl "https://contoso.sharepoint.com/sites/HR" --userName "john.doe_hotmail.com#ext#@mytenant.onmicrosoft.com"
61
+ ```
62
+
63
+ Removes user by email from a web
64
+
65
+ ```sh
66
+ m365 spo user remove --webUrl "https://contoso.sharepoint.com/sites/HR" --email "john.doe@mytenant.onmicrosoft.com"
67
+ ```
68
+
69
+ Removes user by entraGroupId from a web
70
+
71
+ ```sh
72
+ m365 spo user remove --webUrl "https://contoso.sharepoint.com/sites/HR" --entraGroupId f832a493-de73-4fef-87ed-8c6fffd91be6
73
+ ```
74
+
75
+ Removes user by entraGroupName from a web
76
+
77
+ ```sh
78
+ m365 spo user remove --webUrl _https://contoso.sharepoint.com/sites/HR_ --entraGroupName "Test Members"
79
+ ```
49
80
  ## Response
50
81
 
51
82
  The command won't return a response on success.
@@ -2,14 +2,14 @@ import Global from '/docs/cmd/_global.mdx';
2
2
  import Tabs from '@theme/Tabs';
3
3
  import TabItem from '@theme/TabItem';
4
4
 
5
- # yammer group list
5
+ # viva engage group list
6
6
 
7
- Returns the list of groups in a Yammer network or the groups for a specific user
7
+ Returns the list of groups in a Viva Engage network or the groups for a specific user
8
8
 
9
9
  ## Usage
10
10
 
11
11
  ```sh
12
- m365 yammer group list [options]
12
+ m365 viva engage group list [options]
13
13
  ```
14
14
 
15
15
  ## Options
@@ -28,34 +28,34 @@ m365 yammer group list [options]
28
28
 
29
29
  :::warning
30
30
 
31
- In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
31
+ In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Viva Engage API. To do this, execute the `cli consent --service VivaEngage` command.
32
32
 
33
33
  :::
34
34
 
35
35
  ## Examples
36
36
 
37
- Returns all Yammer network groups
37
+ Returns all Viva Engage network groups
38
38
 
39
39
  ```sh
40
- m365 yammer group list
40
+ m365 viva engage group list
41
41
  ```
42
42
 
43
- Returns all Yammer network groups for the user with the ID `5611239081`
43
+ Returns all Viva Engage network groups for the user with the ID `5611239081`
44
44
 
45
45
  ```sh
46
- m365 yammer group list --userId 5611239081
46
+ m365 viva engage group list --userId 5611239081
47
47
  ```
48
48
 
49
- Returns the first 10 Yammer network groups
49
+ Returns the first 10 Viva Engage network groups
50
50
 
51
51
  ```sh
52
- m365 yammer group list --limit 10
52
+ m365 viva engage group list --limit 10
53
53
  ```
54
54
 
55
- Returns the first 10 Yammer network groups for the user with the ID `5611239081`
55
+ Returns the first 10 Viva Engage network groups for the user with the ID `5611239081`
56
56
 
57
57
  ```sh
58
- m365 yammer group list --userId 5611239081 --limit 10
58
+ m365 viva engage group list --userId 5611239081 --limit 10
59
59
  ```
60
60
 
61
61
  ## Response
@@ -130,7 +130,7 @@ m365 yammer group list --userId 5611239081 --limit 10
130
130
  <TabItem value="Markdown">
131
131
 
132
132
  ```md
133
- # yammer group list --limit "1"
133
+ # viva engage group list --limit "1"
134
134
 
135
135
  Date: 2023-05-16
136
136
 
@@ -1,13 +1,13 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
2
 
3
- # yammer group user add
3
+ # viva engage group user add
4
4
 
5
- Adds a user to a Yammer Group
5
+ Adds a user to a Viva Engage Group
6
6
 
7
7
  ## Usage
8
8
 
9
9
  ```sh
10
- m365 yammer group user add [options]
10
+ m365 viva engage group user add [options]
11
11
  ```
12
12
 
13
13
  ## Options
@@ -29,7 +29,7 @@ m365 yammer group user add [options]
29
29
 
30
30
  :::warning
31
31
 
32
- In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
32
+ In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Viva Engage API. To do this, execute the `cli consent --service VivaEngage` command.
33
33
 
34
34
  :::
35
35
 
@@ -40,19 +40,19 @@ If the specified user is not a member of the network, the command will return an
40
40
  Adds the current user to the group with the ID `5611239081`
41
41
 
42
42
  ```sh
43
- m365 yammer group user add --groupId 5611239081
43
+ m365 viva engage group user add --groupId 5611239081
44
44
  ```
45
45
 
46
46
  Adds the user with ID `66622349` to the group with the ID `5611239081`
47
47
 
48
48
  ```sh
49
- m365 yammer group user add --groupId 5611239081 --id 66622349
49
+ m365 viva engage group user add --groupId 5611239081 --id 66622349
50
50
  ```
51
51
 
52
52
  Adds the user with e-mail to the group with ID `5611239081`
53
53
 
54
54
  ```sh
55
- m365 yammer group user add --groupId 5611239081 --email suzy@contoso.com
55
+ m365 viva engage group user add --groupId 5611239081 --email suzy@contoso.com
56
56
  ```
57
57
 
58
58
  ## Response
@@ -1,26 +1,26 @@
1
1
  import Global from '/docs/cmd/_global.mdx';
2
2
 
3
- # yammer group user remove
3
+ # viva engage group user remove
4
4
 
5
- Removes a user from a Yammer group
5
+ Removes a user from a Viva Engage group
6
6
 
7
7
  ## Usage
8
8
 
9
9
  ```sh
10
- m365 yammer group user remove [options]
10
+ m365 viva engage group user remove [options]
11
11
  ```
12
12
 
13
13
  ## Options
14
14
 
15
15
  ```md definition-list
16
16
  `--groupId <groupId>`
17
- : The ID of the Yammer group
17
+ : The ID of the Viva Engage group.
18
18
 
19
19
  `--id [id]`
20
- : ID of the user to remove from the group. If not specified, removes the current user
20
+ : ID of the user to remove from the group. If not specified, removes the current user.
21
21
 
22
22
  `-f, --force`
23
- : Don't prompt for confirmation before removing the user from the group
23
+ : Don't prompt for confirmation.
24
24
  ```
25
25
 
26
26
  <Global />
@@ -29,7 +29,7 @@ m365 yammer group user remove [options]
29
29
 
30
30
  :::warning
31
31
 
32
- In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
32
+ In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Viva Engage API. To do this, execute the `cli consent --service VivaEngage` command.
33
33
 
34
34
  :::
35
35
 
@@ -38,19 +38,19 @@ In order to use this command, you need to grant the Azure AD application used by
38
38
  Remove the current user from the group with the ID `5611239081`
39
39
 
40
40
  ```sh
41
- m365 yammer group user remove --groupId 5611239081
41
+ m365 viva engage group user remove --groupId 5611239081
42
42
  ```
43
43
 
44
44
  Remove the user with the ID `66622349` from the group with the ID `5611239081`
45
45
 
46
46
  ```sh
47
- m365 yammer group user remove --groupId 5611239081 --id 66622349
47
+ m365 viva engage group user remove --groupId 5611239081 --id 66622349
48
48
  ```
49
49
 
50
50
  Remove the user with the ID `66622349` from the group with the ID `5611239081` without asking for confirmation
51
51
 
52
52
  ```sh
53
- m365 yammer group user remove --groupId 5611239081 --id 66622349 --force
53
+ m365 viva engage group user remove --groupId 5611239081 --id 66622349 --force
54
54
  ```
55
55
 
56
56
  ## Response
@@ -2,14 +2,14 @@ import Global from '/docs/cmd/_global.mdx';
2
2
  import Tabs from '@theme/Tabs';
3
3
  import TabItem from '@theme/TabItem';
4
4
 
5
- # yammer message add
5
+ # viva engage message add
6
6
 
7
- Posts a Yammer network message on behalf of the current user
7
+ Posts a Viva Engage network message on behalf of the current user
8
8
 
9
9
  ## Usage
10
10
 
11
11
  ```sh
12
- m365 yammer message add [options]
12
+ m365 viva engage message add [options]
13
13
  ```
14
14
 
15
15
  ## Options
@@ -25,7 +25,7 @@ m365 yammer message add [options]
25
25
  : The message ID this message is in reply to. If this is set then groupId and networkId are inferred from it. You must either specify `groupId`, `repliedToId`, or `directToUserIds` to send the message
26
26
 
27
27
  `-d, --directToUserIds [directToUserIds]`
28
- : Send a private message to one or more users, specified by ID. Alternatively, you can use the Yammer network e-mail addresses instead of the IDs. You must either specify `groupId`, `repliedToId`, or `directToUserIds` to send the message
28
+ : Send a private message to one or more users, specified by ID. Alternatively, you can use the Viva Engage network e-mail addresses instead of the IDs. You must either specify `groupId`, `repliedToId`, or `directToUserIds` to send the message
29
29
 
30
30
  `--networkId [networkId]`
31
31
  : Specify the network to post a message
@@ -37,7 +37,7 @@ m365 yammer message add [options]
37
37
 
38
38
  :::warning
39
39
 
40
- In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
40
+ In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Viva Engage API. To do this, execute the `cli consent --service VivaEngage` command.
41
41
 
42
42
  :::
43
43
 
@@ -46,37 +46,37 @@ In order to use this command, you need to grant the Azure AD application used by
46
46
  Replies to a message with the ID 1231231231
47
47
 
48
48
  ```sh
49
- m365 yammer message add --body "Hello everyone!" --repliedToId 1231231231
49
+ m365 viva engage message add --body "Hello everyone!" --repliedToId 1231231231
50
50
  ```
51
51
 
52
52
  Sends a private conversation to the user with the ID 1231231231
53
53
 
54
54
  ```sh
55
- m365 yammer message add --body "Hello everyone!" --directToUserIds 1231231231
55
+ m365 viva engage message add --body "Hello everyone!" --directToUserIds 1231231231
56
56
  ```
57
57
 
58
58
  Sends a private conversation to multiple users by ID
59
59
 
60
60
  ```sh
61
- m365 yammer message add --body "Hello everyone!" --directToUserIds "1231231231,1121312"
61
+ m365 viva engage message add --body "Hello everyone!" --directToUserIds "1231231231,1121312"
62
62
  ```
63
63
 
64
64
  Sends a private conversation to the user with several e-mail addresses
65
65
 
66
66
  ```sh
67
- m365 yammer message add --body "Hello everyone!" --directToUserIds "pl@nubo.eu,sc@nubo.eu"
67
+ m365 viva engage message add --body "Hello everyone!" --directToUserIds "pl@nubo.eu,sc@nubo.eu"
68
68
  ```
69
69
 
70
70
  Posts a message to the group with the ID 12312312312
71
71
 
72
72
  ```sh
73
- m365 yammer message add --body "Hello everyone!" --groupId 12312312312
73
+ m365 viva engage message add --body "Hello everyone!" --groupId 12312312312
74
74
  ```
75
75
 
76
76
  Posts a message to the group with the ID 12312312312 in the network 11112312
77
77
 
78
78
  ```sh
79
- m365 yammer message add --body "Hello everyone!" --groupId 12312312312 --networkId 11112312
79
+ m365 viva engage message add --body "Hello everyone!" --groupId 12312312312 --networkId 11112312
80
80
  ```
81
81
 
82
82
  ## Response
@@ -141,7 +141,7 @@ m365 yammer message add --body "Hello everyone!" --groupId 12312312312 --network
141
141
  <TabItem value="Markdown">
142
142
 
143
143
  ```md
144
- # yammer message add --body "Hello everyone!" --groupId "123412865024"
144
+ # viva engage message add --body "Hello everyone!" --groupId "123412865024"
145
145
 
146
146
  Date: 2023-05-16
147
147
 
@@ -172,4 +172,3 @@ m365 yammer message add --body "Hello everyone!" --groupId 12312312312 --network
172
172
 
173
173
  </TabItem>
174
174
  </Tabs>
175
-