@pnp/cli-microsoft365 6.3.0-beta.3f7129c → 6.3.0-beta.4c3b2c9

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 (97) hide show
  1. package/.eslintrc.js +6 -0
  2. package/dist/Command.js +12 -1
  3. package/dist/cli/Cli.js +4 -1
  4. package/dist/m365/aad/commands/group/group-list.js +2 -1
  5. package/dist/m365/base/O365MgmtCommand.js +10 -0
  6. package/dist/m365/graph/commands/changelog/changelog-list.js +3 -2
  7. package/dist/m365/onenote/commands/notebook/notebook-list.js +51 -40
  8. package/dist/m365/planner/commands/plan/plan-add.js +20 -6
  9. package/dist/m365/planner/commands/plan/plan-get.js +34 -27
  10. package/dist/m365/planner/commands/plan/plan-list.js +24 -14
  11. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  12. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  13. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  14. package/dist/m365/planner/commands/task/task-add.js +3 -0
  15. package/dist/m365/planner/commands/task/task-checklistitem-add.js +2 -1
  16. package/dist/m365/planner/commands/task/task-checklistitem-list.js +2 -1
  17. package/dist/m365/planner/commands.js +2 -0
  18. package/dist/m365/pp/commands/solution/solution-get.js +2 -1
  19. package/dist/m365/pp/commands/solution/solution-list.js +2 -1
  20. package/dist/m365/purview/commands/auditlog/auditlog-list.js +205 -0
  21. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +70 -0
  22. package/dist/m365/purview/commands.js +2 -0
  23. package/dist/m365/spfx/commands/project/WebApiPermissionRequests.js +3 -0
  24. package/dist/m365/spfx/commands/project/project-permissions-grant.js +81 -0
  25. package/dist/m365/spfx/commands.js +3 -2
  26. package/dist/m365/spo/commands/app/app-add.js +2 -1
  27. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  28. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  29. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +2 -1
  30. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  31. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  32. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  33. package/dist/m365/spo/commands/file/file-sharinglink-list.js +9 -29
  34. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  35. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  36. package/dist/m365/spo/commands/group/group-list.js +2 -1
  37. package/dist/m365/spo/commands/hubsite/hubsite-get.js +1 -1
  38. package/dist/m365/spo/commands/listitem/listitem-list.js +2 -1
  39. package/dist/m365/spo/commands/page/page-column-get.js +2 -1
  40. package/dist/m365/spo/commands/page/page-column-list.js +2 -1
  41. package/dist/m365/spo/commands/page/page-section-get.js +2 -1
  42. package/dist/m365/spo/commands/page/page-section-list.js +2 -1
  43. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  44. package/dist/m365/spo/commands/spo-search.js +2 -1
  45. package/dist/m365/spo/commands/term/term-list.js +2 -1
  46. package/dist/m365/spo/commands/userprofile/userprofile-get.js +2 -2
  47. package/dist/m365/spo/commands.js +3 -0
  48. package/dist/m365/teams/commands/meeting/meeting-list.js +1 -1
  49. package/dist/m365/teams/commands/team/team-app-list.js +1 -1
  50. package/dist/m365/teams/commands/user/user-app-list.js +2 -1
  51. package/dist/m365/todo/commands/task/task-get.js +2 -1
  52. package/dist/m365/todo/commands/task/task-list.js +2 -1
  53. package/dist/m365/yammer/commands/yammer-search.js +2 -1
  54. package/dist/utils/planner.js +19 -5
  55. package/dist/utils/spo.js +28 -0
  56. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  57. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  58. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  59. package/docs/docs/cmd/pa/environment/environment-get.md +18 -0
  60. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  61. package/docs/docs/cmd/planner/plan/plan-add.md +17 -6
  62. package/docs/docs/cmd/planner/plan/plan-get.md +16 -2
  63. package/docs/docs/cmd/planner/plan/plan-list.md +16 -2
  64. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  65. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  66. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  67. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  68. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  69. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  70. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  71. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  72. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  73. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  74. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  75. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  76. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  77. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  78. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  79. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  80. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  81. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  82. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  83. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  84. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  85. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  86. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  87. package/docs/docs/cmd/purview/auditlog/auditlog-list.md +123 -0
  88. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +100 -0
  89. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +65 -0
  90. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  91. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  92. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  93. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  94. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +1 -1
  95. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +1 -1
  96. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  97. package/package.json +1 -1
