@pnp/cli-microsoft365 6.3.0-beta.64eb7da → 6.3.0-beta.80fcd21

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 (192) hide show
  1. package/.eslintrc.js +4 -0
  2. package/dist/Command.js +4 -4
  3. package/dist/appInsights.js +2 -1
  4. package/dist/cli/Cli.js +58 -1
  5. package/dist/m365/aad/commands/license/license-list.js +41 -0
  6. package/dist/m365/aad/commands/user/user-add.js +223 -0
  7. package/dist/m365/aad/commands/user/user-license-add.js +88 -0
  8. package/dist/m365/aad/commands/user/user-license-list.js +99 -0
  9. package/dist/m365/aad/commands/user/user-license-remove.js +114 -0
  10. package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
  11. package/dist/m365/aad/commands/user/user-recyclebinitem-list.js +41 -0
  12. package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
  13. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +77 -0
  14. package/dist/m365/aad/commands/user/user-remove.js +107 -0
  15. package/dist/m365/aad/commands.js +10 -0
  16. package/dist/m365/context/commands/option/option-list.js +54 -0
  17. package/dist/m365/context/commands.js +1 -0
  18. package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
  19. package/dist/m365/flow/commands/environment/environment-get.js +26 -11
  20. package/dist/m365/pa/commands/environment/environment-get.js +13 -5
  21. package/dist/m365/planner/commands/plan/plan-get.js +17 -10
  22. package/dist/m365/planner/commands/plan/plan-set.js +21 -10
  23. package/dist/m365/planner/commands/roster/roster-get.js +61 -0
  24. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  25. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  26. package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
  27. package/dist/m365/planner/commands/task/task-add.js +3 -0
  28. package/dist/m365/planner/commands.js +4 -0
  29. package/dist/m365/pp/commands/environment/environment-get.js +18 -9
  30. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +75 -0
  31. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +46 -0
  32. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
  33. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
  34. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +13 -8
  35. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +43 -0
  36. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
  37. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
  38. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
  39. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
  40. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  41. package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
  42. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
  43. package/dist/m365/purview/commands.js +8 -1
  44. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  45. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  46. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  47. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  48. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  49. package/dist/m365/spo/commands/file/file-move.js +0 -2
  50. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  51. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  52. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  53. package/dist/m365/spo/commands/file/file-sharinglink-list.js +7 -28
  54. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  55. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  56. package/dist/m365/spo/commands/folder/folder-copy.js +0 -2
  57. package/dist/m365/spo/commands/folder/folder-move.js +0 -2
  58. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
  59. package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
  60. package/dist/m365/spo/commands/site/site-add.js +0 -3
  61. package/dist/m365/spo/commands/site/site-remove.js +0 -3
  62. package/dist/m365/spo/commands/site/site-set.js +0 -2
  63. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  64. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
  65. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js +0 -1
  66. package/dist/m365/spo/commands.js +5 -0
  67. package/dist/m365/teams/commands/team/team-add.js +3 -8
  68. package/dist/utils/aadUser.js +38 -0
  69. package/dist/utils/planner.js +1 -4
  70. package/dist/utils/session.js +18 -0
  71. package/dist/utils/spo.js +92 -12
  72. package/docs/docs/cmd/aad/license/license-list.md +87 -0
  73. package/docs/docs/cmd/aad/user/user-add.md +168 -0
  74. package/docs/docs/cmd/aad/user/user-license-add.md +108 -0
  75. package/docs/docs/cmd/aad/user/user-license-list.md +98 -0
  76. package/docs/docs/cmd/aad/user/user-license-remove.md +43 -0
  77. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
  78. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md +82 -0
  79. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
  80. package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.md +99 -0
  81. package/docs/docs/cmd/aad/user/user-remove.md +51 -0
  82. package/docs/docs/cmd/aad/user/user-set.md +1 -1
  83. package/docs/docs/cmd/context/option/option-list.md +63 -0
  84. package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
  85. package/docs/docs/cmd/login.md +26 -0
  86. package/docs/docs/cmd/logout.md +4 -0
  87. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  88. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  89. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  90. package/docs/docs/cmd/pa/environment/environment-get.md +26 -2
  91. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  92. package/docs/docs/cmd/planner/plan/plan-get.md +12 -12
  93. package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
  94. package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
  95. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  96. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  97. package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
  98. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  99. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  100. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  101. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  102. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  103. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  104. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  105. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  106. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  107. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  108. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  109. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  110. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  111. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  112. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  113. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  114. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  115. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  116. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  117. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  118. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  119. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
  120. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
  121. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
  122. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
  123. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +3 -0
  124. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
  125. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
  126. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
  127. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
  128. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
  129. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
  130. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
  131. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
  132. package/docs/docs/cmd/request.md +74 -0
  133. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  134. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  135. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  136. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  137. package/docs/docs/cmd/spo/homesite/homesite-get.md +20 -1
  138. package/docs/docs/cmd/spo/homesite/homesite-remove.md +8 -2
  139. package/docs/docs/cmd/spo/homesite/homesite-set.md +8 -2
  140. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +9 -9
  141. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +34 -5
  142. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +6 -6
  143. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +36 -19
  144. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +59 -1
  145. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +30 -1
  146. package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +6 -6
  147. package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +4 -4
  148. package/docs/docs/cmd/spo/hubsite/hubsite-set.md +40 -15
  149. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +4 -4
  150. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +7 -1
  151. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +9 -3
  152. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +8 -2
  153. package/docs/docs/cmd/spo/list/list-add.md +123 -57
  154. package/docs/docs/cmd/spo/list/list-contenttype-add.md +50 -5
  155. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +4 -4
  156. package/docs/docs/cmd/spo/list/list-contenttype-list.md +49 -4
  157. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +6 -6
  158. package/docs/docs/cmd/spo/list/list-get.md +70 -4
  159. package/docs/docs/cmd/spo/list/list-list.md +70 -2
  160. package/docs/docs/cmd/spo/list/list-remove.md +6 -6
  161. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +2 -2
  162. package/docs/docs/cmd/spo/list/list-retentionlabel-get.md +36 -3
  163. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +3 -3
  164. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +6 -6
  165. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +3 -3
  166. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +9 -9
  167. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +7 -7
  168. package/docs/docs/cmd/spo/list/list-set.md +61 -61
  169. package/docs/docs/cmd/spo/list/list-sitescript-get.md +35 -3
  170. package/docs/docs/cmd/spo/list/list-view-add.md +66 -5
  171. package/docs/docs/cmd/spo/list/list-view-field-add.md +10 -10
  172. package/docs/docs/cmd/spo/list/list-view-get.md +61 -0
  173. package/docs/docs/cmd/spo/list/list-view-list.md +61 -0
  174. package/docs/docs/cmd/spo/list/list-view-set.md +1 -1
  175. package/docs/docs/cmd/spo/list/list-webhook-add.md +19 -0
  176. package/docs/docs/cmd/spo/list/list-webhook-get.md +19 -0
  177. package/docs/docs/cmd/spo/list/list-webhook-list.md +19 -0
  178. package/docs/docs/cmd/spo/listitem/listitem-add.md +29 -0
  179. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +17 -2
  180. package/docs/docs/cmd/spo/listitem/listitem-get.md +57 -0
  181. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +6 -0
  182. package/docs/docs/cmd/spo/listitem/listitem-list.md +28 -0
  183. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +15 -0
  184. package/docs/docs/cmd/spo/listitem/listitem-set.md +30 -0
  185. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +22 -0
  186. package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
  187. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  188. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
  189. package/docs/docs/cmd/status.md +46 -0
  190. package/docs/docs/cmd/version.md +26 -0
  191. package/npm-shrinkwrap.json +912 -876
  192. package/package.json +13 -12
