@pnp/cli-microsoft365 6.5.0-beta.f8b8018 → 6.6.0-beta.2339ae2

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 (45) hide show
  1. package/.eslintrc.js +2 -0
  2. package/Dockerfile +1 -0
  3. package/dist/Command.js +17 -7
  4. package/dist/cli/Cli.js +15 -11
  5. package/dist/m365/cli/commands/config/config-set.js +1 -0
  6. package/dist/m365/commands/request.js +18 -1
  7. package/dist/m365/pa/commands/app/app-export.js +197 -0
  8. package/dist/m365/pa/commands.js +1 -0
  9. package/dist/m365/pp/commands/tenant/tenant-settings-set.js +261 -0
  10. package/dist/m365/pp/commands.js +2 -1
  11. package/dist/m365/purview/commands/threatassessment/threatassessment-get.js +79 -0
  12. package/dist/m365/purview/commands.js +2 -1
  13. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.17.0.js +23 -0
  14. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.17.1.js +23 -0
  15. package/dist/m365/spfx/commands/project/project-doctor.js +3 -1
  16. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.17.0-rc.1.js → upgrade-1.17.0.js} +26 -26
  17. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.1.js +55 -0
  18. package/dist/m365/spfx/commands/project/project-upgrade.js +14 -15
  19. package/dist/m365/spfx/commands/spfx-doctor.js +30 -0
  20. package/dist/m365/spo/commands/file/file-move.js +1 -1
  21. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +22 -1
  22. package/dist/m365/spo/commands/listitem/ListItemFieldValueResult.js +3 -0
  23. package/dist/m365/spo/commands/listitem/listitem-add.js +6 -5
  24. package/dist/m365/spo/commands/listitem/listitem-batch-add.js +18 -1
  25. package/dist/m365/spo/commands/listitem/listitem-get.js +21 -6
  26. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +35 -1
  27. package/dist/m365/spo/commands/listitem/listitem-set.js +5 -6
  28. package/dist/m365/spo/commands/web/web-set.js +33 -13
  29. package/dist/settingsNames.js +2 -1
  30. package/dist/utils/fsUtil.js +1 -1
  31. package/docs/docs/_clisettings.md +1 -0
  32. package/docs/docs/cmd/aad/o365group/o365group-add.md +3 -3
  33. package/docs/docs/cmd/pa/app/app-export.md +52 -0
  34. package/docs/docs/cmd/pp/tenant/tenant-settings-set.md +218 -0
  35. package/docs/docs/cmd/purview/threatassessment/threatassessment-get.md +191 -0
  36. package/docs/docs/cmd/request.md +10 -4
  37. package/docs/docs/cmd/spfx/project/project-upgrade.md +2 -2
  38. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +12 -1
  39. package/docs/docs/cmd/spo/listitem/listitem-add.md +12 -1
  40. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +12 -9
  41. package/docs/docs/cmd/spo/listitem/listitem-get.md +14 -5
  42. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +15 -2
  43. package/docs/docs/cmd/spo/listitem/listitem-set.md +12 -1
  44. package/npm-shrinkwrap.json +460 -273
  45. package/package.json +14 -12