@@ -54,3 +54,22 @@ m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
54
54
  id,name
55
55
  22660b34-31b3-4744-a99c-5e154458a784,Contoso Gateway
56
56
  ```
57
+
58
+ === "Markdown"
59
+
60
+ ```md
61
+ # pp gateway get --id 22660b34-31b3-4744-a99c-5e154458a784
62
+
63
+ Date: 9/1/2023
64
+
65
+ ## Contoso Gateway (22660b34-31b3-4744-a99c-5e154458a784)
66
+
67
+ Property | Value
68
+ ---------|-------
69
+ id | 22660b34-31b3-4744-a99c-5e154458a784
70
+ gatewayId | 0
71
+ name | Contoso Gateway
72
+ type | Resource
73
+ publicKey | {"exponent":"AQAB","modulus":"okJBN8MJyaVkjfkN75B6OgP7RYiC3KFMFaky9KqqudqiTOcZPRXlsG+emrbnnBpFzw7ywe4gWtUGnPCqy01RKeDZrFA3QfkVPJpH28OWfrmgkMQNsI4Op2uxwEyjnJAyfYxIsHlpevOZoDKpWJgV+sH6MRf/+LK4hN3vNJuWKKpf90rNwjipnYMumHyKVkd4Vssc9Ftsu4Samu0/TkXzUkyje5DxMF2ZK1Nt2TgItBcpKi4wLCP4bPDYYaa9vfOmBlji7U+gwuE5bjnmjazFljQ5sOP0VdA0fRoId3+nI7n1rSgRq265jNHX84HZbm2D/Pk8C0dElTmYEswGPDWEJQ=="}
74
+ gatewayAnnotation | {\"gatewayContactInformation\":[\"admin@contoso.onmicrosoft.com\"],\"gatewayVersion\":\"3000.122.8\",\"gatewayWitnessString\":\"{\\\"EncryptedResult\\\":\\\"UyfEqNSy0e9S4D0m9oacPyYhgiXLWusCiKepoLudnTEe68iw9qEaV6qNqTbSKlVUwUkD9KjbnbV0O3vU97Q/KTJXpw9/1SiyhpO+JN1rcaL51mPjyQo0WwMHMo2PU3rdEyxsLjkJxJZHTh4+XGB/lQ==\\\",\\\"IV\\\":\\\"QxCYjHEl8Ab9i78ZBYpnDw==\\\",\\\"Signature\\\":\\\"upVXK3DvWdj5scw8iUDDilzQz1ovuNgeuXRpmf0N828=\\\"}\",\"gatewayMachine\":\"SPFxDevelop\",\"gatewaySalt\":\"rA1M34AdgdCbOYQMvo/izA==\",\"gatewayWitnessStringLegacy\":null,\"gatewaySaltLegacy\":null,\"gatewayDepartment\":null,\"gatewayVirtualNetworkSubnetId\":null}
75
+ ```
@@ -54,3 +54,22 @@ m365 pp gateway list
54
54
  id,name
55
55
  22660b34-31b3-4744-a99c-5e154458a784,Contoso Gateway
56
56
  ```
57
+
58
+ === "Markdown"
59
+
60
+ ```md
61
+ # pp gateway list
62
+
63
+ Date: 9/1/2023
64
+
65
+ ## Contoso Gateway (22660b34-31b3-4744-a99c-5e154458a784)
66
+
67
+ Property | Value
68
+ ---------|-------
69
+ id | 22660b34-31b3-4744-a99c-5e154458a784
70
+ gatewayId | 0
71
+ name | Contoso Gateway
72
+ type | Resource
73
+ publicKey | {"exponent":"AQAB","modulus":"okJBN8MJyaVkjfkN75B6OgP7RYiC3KFMFaky9KqqudqiTOcZPRXlsG+emrbnnBpFzw7ywe4gWtUGnPCqy01RKeDZrFA3QfkVPJpH28OWfrmgkMQNsI4Op2uxwEyjnJAyfYxIsHlpevOZoDKpWJgV+sH6MRf/+LK4hN3vNJuWKKpf90rNwjipnYMumHyKVkd4Vssc9Ftsu4Samu0/TkXzUkyje5DxMF2ZK1Nt2TgItBcpKi4wLCP4bPDYYaa9vfOmBlji7U+gwuE5bjnmjazFljQ5sOP0VdA0fRoId3+nI7n1rSgRq265jNHX84HZbm2D/Pk8C0dElTmYEswGPDWEJQ=="}
74
+ gatewayAnnotation | {\"gatewayContactInformation\":[\"admin@contoso.onmicrosoft.com\"],\"gatewayVersion\":\"3000.122.8\",\"gatewayWitnessString\":\"{\\\"EncryptedResult\\\":\\\"UyfEqNSy0e9S4D0m9oacPyYhgiXLWusCiKepoLudnTEe68iw9qEaV6qNqTbSKlVUwUkD9KjbnbV0O3vU97Q/KTJXpw9/1SiyhpO+JN1rcaL51mPjyQo0WwMHMo2PU3rdEyxsLjkJxJZHTh4+XGB/lQ==\\\",\\\"IV\\\":\\\"QxCYjHEl8Ab9i78ZBYpnDw==\\\",\\\"Signature\\\":\\\"upVXK3DvWdj5scw8iUDDilzQz1ovuNgeuXRpmf0N828=\\\"}\",\"gatewayMachine\":\"SPFxDevelop\",\"gatewaySalt\":\"rA1M34AdgdCbOYQMvo/izA==\",\"gatewayWitnessStringLegacy\":null,\"gatewaySaltLegacy\":null,\"gatewayDepartment\":null,\"gatewayVirtualNetworkSubnetId\":null}
75
+ ```
@@ -71,3 +71,15 @@ m365 pp managementapp add --name "My app"
71
71
  applicationId
72
72
  31359c7f-bd7e-475c-86db-fdb8c937548e
73
73
  ```
74
+
75
+ === "Markdown"
76
+
77
+ ```md
78
+ # pp managementapp add --appId "31359c7f-bd7e-475c-86db-fdb8c937548e"
79
+
80
+ Date: 9/1/2023
81
+
82
+ Property | Value
83
+ ---------|-------
84
+ applicationId | 31359c7f-bd7e-475c-86db-fdb8c937548e
85
+ ```
@@ -46,3 +46,15 @@ m365 pp managementapp list
46
46
  applicationId
47
47
  31359c7f-bd7e-475c-86db-fdb8c937548e
48
48
  ```
49
+
50
+ === "Markdown"
51
+
52
+ ```md
53
+ # pp managementapp list
54
+
55
+ Date: 9/1/2023
56
+
57
+ Property | Value
58
+ ---------|-------
59
+ applicationId | 31359c7f-bd7e-475c-86db-fdb8c937548e
60
+ ```
@@ -84,3 +84,17 @@ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339
84
84
  uniquename,version,publisher
85
85
  Default,1.0,Default Publisher for org6633049a
86
86
  ```
87
+
88
+ === "Markdown"
89
+
90
+ ```md
91
+ # pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
92
+
93
+ Date: 9/1/2023
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ uniquename | Crc00f1
98
+ version | 1.0.0.0
99
+ publisher | CDS Default Publisher
100
+ ```
@@ -68,3 +68,17 @@ m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f33
68
68
  uniquename,version,publisher
69
69
  Crc00f1,1.0.0.0,CDS Default Publisher
70
70
  ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ # pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
76
+
77
+ Date: 9/1/2023
78
+
79
+ Property | Value
80
+ ---------|-------
81
+ uniquename | Crc00f1
82
+ version | 1.0.0.0
83
+ publisher | CDS Default Publisher
84
+ ```
@@ -61,7 +61,7 @@ m365 pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-32
61
61
  "friendlyname": "MicrosoftCorporation",
62
62
  "versionnumber": 1226559,
63
63
  "isreadonly": false,
64
- "description": "Uitgever van Microsoft-oplossingen",
64
+ "description": "Publisher of Microsoft solutions",
65
65
  "customizationprefix": "",
66
66
  "customizationoptionvalueprefix": 0
67
67
  }