@@ -352,3 +352,22 @@ m365 pp environment get
352
352
  name,id
353
353
  Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d,/providers/Microsoft.BusinessAppPlatform/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
354
354
  ```
355
+
356
+ === "Markdown"
357
+
358
+ ```md
359
+ # pp environment get --name Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
360
+
361
+ Date: 9/1/2023
362
+
363
+ ## environmentName (default) (/providers/Microsoft.BusinessAppPlatform/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
364
+
365
+ Property | Value
366
+ ---------|-------
367
+ id | /providers/Microsoft.BusinessAppPlatform/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
368
+ type | Microsoft.BusinessAppPlatform/environments
369
+ location | europe
370
+ name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
371
+ properties | {"tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","azureRegion":"northeurope","displayName":"contoso (default)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","isDefault":true,"clientUris":{"admin":"https://admin.powerplatform.microsoft.com/environments/environment/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/hub","maker":"https://make.powerapps.com/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/home"},"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"databaseType":"CommonDataService","linkedEnvironmentMetadata":{"resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","backgroundOperationsState":"Enabled","scaleGroup":"EURCRMLIVESG644","platformSku":"Standard"},"trialScenarioType":"None","retentionPeriod":"P7D","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"retentionDetails":{"retentionPeriod":"P7D","backupsAvailableFromDateTime":"2022-10-23T23:27:16.8059564Z"},"protectionStatus":{"keyManagedBy":"Microsoft"},"cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"connectedGroups":[],"lifecycleOperationsEnforcement":{"allowedOperations":[{"type":{"id":"Backup"}},{"type":{"id":"Edit"}},{"type":{"id":"Enable"}},{"type":{"id":"Disable"}},{"type":{"id":"EnableGovernanceConfiguration"}}],"disallowedOperations":[{"type":{"id":"Provision"},"reason":{"message":"Provision cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."}},{"type":{"id":"Unlock"},"reason":{"message":"Unlock cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."}},{"type":{"id":"Convert"},"reason":{"message":"Convert cannot be performed on environment of type Default."}},{"type":{"id":"Copy"},"reason":{"message":"Copy cannot be performed on environment of type Default."}},{"type":{"id":"Delete"},"reason":{"message":"Delete cannot be performed on environment of type Default."}},{"type":{"id":"Promote"},"reason":{"message":"Promote cannot be performed on environment of type Default."}},{"type":{"id":"Recover"},"reason":{"message":"Recover cannot be performed on environment of type Default."}},{"type":{"id":"Reset"},"reason":{"message":"Reset cannot be performed on environment of type Default."}},{"type":{"id":"Restore"},"reason":{"message":"Restore cannot be performed on environment of type Default."}},{"type":{"id":"UpdateProtectionStatus"},"reason":{"message":"UpdateProtectionStatus cannot be performed on environment of type Default."}},{"type":{"id":"NewCustomerManagedKey"},"reason":{"message":"NewCustomerManagedKey cannot be performed on environment of type Default."}},{"type":{"id":"RotateCustomerManagedKey"},"reason":{"message":"RotateCustomerManagedKey cannot be performed on environment of type Default."}},{"type":{"id":"RevertToMicrosoftKey"},"reason":{"message":"RevertToMicrosoftKey cannot be performed on environment of type Default."}},{"type":{"id":"NewNetworkInjection"},"reason":{"message":"NewNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"SwapNetworkInjection"},"reason":{"message":"SwapNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"RevertNetworkInjection"},"reason":{"message":"RevertNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"NewIdentity"},"reason":{"message":"NewIdentity cannot be performed on environment of type Default."}},{"type":{"id":"SwapIdentity"},"reason":{"message":"SwapIdentity cannot be performed on environment of type Default."}},{"type":{"id":"RevertIdentity"},"reason":{"message":"RevertIdentity cannot be performed on environment of type Default."}},{"type":{"id":"DisableGovernanceConfiguration"},"reason":{"message":"DisableGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration."}},{"type":{"id":"UpdateGovernanceConfiguration"},"reason":{"message":"UpdateGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration." }}]},"governanceConfiguration":{"protectionLevel":"Basic"}}
372
+ displayName | contoso (default)
373
+ ```
@@ -347,3 +347,22 @@ m365 pp environment list --asAdmin
347
347
  name,displayName
348
348
  Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d,contoso (default)
349
349
  ```