@@ -0,0 +1,218 @@
1
+ # pp tenant settings set
2
+
3
+ Sets the global Power Platform configuration of the tenant
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp tenant settings set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--walkMeOptOut [walkMeOptOut]`
14
+ : Ability to opt out of guided experiences using WalkMe in Power Platform. Valid values: `true`, `false`.
15
+
16
+ `--disableNPSCommentsReachout [disableNPSCommentsReachout]`
17
+ : Ability to disable re-surveying users who left prior feedback via NPS prompts in Power Platform. Valid values: `true`, `false`.
18
+
19
+ `--disableNewsletterSendout [disableNewsletterSendout]`
20
+ : Ability to disable the newsletter sendout feature. Valid values: `true`, `false`.
21
+
22
+ `--disableEnvironmentCreationByNonAdminUsers [disableEnvironmentCreationByNonAdminUsers]`
23
+ : Restrict all environments to be created by Global Admins, Power Platform Admins, or Dynamics365 Service Admins. Valid values: `true`, `false`.
24
+
25
+ `--disablePortalsCreationByNonAdminUsers [disablePortalsCreationByNonAdminUsers]`
26
+ : Restrict all portals to be created by Global Admins, Power Platform Admins, or Dynamics365 Service Admins. Valid values: `true`, `false`.
27
+
28
+ `--disableSurveyFeedback [disableSurveyFeedback]`
29
+ : Ability to disable all NPS survey feedback prompts in Power Platform. Valid values: `true`, `false`.
30
+
31
+ `--disableTrialEnvironmentCreationByNonAdminUsers [disableTrialEnvironmentCreationByNonAdminUsers]`
32
+ : Restrict all trial environments to be created by Global Admins, Power Platform Admins, or Dynamics365 Service Admins. Valid values: `true`, `false`.
33
+
34
+ `--disableCapacityAllocationByEnvironmentAdmins [disableCapacityAllocationByEnvironmentAdmins]`
35
+ : Ability to disable capacity allocation by environment administrators. Valid values: `true`, `false`.
36
+
37
+ `--disableSupportTicketsVisibleByAllUsers [disableSupportTicketsVisibleByAllUsers]`
38
+ : Ability to disable support ticket creation by non-admin users in the tenant. Valid values: `true`, `false`.
39
+
40
+ `--disableDocsSearch [disableDocsSearch]`
41
+ : When this setting is true, users in the environment will see a message that Microsoft Learn and Documentation search categories have been turned off by the administrator in the search results page. Valid values: `true`, `false`.
42
+
43
+ `--disableCommunitySearch [disableCommunitySearch]`
44
+ : When this setting is true, users in the environment will see a message that Community and Blog search categories have been turned off by the administrator in the search results page. Valid values: `true`, `false`.
45
+
46
+ `--disableBingVideoSearch [disableBingVideoSearch]`
47
+ : When this setting is true, users in the environment will see a message that video search categories have been turned off by the administrator in the search results page. Valid values: `true`, `false`.
48
+
49
+ `--shareWithColleaguesUserLimit [shareWithColleaguesUserLimit]`
50
+ : Maximum value setting for the number of users in a security group used to share an app built using Power Apps on Microsoft Teams. Specify any number as a value.
51
+
52
+ `--disableShareWithEveryone [disableShareWithEveryone]`
53
+ : Ability to disable the Share With Everyone capability in all Power Apps. Valid values: `true`, `false`.
54
+
55
+ `--enableGuestsToMake [enableGuestsToMake]`
56
+ : Ability to allow guest users in your tenant to create Power Apps. Valid values: `true`, `false`.
57
+
58
+ `--disableMembersIndicator [disableMembersIndicator]`
59
+ : Ability to disable the display of a members indicator. Valid values: `true`, `false`.
60
+
61
+ `--disableMakerMatch [disableMakerMatch]`
62
+ : Ability to disable the Maker Match feature, which helps organizations find internal resources with the necessary skills to develop custom apps and solutions using Power Platform. Valid values: `true`, `false`.
63
+
64
+ `--disablePreferredDataLocationForTeamsEnvironment [disablePreferredDataLocationForTeamsEnvironment]`
65
+ : Ability to disable the selection of a preferred data location for Teams environment. Valid values: `true`, `false`.
66
+
67
+ `--disableAdminDigest [disableAdminDigest]`
68
+ : When true, the entire organization is unsubscribed from the weekly digest. Valid values: `true`, `false`.
69
+
70
+ `--disableDeveloperEnvironmentCreationByNonAdminUsers [disableDeveloperEnvironmentCreationByNonAdminUsers]`
71
+ : Restrict all developer environments to be created by Global Admins, Power Platform Admins, or Dynamics365 Service Admins. Valid values: `true`, `false`.
72
+
73
+ `--disableBillingPolicyCreationByNonAdminUsers [disableBillingPolicyCreationByNonAdminUsers]`
74
+ : Restrict billing policies to be created by Global Admins, Power Platform Admins, or Dynamics365 Service Admins. Valid values: `true`, `false`.
75
+
76
+ `--storageCapacityConsumptionWarningThreshold [storageCapacityConsumptionWarningThreshold]`
77
+ : Ability to set a threshold for storage capacity consumption warnings. Specify any number as a value.
78
+
79
+ `--disableChampionsInvitationReachout [disableChampionsInvitationReachout]`
80
+ : Ability to disable all invitations to become a Power Platform champion. Valid values: `true`, `false`.
81
+
82
+ `--disableSkillsMatchInvitationReachout [disableSkillsMatchInvitationReachout]`
83
+ : Ability to disable all skills match invitations to become part of the makers community. Valid values: `true`, `false`.
84
+
85
+ `--disableCopilot [disableCopilot]`
86
+ : Ability to turn off or disable the Copilot feature. Valid values: `true`, `false`.
87
+
88
+ `--enableOpenAiBotPublishing [enableOpenAiBotPublishing]`
89
+ : Ability to enable or disable the publishing of OpenAI bots within the organization's environment. Valid values: `true`, `false`.
90
+
91
+ `--enableModelDataSharing [enableModelDataSharing]`
92
+ : Ability to enable or disable the sharing of model data within the organization's environment. Valid values: `true`, `false`.
93
+
94
+ --8<-- "docs/cmd/_global.md"
95
+
96
+ ## Remarks
97
+
98
+ !!! attention
99
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
100
+
101
+ ## Examples
102
+
103
+ Disable environment creation for non-admin users
104
+
105
+ ```sh
106
+ m365 pp tenant settings set --disableEnvironmentCreationByNonAdminUsers true --disableTrialEnvironmentCreationByNonAdminUsers true --disableDeveloperEnvironmentCreationByNonAdminUsers true
107
+ ```
108
+
109
+ Enable Power App creation for guest users
110
+
111
+ ```sh
112
+ m365 pp tenant settings set --enableGuestsToMake true
113
+ ```
114
+
115
+ Disable guided experience, survey feedback and newsletter
116
+
117
+ ```sh
118
+ m365 pp tenant settings set --walkMeOptOut true --disableNewsletterSendout true --disableSurveyFeedback true
119
+ ```
120
+
121
+ ## Response
122
+
123
+ === "JSON"
124
+
125
+ ```json
126
+ {
127
+ "walkMeOptOut": false,
128
+ "disableNPSCommentsReachout": false,
129
+ "disableNewsletterSendout": false,
130
+ "disableEnvironmentCreationByNonAdminUsers": false,
131
+ "disablePortalsCreationByNonAdminUsers": false,
132
+ "disableSurveyFeedback": false,
133
+ "disableTrialEnvironmentCreationByNonAdminUsers": false,
134
+ "disableCapacityAllocationByEnvironmentAdmins": false,
135
+ "disableSupportTicketsVisibleByAllUsers": false,
136
+ "powerPlatform": {
137
+ "search": {
138
+ "disableDocsSearch": false,
139
+ "disableCommunitySearch": false,
140
+ "disableBingVideoSearch": false
141
+ },
142
+ "teamsIntegration": {
143
+ "shareWithColleaguesUserLimit": 10000
144
+ },
145
+ "powerApps": {
146
+ "disableShareWithEveryone": false,
147
+ "enableGuestsToMake": false,
148
+ "disableMembersIndicator": false,
149
+ "disableMakerMatch": false
150
+ },
151
+ "environments": {
152
+ "disablePreferredDataLocationForTeamsEnvironment": false
153
+ },
154
+ "governance": {
155
+ "disableAdminDigest": false,
156
+ "disableDeveloperEnvironmentCreationByNonAdminUsers": false
157
+ },
158
+ "licensing": {
159
+ "disableBillingPolicyCreationByNonAdminUsers": false,
160
+ "storageCapacityConsumptionWarningThreshold": 85
161
+ },
162
+ "powerPages": {},
163
+ "champions": {
164
+ "disableChampionsInvitationReachout": false,
165
+ "disableSkillsMatchInvitationReachout": false
166
+ },
167
+ "intelligence": {
168
+ "disableCopilot": false,
169
+ "enableOpenAiBotPublishing": false
170
+ },
171
+ "modelExperimentation": {
172
+ "enableModelDataSharing": false
173
+ }
174
+ }
175
+ }
176
+ ```
177
+
178
+ === "Text"
179
+
180
+ ```text
181
+ disableCapacityAllocationByEnvironmentAdmins : false
182
+ disableEnvironmentCreationByNonAdminUsers : false
183
+ disableNPSCommentsReachout : false
184
+ disableNewsletterSendout : false
185
+ disablePortalsCreationByNonAdminUsers : false
186
+ disableSupportTicketsVisibleByAllUsers : false
187
+ disableSurveyFeedback : false
188
+ disableTrialEnvironmentCreationByNonAdminUsers: false
189
+ powerPlatform : {"search":{"disableDocsSearch":false,"disableCommunitySearch":false,"disableBingVideoSearch":false},"teamsIntegration":{"shareWithColleaguesUserLimit":10000},"powerApps":{"disableShareWithEveryone":false,"enableGuestsToMake":false,"disableMembersIndicator":false,"disableMakerMatch":false},"environments":{"disablePreferredDataLocationForTeamsEnvironment":false},"governance":{"disableAdminDigest":false,"disableDeveloperEnvironmentCreationByNonAdminUsers":false},"licensing":{"disableBillingPolicyCreationByNonAdminUsers":false,"storageCapacityConsumptionWarningThreshold":85},"powerPages":{},"champions":{"disableChampionsInvitationReachout":false,"disableSkillsMatchInvitationReachout":false},"intelligence":{"disableCopilot":false,"enableOpenAiBotPublishing":false},"modelExperimentation":{"enableModelDataSharing":false}}
190
+ walkMeOptOut : false
191
+ ```
192
+
193
+ === "CSV"
194
+
195
+ ```csv
196
+ walkMeOptOut,disableNPSCommentsReachout,disableNewsletterSendout,disableEnvironmentCreationByNonAdminUsers,disablePortalsCreationByNonAdminUsers,disableSurveyFeedback,disableTrialEnvironmentCreationByNonAdminUsers,disableCapacityAllocationByEnvironmentAdmins,disableSupportTicketsVisibleByAllUsers
197
+ ,,,,,,,,
198
+ ```
199
+
200
+ === "Markdown"
201
+
202
+ ```md
203
+ # pp tenant settings set --disableEnvironmentCreationByNonAdminUsers false --disableTrialEnvironmentCreationByNonAdminUsers false --disableDeveloperEnvironmentCreationByNonAdminUsers false
204
+
205
+ Date: 14/3/2023
206
+
207
+ Property | Value
208
+ ---------|-------
209
+ walkMeOptOut | false
210
+ disableNPSCommentsReachout | false
211
+ disableNewsletterSendout | false
212
+ disableEnvironmentCreationByNonAdminUsers | false
213
+ disablePortalsCreationByNonAdminUsers | false
214
+ disableSurveyFeedback | false
215
+ disableTrialEnvironmentCreationByNonAdminUsers | false
216
+ disableCapacityAllocationByEnvironmentAdmins | false
217
+ disableSupportTicketsVisibleByAllUsers | false
218
+ ```
@@ -0,0 +1,191 @@
1
+ # purview threatassessment get
2
+
3
+ Get a threat assessment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview threatassessment get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the threat assessment
15
+
16
+ `--includeResults`
17
+ : Include the threat assessment results
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Get a threat assessment
24
+
25
+ ```sh
26
+ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e
27
+ ```
28
+
29
+ Get a threat assessment including results
30
+
31
+ ```sh
32
+ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --includeResults
33
+ ```
34
+
35
+ ## Response
36
+
37
+ ### Standard Response
38
+
39
+ === "JSON"
40
+
41
+ ```json
42
+ {
43
+ "id": "8aaba0ac-ec4d-4e62-5774-08db16c68731",
44
+ "createdDateTime": "2023-02-25T00:23:33.0550644Z",
45
+ "contentType": "mail",
46
+ "expectedAssessment": "block",
47
+ "category": "spam",
48
+ "status": "pending",
49
+ "requestSource": "administrator",
50
+ "recipientEmail": "john@contoso.com",
51
+ "destinationRoutingReason": "notJunk",
52
+ "messageUri": "https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALHNaMuAAA=",
53
+ "createdBy": {
54
+ "user": {
55
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
56
+ "displayName": "John Doe"
57
+ }
58
+ }
59
+ }
60
+ ```
61
+
62
+ === "Text"
63
+
64
+ ```text
65
+ category : spam
66
+ contentType : mail
67
+ createdBy : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
68
+ createdDateTime : 2023-02-25T00:23:33.0550644Z
69
+ destinationRoutingReason: notJunk
70
+ expectedAssessment : block
71
+ id : 8aaba0ac-ec4d-4e62-5774-08db16c68731
72
+ messageUri : https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALHNaMuAAA=
73
+ recipientEmail : john@contoso.com
74
+ requestSource : administrator
75
+ status : pending
76
+ ```
77
+
78
+ === "CSV"
79
+
80
+ ```csv
81
+ id,createdDateTime,contentType,expectedAssessment,category,status,requestSource,recipientEmail,destinationRoutingReason,messageUri,createdBy
82
+ 8aaba0ac-ec4d-4e62-5774-08db16c68731,2023-02-25T00:23:33.0550644Z,mail,block,spam,pending,administrator,john@contoso.com,notJunk,https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALHNaMuAAA=,"{""user"":{""id"":""fe36f75e-c103-410b-a18a-2bf6df06ac3a"",""displayName"":""John Doe""}}"
83
+ ```
84
+
85
+ === "Markdown"
86
+
87
+ ```md
88
+ # purview threatassessment get --id "8aaba0ac-ec4d-4e62-5774-08db16c68731"
89
+
90
+ Date: 25/02/2023
91
+
92
+ ## 8aaba0ac-ec4d-4e62-5774-08db16c68731
93
+
94
+ Property | Value
95
+ ---------|-------
96
+ id | 8aaba0ac-ec4d-4e62-5774-08db16c68731
97
+ createdDateTime | 2023-02-25T00:23:33.0550644Z
98
+ contentType | mail
99
+ expectedAssessment | block
100
+ category | spam
101
+ status | pending
102
+ requestSource | administrator
103
+ recipientEmail | john@contoso.com
104
+ destinationRoutingReason | notJunk
105
+ messageUri | https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E\_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E\_hLMK5kAALHNaMuAAA=
106
+ createdBy | {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
107
+ ```
108
+
109
+ ### `includeResults` response
110
+
111
+ When we make use of the option `includeResults` the response will differ.
112
+
113
+ === "JSON"
114
+
115
+ ```json
116
+ {
117
+ "id": "8aaba0ac-ec4d-4e62-5774-08db16c68731",
118
+ "createdDateTime": "2023-02-25T00:23:33.0550644Z",
119
+ "contentType": "mail",
120
+ "expectedAssessment": "block",
121
+ "category": "spam",
122
+ "status": "pending",
123
+ "requestSource": "administrator",
124
+ "recipientEmail": "john@contoso.com",
125
+ "destinationRoutingReason": "notJunk",
126
+ "messageUri": "https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALHNaMuAAA=",
127
+ "createdBy": {
128
+ "user": {
129
+ "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
130
+ "displayName": "John Doe"
131
+ }
132
+ },
133
+ "results": [
134
+ {
135
+ "id": "a5455871-18d1-44d8-0866-08db16c68b85",
136
+ "createdDateTime": "2023-02-25T00:23:40.28Z",
137
+ "resultType": "checkPolicy",
138
+ "message": "No policy was hit."
139
+ }
140
+ ]
141
+ }
142
+ ```
143
+
144
+ === "Text"
145
+
146
+ ```text
147
+ category : spam
148
+ contentType : mail
149
+ createdBy : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
150
+ createdDateTime : 2023-02-25T00:23:33.0550644Z
151
+ destinationRoutingReason: notJunk
152
+ expectedAssessment : block
153
+ id : 8aaba0ac-ec4d-4e62-5774-08db16c68731
154
+ messageUri : https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALHNaMuAAA=
155
+ recipientEmail : john@contoso.com
156
+ requestSource : administrator
157
+ results : [{"id":"a5455871-18d1-44d8-0866-08db16c68b85","createdDateTime":"2023-02-25T00:23:40.28Z","resultType":"checkPolicy","message":"No policy was hit."}]
158
+ status : pending
159
+ ```
160
+
161
+ === "CSV"
162
+
163
+ ```csv
164
+ id,createdDateTime,contentType,expectedAssessment,category,status,requestSource,recipientEmail,destinationRoutingReason,messageUri,createdBy,results
165
+ 8aaba0ac-ec4d-4e62-5774-08db16c68731,2023-02-25T00:23:33.0550644Z,mail,block,spam,pending,administrator,john@contoso.com,notJunk,https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALHNaMuAAA=,"{""user"":{""id"":""fe36f75e-c103-410b-a18a-2bf6df06ac3a"",""displayName"":""John Doe""}}","[{""id"":""a5455871-18d1-44d8-0866-08db16c68b85"",""createdDateTime"":""2023-02-25T00:23:40.28Z"",""resultType"":""checkPolicy"",""message"":""No policy was hit.""}]"
166
+ ```
167
+
168
+ === "Markdown"
169
+
170
+ ```md
171
+ # purview threatassessment get --id "8aaba0ac-ec4d-4e62-5774-08db16c68731" --includeResults "true"
172
+
173
+ Date: 25/02/2023
174
+
175
+ ## 8aaba0ac-ec4d-4e62-5774-08db16c68731
176
+
177
+ Property | Value
178
+ ---------|-------
179
+ id | 8aaba0ac-ec4d-4e62-5774-08db16c68731
180
+ createdDateTime | 2023-02-25T00:23:33.0550644Z
181
+ contentType | mail
182
+ expectedAssessment | block
183
+ category | spam
184
+ status | pending
185
+ requestSource | administrator
186
+ recipientEmail | john@contoso.com
187
+ destinationRoutingReason | notJunk
188
+ messageUri | https://graph.microsoft.com/v1.0/users/john@contoso.com/messages/AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E\_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E\_hLMK5kAALHNaMuAAA=
189
+ createdBy | {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
190
+ results | [{"id":"a5455871-18d1-44d8-0866-08db16c68b85","createdDateTime":"2023-02-25T00:23:40.28Z","resultType":"checkPolicy","message":"No policy was hit."}]
191
+ ```
@@ -40,6 +40,12 @@ If you specify the `resource` option, the CLI will try to retrieve a valid token
40
40
 
41
41
  Specify additional headers by typing them as options, for example: `--content-type "application/json"`, `--if-match "*"`, `--x-requestdigest "somedigest"`.
42
42
 
43
+ You can simplify the request by using tokens for the `url` option. Following tokens are available:
44
+
45
+ - `@graph` resolves to `https://graph.microsoft.com/v1.0`
46
+ - `@graphbeta` resolves to `https://graph.microsoft.com/beta`
47
+ - `@spo` resolves to the current SharePoint URL if available. You can set a SharePoint URL using the [spo set](./spo/spo-set.md) command.
48
+
43
49
  !!! important
44
50
  When building the request, depending on the shell you use, you might need to escape all `$` characters in the URL, request headers, and the body. If you don't do it, the shell will treat it as a variable and will remove the following word from the request, breaking the request.
45
51
 
@@ -63,16 +69,16 @@ Call the SharePoint API to retrieve a form digest.
63
69
  m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/contextinfo"
64
70
  ```
65
71
 
66
- Call the SharePoint API to update a site title.
72
+ Call the SharePoint API to update a site title using the @spo token.
67
73
 
68
74
  ```sh
69
- m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/web" --body '{ "Title": "New title" }' --content-type "application/json" --x-http-method "PATCH"
75
+ m365 request --method post --url "@spo/sites/project-x/_api/web" --body '{ "Title": "New title" }' --content-type "application/json" --x-http-method "PATCH"
70
76
  ```
71
77
 
72
- Call the Microsoft Graph to get a profile photo.
78
+ Call the Microsoft Graph to get a profile photo using the @graphbeta token.
73
79
 
74
80
  ```sh
75
- m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
81
+ m365 request --url '@graphbeta/me/photo/$value' --filePath ./profile-pic.jpg
76
82
  ```
77
83
 
78
84
  ## Response
@@ -29,13 +29,13 @@ m365 spfx project upgrade [options]
29
29
 
30
30
  ## Remarks
31
31
 
32
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.1).
32
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.17.1).
33
33
 
34
34
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
35
35
 
36
36
  !!! important
37
37
  Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
38
-
38
+
39
39
  ## Examples
40
40
 
41
41
  Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and save the findings in a Markdown file
@@ -22,12 +22,17 @@ m365 spo file retentionlabel ensure [options]
22
22
  `--name <name>`
23
23
  : Name of the retention label to apply to the file.
24
24
 
25
+ `-a, --assetId [assetId]`
26
+ : A Compliance Asset Id to set on the item when it's labeled. See below for more information.
27
+
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Remarks
28
31
 
29
32
  You can also use [spo listitem retentionlabel remove](./../../../cmd/spo//listitem/listitem-retentionlabel-remove.md) for removing the retentionlabel from a listitem.
30
33
 
34
+ The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
35
+
31
36
  ## Examples
32
37
 
33
38
  Applies a retention label to a file based on the label name and the fileUrl
@@ -39,7 +44,13 @@ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/site
39
44
  Applies a retention label to a file based on the label name and the fileId
40
45
 
41
46
  ```sh
42
- m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
47
+ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
48
+ ```
49
+
50
+ Applies a event-based retention label to a file and updates the Asset Id field
51
+
52
+ ```sh
53
+ m365 spo file retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --fileId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label' --assetId 'XYZ'
43
54
  ```
44
55
 
45
56
  ## Response
@@ -30,6 +30,11 @@ m365 spo listitem add [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
+ ## Remarks
34
+
35
+ !!! warning "When using DateTime fields"
36
+ When creating a list item with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.
37
+
33
38
  ## Examples
34
39
 
35
40
  Add an item with Title _Demo Item_ and content type name _Item_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -77,7 +82,13 @@ m365 spo listitem add --contentType Item --listUrl /sites/project-x/Documents --
77
82
  Add an item with a specific Title and multi-choice value
78
83
 
79
84
  ```sh
80
- m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --MultiChoiceField "Choice 1;#Choice 2;#Choice 3"
85
+ m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo multi-choice Field" --MultiChoiceField "Choice 1;#Choice 2;#Choice 3"
86
+ ```
87
+
88
+ Add an item with a specific Title and DateTime value
89
+
90
+ ```sh
91
+ m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo DateTime Field" --SomeDateTimeField "2023-01-16 15:30:00"
81
92
  ```
82
93
 
83
94
  ## Response
@@ -27,6 +27,18 @@ m365 spo listitem batch add [options]
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
30
+ ## Remarks
31
+
32
+ A sample CSV can be found below. The first line of the CSV-file should contain the internal column names that you wish to set.
33
+
34
+ ```csv
35
+ ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMetadataField,SinglePeopleField,MultiPeopleField,CustomHyperlink,NumberField,DateTimeField
36
+ Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|john.doe@contoso.com'}]","https://bing.com, URL",5,2023-01-01 10:00:00
37
+ ```
38
+
39
+ !!! warning "When using DateTime fields"
40
+ When creating list items with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.
41
+
30
42
  ## Examples
31
43
 
32
44
  Add a batch of items to a list retrieved by title in a specific site
@@ -47,15 +59,6 @@ Add a batch of items to a list defined by server-relative URL in a specific site
47
59
  m365 spo listitem batch add --filePath "C:\Path\To\Csv\CsvFile.csv" --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/lists/Demo List"
48
60
  ```
49
61
 
50
- ## Remarks
51
-
52
- A sample CSV can be found below. The first line of the CSV-file should contain the internal column names that you wish to set.
53
-
54
- ```csv
55
- ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMetadataField,SinglePeopleField,MultiPeopleField,CustomHyperlink,NumberField
56
- Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|john.doe@contoso.com'}]","https://bing.com, URL",5
57
- ```
58
-
59
62
  ## Response
60
63
 
61
64
  The command won't return a response on success.
@@ -13,17 +13,20 @@ m365 spo listitem get [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the item is located.
15
15
 
16
- `-i, --id <id>`
17
- : ID of the item to retrieve.
16
+ `-i, --id [id]`
17
+ : ID of the item to retrieve. Specify either `id` or `uniqueId` but not both.
18
+
19
+ `--uniqueId [uniqueId]`
20
+ : The Unique ID (GUID) of the item to retrieve. Specify either `id` or `uniqueId` but not both.
18
21
 
19
22
  `-l, --listId [listId]`
20
- : ID of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
23
+ : ID of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
21
24
 
22
25
  `-t, --listTitle [listTitle]`
23
- : Title of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
26
+ : Title of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
24
27
 
25
28
  `--listUrl [listUrl]`
26
- : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl` but not multiple.
29
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
27
30
 
28
31
  `-p, --properties [properties]`
29
32
  : Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested.
@@ -45,6 +48,12 @@ Get an item with the ID parameter from a given list in a given site.
45
48
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
46
49
  ```
47
50
 
51
+ Get an item with the Unique ID parameter from a given list in a given site.
52
+
53
+ ```sh
54
+ m365 spo listitem get --listTitle "Demo List" --uniqueId "64dc28c4-3c43-45f6-ba66-307d9eb7e6aa" --webUrl https://contoso.sharepoint.com/sites/project-x
55
+ ```
56
+
48
57
  Get an item columns with the ID parameter from a given list in a given site.
49
58
 
50
59
  ```sh
@@ -31,11 +31,18 @@ m365 spo listitem retentionlabel ensure [options]
31
31
  `-i, --id [id]`
32
32
  : The id of the retention label. Specify either `name` or `id`.
33
33
 
34
+ `-a, --assetId [assetId]`
35
+ : A Compliance Asset Id to set on the item when it's labeled. See below for more information.
36
+
34
37
  --8<-- "docs/cmd/_global.md"
35
38
 
39
+ ## Remarks
40
+
41
+ The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
42
+
36
43
  ## Examples
37
44
 
38
- Applies the retention label _Some label_ to a list item in a given site based on the list id and label name
45
+ Applies a retention label to a list item in a given site based on the list id and label name
39
46
 
40
47
  ```sh
41
48
  m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1 --name 'Some label'
@@ -47,12 +54,18 @@ Applies a retention label to a list item in a given site based on the list title
47
54
  m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1 --id '7a621a91-063b-461b-aff6-d713d5fb23eb'
48
55
  ```
49
56
 
50
- Applies the retention label _Some label_ to a list item in a given site based on the server relative list url
57
+ Applies a retention label to a list item in a given site based on the server relative list url
51
58
 
52
59
  ```sh
53
60
  m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label'
54
61
  ```
55
62
 
63
+ Applies a retention label to a list item in a given site based on the server relative list url and updates the Asset Id field
64
+
65
+ ```sh
66
+ m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label' --assetId 'XYZ'
67
+ ```
68
+
56
69
  ## Response
57
70
 
58
71
  The command won't return a response on success.
@@ -33,6 +33,11 @@ m365 spo listitem set [options]
33
33
 
34
34
  --8<-- "docs/cmd/_global.md"
35
35
 
36
+ ## Remarks
37
+
38
+ !!! warning "When using DateTime fields"
39
+ When updating a list item with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.
40
+
36
41
  ## Examples
37
42
 
38
43
  Update an item with id _147_ with title _Demo Item_ and content type name _Item_ in list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -74,7 +79,13 @@ m365 spo listitem set --listUrl '/sites/project-x/lists/Demo List' --id 147 --we
74
79
  Update an item with a specific Title and multi-choice value
75
80
 
76
81
  ```sh
77
- m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --MultiChoiceField "Choice 1;#Choice 2;#Choice 3"
82
+ m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo multi-choice Field" --MultiChoiceField "Choice 1;#Choice 2;#Choice 3"
83
+ ```
84
+
85
+ Update an item with a specific Title and DateTime value
86
+
87
+ ```sh
88
+ m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo DateTime Field" --SomeDateTimeField "2023-01-16 15:30:00"
78
89
  ```
79
90
 
80
91
  ## Response