@@ -81,3 +81,22 @@ m365 pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-32
81
81
  publisherid,uniquename,friendlyname
82
82
  d21aab70-79e7-11dd-8874-00188b01e34f,MicrosoftCorporation,MicrosoftCorporation
83
83
  ```
84
+
85
+ === "Markdown"
86
+
87
+ ```md
88
+ # pp solution publisher get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "d21aab70-79e7-11dd-8874-00188b01e34f"
89
+
90
+ Date: 9/1/2023
91
+
92
+ Property | Value
93
+ ---------|-------
94
+ publisherid | d21aab70-79e7-11dd-8874-00188b01e34f
95
+ uniquename | MicrosoftCorporation
96
+ friendlyname | MicrosoftCorporation
97
+ versionnumber | 1226559
98
+ isreadonly | false
99
+ description | Publisher of Microsoft solutions
100
+ customizationprefix |
101
+ customizationoptionvalueprefix | 0
102
+ ```
@@ -69,3 +69,21 @@ m365 pp solution publisher list --environment "Default-2ca3eaa5-140f-4175-8261-3
69
69
  00000001-0000-0000-0000-00000000005a,Cree38e,CDS Default Publisher
70
70
  ```
71
71
 
72
+ === "Markdown"
73
+
74
+ ```md
75
+ # pp solution publisher list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
76
+
77
+ Date: 9/1/2023
78
+
79
+ Property | Value
80
+ ---------|-------
81
+ publisherid | 00000001-0000-0000-0000-00000000005a
82
+ uniquename | Cree38e
83
+ friendlyname | CDS Default Publisher
84
+ versionnumber | 1074060
85
+ isreadonly | false
86
+ description | null
87
+ customizationprefix | cr6c3
88
+ customizationoptionvalueprefix | 43186
89
+ ```
@@ -86,3 +86,24 @@ m365 pp tenant settings list
86
86
  disableCapacityAllocationByEnvironmentAdmins,disableEnvironmentCreationByNonAdminUsers,disableNPSCommentsReachout,disablePortalsCreationByNonAdminUsers,disableSupportTicketsVisibleByAllUsers,disableSurveyFeedback,disableTrialEnvironmentCreationByNonAdminUsers,walkMeOptOut