350
+
351
+ === "Markdown"
352
+
353
+ ```md
354
+ # pp environment list
355
+
356
+ Date: 9/1/2023
357
+
358
+ ## environmentName (default) (/providers/Microsoft.BusinessAppPlatform/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
359
+
360
+ Property | Value
361
+ ---------|-------
362
+ id | /providers/Microsoft.BusinessAppPlatform/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
363
+ type | Microsoft.BusinessAppPlatform/environments
364
+ location | europe
365
+ name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
366
+ properties | {"tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","azureRegion":"northeurope","displayName":"contoso (default)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","isDefault":true,"clientUris":{"admin":"https://admin.powerplatform.microsoft.com/environments/environment/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/hub","maker":"https://make.powerapps.com/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/home"},"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"databaseType":"CommonDataService","linkedEnvironmentMetadata":{"resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","backgroundOperationsState":"Enabled","scaleGroup":"EURCRMLIVESG644","platformSku":"Standard"},"trialScenarioType":"None","retentionPeriod":"P7D","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"retentionDetails":{"retentionPeriod":"P7D","backupsAvailableFromDateTime":"2022-10-23T23:27:16.8059564Z"},"protectionStatus":{"keyManagedBy":"Microsoft"},"cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"connectedGroups":[],"lifecycleOperationsEnforcement":{"allowedOperations":[{"type":{"id":"Backup"}},{"type":{"id":"Edit"}},{"type":{"id":"Enable"}},{"type":{"id":"Disable"}},{"type":{"id":"EnableGovernanceConfiguration"}}],"disallowedOperations":[{"type":{"id":"Provision"},"reason":{"message":"Provision cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."}},{"type":{"id":"Unlock"},"reason":{"message":"Unlock cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."}},{"type":{"id":"Convert"},"reason":{"message":"Convert cannot be performed on environment of type Default."}},{"type":{"id":"Copy"},"reason":{"message":"Copy cannot be performed on environment of type Default."}},{"type":{"id":"Delete"},"reason":{"message":"Delete cannot be performed on environment of type Default."}},{"type":{"id":"Promote"},"reason":{"message":"Promote cannot be performed on environment of type Default."}},{"type":{"id":"Recover"},"reason":{"message":"Recover cannot be performed on environment of type Default."}},{"type":{"id":"Reset"},"reason":{"message":"Reset cannot be performed on environment of type Default."}},{"type":{"id":"Restore"},"reason":{"message":"Restore cannot be performed on environment of type Default."}},{"type":{"id":"UpdateProtectionStatus"},"reason":{"message":"UpdateProtectionStatus cannot be performed on environment of type Default."}},{"type":{"id":"NewCustomerManagedKey"},"reason":{"message":"NewCustomerManagedKey cannot be performed on environment of type Default."}},{"type":{"id":"RotateCustomerManagedKey"},"reason":{"message":"RotateCustomerManagedKey cannot be performed on environment of type Default."}},{"type":{"id":"RevertToMicrosoftKey"},"reason":{"message":"RevertToMicrosoftKey cannot be performed on environment of type Default."}},{"type":{"id":"NewNetworkInjection"},"reason":{"message":"NewNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"SwapNetworkInjection"},"reason":{"message":"SwapNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"RevertNetworkInjection"},"reason":{"message":"RevertNetworkInjection cannot be performed on environment of type Default."}},{"type":{"id":"NewIdentity"},"reason":{"message":"NewIdentity cannot be performed on environment of type Default."}},{"type":{"id":"SwapIdentity"},"reason":{"message":"SwapIdentity cannot be performed on environment of type Default."}},{"type":{"id":"RevertIdentity"},"reason":{"message":"RevertIdentity cannot be performed on environment of type Default."}},{"type":{"id":"DisableGovernanceConfiguration"},"reason":{"message":"DisableGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration."}},{"type":{"id":"UpdateGovernanceConfiguration"},"reason":{"message":"UpdateGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration." }}]},"governanceConfiguration":{"protectionLevel":"Basic"}}
367
+ displayName | contoso (default)
368
+ ```
@@ -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,132 @@
1
+ # purview retentionevent get
2
+
3
+ Get a retention event
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionevent get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the retention event.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get a retention event by id
21
+
22
+ ```sh
23
+ m365 purview retentionevent 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
+ !!! attention
32
+ This command currently only supports delegated permissions.
33
+
34
+ ## More information
35
+
36
+ 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.
37
+
38
+ [Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
39
+
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ {
47
+ "displayName": "Contract xyz expired",
48
+ "description": "The retention period for documents related to Contract xyz started because the contract expired.",
49
+ "eventTriggerDateTime": "2023-02-01T09:16:37Z",
50
+ "lastStatusUpdateDateTime": "2023-02-01T09:21:15Z",
51
+ "createdDateTime": "2023-02-01T09:17:40Z",
52
+ "lastModifiedDateTime": "2023-02-01T09:17:40Z",
53
+ "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
54
+ "eventQueries": [
55
+ {
56
+ "queryType": "files",
57
+ "query": "1234"
58
+ },
59
+ {
60
+ "queryType": "messages",
61
+ "query": "Terminate"
62
+ }
63
+ ],
64
+ "eventStatus": {
65
+ "error": null,
66
+ "status": "success"
67
+ },
68
+ "eventPropagationResults": [
69
+ {
70
+ "serviceName": "SharePoint",
71
+ "location": null,
72
+ "status": "none",
73
+ "statusInformation": null
74
+ }
75
+ ],
76
+ "createdBy": {
77
+ "user": {
78
+ "id": null,
79
+ "displayName": "John Doe"
80
+ }
81
+ },
82
+ "lastModifiedBy": {
83
+ "user": {
84
+ "id": null,
85
+ "displayName": "John Doe"
86
+ }
87
+ }
88
+ }
89
+ ```
90
+
91
+ === "Text"
92
+
93
+ ```text
94
+ createdBy : {"user":{"id":null,"displayName":"John Doe"}}
95
+ createdDateTime : 2023-02-01T09:17:40Z
96
+ description : The retention period for documents related to Contract xyz started because the contract expired.
97
+ displayName : Contract xyz expired
98
+ eventTriggerDateTime : 2023-02-01T09:16:37Z
99
+ id : c37d695e-d581-4ae9-82a0-9364eba4291e
100
+ lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
101
+ lastModifiedDateTime : 2023-02-01T09:17:40Z
102
+ lastStatusUpdateDateTime: 2023-02-01T09:21:15Z
103
+ ```
104
+
105
+ === "CSV"
106
+
107
+ ```csv
108
+ displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
109
+ Contract xyz expired,The retention period for documents related to Contract xyz started because the contract expired.,2023-02-01T09:16:37Z,2023-02-01T09:21:15Z,2023-02-01T09:17:40Z,2023-02-01T09:17:40Z,c37d695e-d581-4ae9-82a0-9364eba4291e,{"user":{"id":null,"displayName":"John Doe"}},{"user":{"id":null,"displayName":"John Doe"}}
110
+ ```
111
+
112
+ === "Markdown"
113
+
114
+ ```md
115
+ # purview retentionevent get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
116
+
117
+ Date: 2/1/2023
118
+
119
+ ## Contract xyz expired (c37d695e-d581-4ae9-82a0-9364eba4291e)
120
+
121
+ Property | Value
122
+ ---------|-------
123
+ displayName | Contract xyz expired
124
+ description | The retention period for documents related to Contract xyz started because the contract expired.
125
+ eventTriggerDateTime | 2023-02-01T09:16:37Z
126
+ lastStatusUpdateDateTime: 2023-02-01T09:21:15Z
127
+ createdDateTime | 2023-02-01T09:17:40Z
128
+ lastModifiedDateTime | 2023-02-01T09:17:40Z
129
+ id | c37d695e-d581-4ae9-82a0-9364eba4291e
130
+ createdBy | {"user":{"id":null,"displayName":"John Doe"}}
131
+ lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
132
+ ```
@@ -0,0 +1,107 @@
1
+ # purview retentionevent list
2
+
3
+ Get a list of retention events
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionevent list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ Get a list of retention events
18
+
19
+ ```sh
20
+ m365 purview retentionevent list
21
+ ```
22
+
23
+ ## Remarks
24
+
25
+ !!! attention
26
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
27
+
28
+ !!! attention
29
+ This command currently only supports delegated permissions.
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
+ ## Response
36
+
37
+
38
+ === "JSON"
39
+
40
+ ```json
41
+ [
42
+ {
43
+ "displayName": "Contract xyz expired",
44
+ "description": null,
45
+ "eventTriggerDateTime": "2023-02-03T13:51:40Z",
46
+ "eventStatus": null,
47
+ "lastStatusUpdateDateTime": null,
48
+ "createdDateTime": "2023-02-03T13:51:40Z",
49
+ "lastModifiedDateTime": "2023-02-03T13:51:40Z",
50
+ "id": "7248cfa8-c03a-4ec1-49a4-08db05edc686",
51
+ "eventQueries": [],
52
+ "eventPropagationResults": [],
53
+ "createdBy": {
54
+ "user": {
55
+ "id": null,
56
+ "displayName": "John Doe"
57
+ }
58
+ },
59
+ "lastModifiedBy": {
60
+ "user": {
61
+ "id": null,
62
+ "displayName": "John Doe"
63
+ }
64
+ }
65
+ }
66
+ ]
67
+ ```
68
+
69
+ === "Text"
70
+
71
+ ```text
72
+ id displayName eventTriggerDateTime
73
+ ------------------------------------ --------------------- --------------------
74
+ 7248cfa8-c03a-4ec1-49a4-08db05edc686 Contract xyz expired 2023-02-03T13:51:40Z
75
+ ```
76
+
77
+ === "CSV"
78
+
79
+ ```csv
80
+ id,displayName,isInUse
81
+ 7248cfa8-c03a-4ec1-49a4-08db05edc686,Contract xyz expired,2023-02-03T13:51:40Z
82
+ ```
83
+
84
+ === "Markdown"
85
+
86
+ ```md
87
+ # purview retentionevent list
88
+
89
+ Date: 3/2/2023
90
+
91
+ ## Contract xyz expired (7248cfa8-c03a-4ec1-49a4-08db05edc686)
92
+
93
+ Property | Value
94
+ ---------|-------
95
+ displayName | Contract xyz expired
96
+ description | null
97
+ eventTriggerDateTime | 2023-02-03T13:51:40Z
98
+ eventStatus | null
99
+ lastStatusUpdateDateTime | null
100
+ createdDateTime | 2023-02-03T13:51:40Z
101
+ lastModifiedDateTime | 2023-02-03T13:51:40Z
102
+ id | 7248cfa8-c03a-4ec1-49a4-08db05edc686
103
+ eventQueries | []
104
+ eventPropagationResults | []
105
+ createdBy | {"user":{"id":null,"displayName":"John Doe"}}
106
+ lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
107
+ ```
@@ -0,0 +1,45 @@
1
+ # purview retentionevent remove
2
+
3
+ Delete a retention event
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionevent remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the retention event.
15
+
16
+ `--confirm`
17
+ : Don't prompt for confirmation to remove the retention event.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Delete a retention event by id
24
+
25
+ ```sh
26
+ m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
27
+ ```
28
+
29
+ ## Remarks
30
+
31
+ !!! attention
32
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
33
+
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
37
+ ## More information
38
+
39
+ 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.
40
+
41
+ [Read more on event-based retention here](https://learn.microsoft.com/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
42
+
43
+ ## Response
44
+
45
+ The command won't return a response on success.
@@ -0,0 +1,106 @@
1
+ # purview retentioneventtype add
2
+
3
+ Create a retention event type
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentioneventtype add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --displayName <displayName>`
14
+ : The display name of the event type.
15
+
16
+ `-d, --description [description]`
17
+ : A description for the event type.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Create a retention event type *Contract Expiry*.
24
+
25
+ ```sh
26
+ m365 purview retentioneventtype add --displayName 'Contract Expiry' --description 'A retention event type to start a retention period based on the date that a contract expired.'
27
+ ```
28
+
29
+ ## Remarks
30
+
31
+ !!! attention
32
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
33
+
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
37
+ ## More information
38
+
39
+ 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. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ {
47
+ {
48
+ "displayName": "Contract Expiry",
49
+ "description": "A retention event type to start a retention period based on the date that a contract expired.",
50
+ "createdDateTime": "2023-01-31T20:33:33Z",
51
+ "lastModifiedDateTime": "2023-01-31T20:33:33Z",
52
+ "id": "f15d2493-7ad2-4185-a3f6-9580542490a0",
53
+ "createdBy": {
54
+ "user": {
55
+ "id": null,
56
+ "displayName": "Mathijs Verbeeck"
57
+ }
58
+ },
59
+ "lastModifiedBy": {
60
+ "user": {
61
+ "id": null,
62
+ "displayName": "Mathijs Verbeeck"
63
+ }
64
+ }
65
+ }
66
+ }
67
+ ```
68
+
69
+ === "Text"
70
+
71
+ ```text
72
+ createdBy : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
73
+ createdDateTime : 2023-01-31T20:40:40Z
74
+ description : A retention event type to start a retention period based on the date that a contract expired.
75
+ displayName : Contract Expiry
76
+ id : 806cb481-4cc6-47c3-af26-26d64f6e7aab
77
+ lastModifiedBy : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
78
+ lastModifiedDateTime: 2023-01-31T20:40:40Z
79
+ ```
80
+
81
+ === "CSV"
82
+
83
+ ```csv
84
+ displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
85
+ Contract Expiry,A retention event type to start a retention period based on the date that a contract expired.,2023-01-31T20:53:23Z,2023-01-31T20:53:23Z,b430ae4c-1e26-422f-9544-67df3abfb200,"{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}","{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}"
86
+ ```
87
+
88
+ === "Markdown"
89
+
90
+ ```md
91
+ # purview retentioneventtype add --displayName "Contract Expiry" --description "A retention event type to start a retention period based on the date that a contract expired."
92
+
93
+ Date: 31/01/2023
94
+
95
+ ## Contract Expiry (ca0e1f8d-4e42-4a81-be85-022502d70c4e)
96
+
97
+ Property | Value
98
+ ---------|-------
99
+ displayName | Contract Expiry
100
+ description | A retention event type to start a retention period based on the date that a contract expired.
101
+ createdDateTime | 2023-01-31T20:55:35Z
102
+ lastModifiedDateTime | 2023-01-31T20:55:35Z
103
+ id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
104
+ createdBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
105
+ lastModifiedBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
106
+ ```