87
87
  false,false,false,false,false,false,false,false
88
88
  ```
89
+
90
+ === "Markdown"
91
+
92
+ ```md
93
+ # pp tenant settings list
94
+
95
+ Date: 6/2/2023
96
+
97
+ Property | Value
98
+ ---------|-------
99
+ walkMeOptOut | false
100
+ disableNPSCommentsReachout | false
101
+ disableNewsletterSendout | false
102
+ disableEnvironmentCreationByNonAdminUsers | false
103
+ disablePortalsCreationByNonAdminUsers | false
104
+ disableSurveyFeedback | false
105
+ disableTrialEnvironmentCreationByNonAdminUsers | false
106
+ disableCapacityAllocationByEnvironmentAdmins | false
107
+ disableSupportTicketsVisibleByAllUsers | false
108
+ powerPlatform | {"search":{"disableDocsSearch":false,"disableCommunitySearch":false,"disableBingVideoSearch":false},"teamsIntegration":{"shareWithColleaguesUserLimit":10000},"powerApps":{"disableShareWithEveryone":false,"enableGuestsToMake":false,"disableMembersIndicator":false},"environments":{},"governance":{"disableAdminDigest":false,"disableDeveloperEnvironmentCreationByNonAdminUsers":false},"licensing":{"disableBillingPolicyCreationByNonAdminUsers":false},"powerPages":{}}
109
+ ```
@@ -0,0 +1,123 @@
1
+ # purview auditlog list
2
+
3
+ List audit logs within your tenant
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview auditlog list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--contentType <contentType>`
14
+ : Content type of logs to retrieve. Possible values: `AzureActiveDirectory`, `Exchange`, `SharePoint`, `General`, `DLP`.
15
+
16
+ `--startTime [startTime]`
17
+ : Time indicating the **inclusive** start of a time range of content to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z). Start time cannot be more than 7 days in the past. Default value is 24h ago.
18
+
19
+ `--endTime [endTime]`
20
+ : Time indicating the **exclusive** end of a time range of content to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z). Default value is now.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! important
27
+ Before you can access audit log data, you must enable unified audit logging for your Microsoft 365 tenant. For instructions, check out the page [Turn auditing on or off](https://learn.microsoft.com/en-us/microsoft-365/compliance/audit-log-enable-disable).
28
+
29
+ !!! important
30
+ When running this command for the first time for a certain content type, a subscription for this content type is created. It can take up to 12 hours for the first content blobs to become available for that subscription.
31
+
32
+ !!! tip
33
+ Retrieving audit logs is an intensive process, especially for large or active tenants. In this case it may take some time to retrieve all audit logs. It can be useful to add the `--verbose` option to your command to view the command progress.
34
+
35
+ When you specify a value for `contentType`, consider the following:
36
+
37
+ - `AzureActiveDirectory` includes all Azure AD audit logs.
38
+ - `Exchange` includes all Exchange audit logs.
39
+ - `SharePoint` includes all SharePoint audit logs.
40
+ - `General` includes all other workloads not included in the previous content types.
41
+ - `DLP` DLP events only for all workloads.
42
+
43
+ ## Examples
44
+
45
+ List all SharePoint audit logs for the past 24 hours
46
+
47
+ ```sh
48
+ m365 purview auditlog list --contentType SharePoint
49
+ ```
50
+
51
+ List all SharePoint audit logs within a specific time frame
52
+
53
+ ```sh
54
+ m365 purview auditlog list --contentType SharePoint --startTime "2023-01-01T00:00:00Z" --endTime "2023-01-03T09:00:00Z"
55
+ ```
56
+
57
+ Get all SharePoint audit logs within a specific time frame and save the logs to a file
58
+
59
+ ```sh
60
+ m365 purview auditlog list --contentType SharePoint --startTime "2023-01-01T00:00:00Z" --endTime "2023-01-01T12:00:00Z" > auditLogs.json
61
+ ```
62
+
63
+ ## Response
64
+
65
+ === "JSON"
66
+
67
+ ```json
68
+ [
69
+ {
70
+ "AppAccessContext": {
71
+ "ClientAppId": "94bfad6e-a0b3-4eb9-8e2b-83eeb335de28",
72
+ "CorrelationId": "040d86a0-f096-5000-d4b4-baac627b75f3",
73
+ "UniqueTokenId": "5CVDGmrynkGYBkY-MPynAA"
74
+ },
75
+ "CreationTime": "2023-01-10T00:00:00",
76
+ "Id": "4d671836-c772-4169-55f9-08dae745c839",
77
+ "Operation": "ListItemViewed",
78
+ "OrganizationId": "6e40c2aa-0565-4013-b38c-d5e6f0c42993",
79
+ "RecordType": 36,
80
+ "UserKey": "i:0i.t|00000003-0000-0ff1-ce00-000000000000|app@sharepoint",
81
+ "UserType": 0,
82
+ "Version": 1,
83
+ "Workload": "SharePoint",
84
+ "ClientIP": "168.63.104.32",
85
+ "ObjectId": "https://contoso.sharepoint.com/sites/Project-x/Lists/cae414a1-ac65-4a90-844e-651d7a1e463d/305_.000",
86
+ "UserId": "john.doe@contoso.com",
87
+ "ApplicationId": "94bfad6e-a0b3-4eb9-8e2b-83eeb335de28",
88
+ "CorrelationId": "040d86a0-f096-5000-d4b4-baac627b75f3",
89
+ "EventSource": "SharePoint",
90
+ "ItemType": "ListItem",
91
+ "ListId": "cae414a1-ac65-4a90-844e-651d7a1e463d",
92
+ "ListItemUniqueId": "2d364471-4d27-4186-b139-072c8225ee4a",
93
+ "Site": "51f5a236-b2e5-4a6d-a81d-13d188610155",
94
+ "UserAgent": "NONISV|Contoso|ContosoApp/1.0",
95
+ "WebId": "38ab94aa-a904-4c2b-8467-4be0e457f97b",
96
+ "CustomizedDoclib": false,
97
+ "FromApp": false,
98
+ "ItemCount": 192,
99
+ "ListBaseTemplateType": "100",
100
+ "ListBaseType": "GenericList",
101
+ "ListColor": "",
102
+ "ListIcon": "",
103
+ "Source": "Unknown",
104
+ "TemplateTypeId": "",
105
+ "ListTitle": "cae414a1-ac65-4a90-844e-651d7a1e463d"
106
+ }
107
+ ]
108
+ ```
109
+
110
+ === "Text"
111
+
112
+ ```txt
113
+ CreationTime UserId Operation ObjectId
114
+ ------------------- -------------------- -------------- --------------------------------------------------------------------------------------------------
115
+ 2023-01-10T00:00:00 john.doe@contoso.com ListItemViewed https://contoso.sharepoint.com/sites/Project-x/Lists/cae414a1-ac65-4a90-844e-651d7a1e463d/305_.000
116
+ ```
117
+
118
+ === "CSV"
119
+
120
+ ```csv
121
+ CreationTime,UserId,Operation,ObjectId
122
+ 2023-01-10T00:00:00,john.doe@contoso.com,ListItemViewed,https://contoso.sharepoint.com/sites/Project-x/Lists/cae414a1-ac65-4a90-844e-651d7a1e463d/305_.000
123
+ ```
@@ -0,0 +1,100 @@
1
+ # purview retentioneventtype get
2
+
3
+ Get a retention event type
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentioneventtype get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the retention event type.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get a retention event type by id
21
+
22
+ ```sh
23
+ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
24
+ ```
25
+
26
+ ## Remarks
27
+
28
+ !!! attention
29
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
30
+
31
+ ## More information
32
+
33
+ This command is part of a series of commands that have 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.
34
+
35
+ [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
36
+
37
+ ## Response
38
+
39
+ === "JSON"
40
+
41
+ ```json
42
+ {
43
+ "displayName": "Test retention event type",
44
+ "description": "Description for the retention event type",
45
+ "createdDateTime": "2023-01-29T09:30:42Z",
46
+ "lastModifiedDateTime": "2023-01-29T09:30:42Z",
47
+ "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
48
+ "createdBy": {
49
+ "user": {
50
+ "id": null,
51
+ "displayName": "John Doe"
52
+ }
53
+ },
54
+ "lastModifiedBy": {
55
+ "user": {
56
+ "id": null,
57
+ "displayName": "John Doe"
58
+ }
59
+ }
60
+ }
61
+ ```
62
+
63
+ === "Text"
64
+
65
+ ```text
66
+ createdBy : {"user":{"id":null,"displayName":"John Doe"}}
67
+ createdDateTime : 2023-01-29T09:30:42Z
68
+ description : Description for the retention event type
69
+ displayName : Test retention event type
70
+ id : c37d695e-d581-4ae9-82a0-9364eba4291e
71
+ lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
72
+ lastModifiedDateTime: 2023-01-29T09:30:42Z
73
+ ```
74
+
75
+ === "CSV"
76
+
77
+ ```csv
78
+ displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
79
+ Test retention event type,Description for the retention event type,2023-01-29T09:30:42Z,2023-01-29T09:30:42Z,c37d695e-d581-4ae9-82a0-9364eba4291e,"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
80
+ ```
81
+
82
+ === "Markdown"
83
+
84
+ ```md
85
+ # purview retentioneventtype get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
86
+
87
+ Date: 1/29/2023
88
+
89
+ ## Test retention event type (c37d695e-d581-4ae9-82a0-9364eba4291e)
90
+
91
+ Property | Value
92
+ ---------|-------
93
+ displayName | Test retention event type
94
+ description | Description for the retention event type
95
+ createdDateTime | 2023-01-29T09:30:42Z
96
+ lastModifiedDateTime | 2023-01-29T09:30:42Z
97
+ id | c37d695e-d581-4ae9-82a0-9364eba4291e
98
+ createdBy | {"user":{"id":null,"displayName":"John Doe"}}
99
+ lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
100
+ ```
@@ -0,0 +1,65 @@
1
+ # spfx project permissions grant
2
+
3
+ Grant API permissions defined in the current SPFx project
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spfx project permissions grant [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Remarks
16
+
17
+ !!! important
18
+ Run this command in the folder where the project is located from where you want to grant the permissions.
19
+
20
+ This command grant the permissions defined in: _package-solution.json_.
21
+
22
+ ## Examples
23
+
24
+ Grant API permissions requested in the current SPFx project
25
+
26
+ ```sh
27
+ m365 spfx project permissions grant
28
+ ```
29
+
30
+ ## Response
31
+
32
+ === "JSON"
33
+
34
+ ```json
35
+ {
36
+ "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
37
+ "ConsentType": "AllPrincipals",
38
+ "IsDomainIsolated": false,
39
+ "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
40
+ "PackageName": null,
41
+ "Resource": "Microsoft Graph",
42
+ "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
43
+ "Scope": "Mail.Read"
44
+ }
45
+ ```
46
+
47
+ === "Text"
48
+
49
+ ```text
50
+ ClientId : 6004a642-185c-479a-992a-15d1c23e2229
51
+ ConsentType : AllPrincipals
52
+ IsDomainIsolated: false
53
+ ObjectId : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
54
+ PackageName : null
55
+ Resource : Microsoft Graph
56
+ ResourceId : a46b0017-21e2-4db1-bc69-ca63576a38d6
57
+ Scope : Mail.Read
58
+ ```
59
+
60
+ === "CSV"
61
+
62
+ ```csv
63
+ ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
64
+ 6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
65
+ ```
@@ -0,0 +1,56 @@
1
+ # spo applicationcustomizer add
2
+
3
+ Add an application customizer to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo applicationcustomizer add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : The title of the application customizer.
15
+
16
+ `-u, --webUrl <webUrl>`
17
+ : URL of the site.
18
+
19
+ `-i, --clientSideComponentId <clientSideComponentId>`
20
+ : Client-side component ID of the application customizer (GUID).
21
+
22
+ `--clientSideComponentProperties [clientSideComponentProperties]`
23
+ : JSON string with application customizer properties
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
30
+
31
+ ```sh
32
+ m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
33
+ ```
34
+
35
+ Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
36
+
37
+ !!! warning "Escaping JSON in PowerShell"
38
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
39
+
40
+ ## Examples
41
+
42
+ Adds an application customizer to the sales site.
43
+
44
+ ```sh
45
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
46
+ ```
47
+
48
+ Adds an application customizer to the sales site with some properties.
49
+
50
+ ```sh
51
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales
52
+ ```
53
+
54
+ ## Response
55
+
56
+ The command won't return a response on success.
@@ -0,0 +1,46 @@
1
+ # spo file sharinglink clear
2
+
3
+ Removes sharing links of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink clear [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `-s, --scope [scope]`
23
+ : Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes all sharing links from a file specified by id without prompting for confirmation
33
+
34
+ ```sh
35
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --confirm
36
+ ```
37
+
38
+ Removes sharing links of type anonymous from a file specified by url with prompting for confirmation
39
+
40
+ ```sh
41
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --scope anonymous
42
+ ```
43
+
44
+ ## Response
45
+
46
+ The command won't return a response on success.
@@ -19,7 +19,7 @@ m365 spo file sharinglink list [options]
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `--scope [scope]`
22
+ `-s, --scope [scope]`
23
23
  : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"