@pnp/cli-microsoft365 6.7.0-beta.f5f5666 → 6.8.0-beta.00c3a00
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.
- package/.eslintrc.js +2 -0
- package/.mocharc.json +1 -0
- package/README.md +15 -10
- package/dist/Command.js +62 -7
- package/dist/chili/chili.js +298 -0
- package/dist/chili/index.js +20 -0
- package/dist/cli/Cli.js +2 -2
- package/dist/m365/aad/commands/user/user-add.js +30 -21
- package/dist/m365/app/commands/permission/permission-add.js +279 -0
- package/dist/m365/app/commands.js +1 -0
- package/dist/m365/commands/commands.js +2 -0
- package/dist/m365/commands/docs.js +42 -0
- package/dist/m365/commands/login.js +1 -1
- package/dist/m365/commands/setup.js +180 -0
- package/dist/m365/commands/setupPresets.js +25 -0
- package/dist/m365/flow/commands/run/run-get.js +31 -1
- package/dist/m365/pa/commands/app/app-consent-set.js +101 -0
- package/dist/m365/pa/commands.js +1 -0
- package/dist/m365/planner/commands/roster/roster-plan-list.js +102 -0
- package/dist/m365/planner/commands.js +1 -0
- package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-get.js +97 -0
- package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-list.js +85 -0
- package/dist/m365/purview/commands/sensitivitylabel/sensitivitylabel-policysettings-list.js +89 -0
- package/dist/m365/purview/commands.js +3 -0
- package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.2.js +2 -0
- package/dist/m365/spfx/commands/spfx-doctor.js +14 -30
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-remove.js +146 -0
- package/dist/m365/spo/commands/file/file-checkin.js +8 -3
- package/dist/m365/spo/commands/file/file-checkout.js +8 -3
- package/dist/m365/spo/commands/file/file-copy.js +4 -4
- package/dist/m365/spo/commands/file/file-get.js +3 -1
- package/dist/m365/spo/commands/file/file-list.js +121 -34
- package/dist/m365/spo/commands/file/file-move.js +6 -7
- package/dist/m365/spo/commands/file/file-remove.js +6 -12
- package/dist/m365/spo/commands/file/file-rename.js +3 -3
- package/dist/m365/spo/commands/file/file-roleassignment-add.js +2 -1
- package/dist/m365/spo/commands/file/file-roleassignment-remove.js +3 -3
- package/dist/m365/spo/commands/file/file-roleinheritance-break.js +2 -1
- package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +2 -1
- package/dist/m365/spo/commands/file/file-sharinginfo-get.js +4 -2
- package/dist/m365/spo/commands/file/file-version-clear.js +3 -1
- package/dist/m365/spo/commands/file/file-version-get.js +3 -1
- package/dist/m365/spo/commands/file/file-version-remove.js +3 -1
- package/dist/m365/spo/commands/file/file-version-restore.js +3 -1
- package/dist/m365/spo/commands/folder/folder-copy.js +4 -4
- package/dist/m365/spo/commands/folder/folder-get.js +5 -2
- package/dist/m365/spo/commands/folder/folder-list.js +73 -16
- package/dist/m365/spo/commands/folder/folder-move.js +3 -2
- package/dist/m365/spo/commands/folder/folder-rename.js +5 -2
- package/dist/m365/spo/commands/list/list-get.js +30 -3
- package/dist/m365/spo/commands/list/list-list.js +39 -2
- package/dist/m365/spo/commands/listitem/listitem-batch-set.js +308 -0
- package/dist/m365/spo/commands/page/page-section-add.js +2 -3
- package/dist/m365/spo/commands/serviceprincipal/serviceprincipal-permissionrequest-list.js +46 -1
- package/dist/m365/spo/commands/site/site-recyclebinitem-move.js +119 -0
- package/dist/m365/spo/commands/site/site-recyclebinitem-remove.js +106 -0
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +30 -39
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-list.js +47 -0
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-remove.js +151 -0
- package/dist/m365/spo/commands/tenant/tenant-commandset-remove.js +152 -0
- package/dist/m365/spo/commands/tenant/tenant-commandset-set.js +203 -0
- package/dist/m365/spo/commands/tenant/tenant-settings-set.js +4 -0
- package/dist/m365/spo/commands/term/term-add.js +13 -4
- package/dist/m365/spo/commands/term/term-get.js +14 -5
- package/dist/m365/spo/commands/term/term-group-get.js +12 -3
- package/dist/m365/spo/commands/term/term-group-list.js +39 -4
- package/dist/m365/spo/commands/term/term-list.js +18 -9
- package/dist/m365/spo/commands/term/term-set-add.js +13 -4
- package/dist/m365/spo/commands/term/term-set-get.js +12 -3
- package/dist/m365/spo/commands/term/term-set-list.js +12 -3
- package/dist/m365/spo/commands.js +9 -0
- package/dist/m365/teams/commands/chat/chat-member-remove.js +137 -0
- package/dist/m365/teams/commands/meeting/meeting-transcript-list.js +124 -0
- package/dist/m365/teams/commands.js +2 -0
- package/dist/utils/formatting.js +35 -11
- package/dist/utils/pid.js +5 -0
- package/dist/utils/spo.js +1 -1
- package/docs/docs/cmd/aad/o365group/o365group-get.md +0 -12
- package/docs/docs/cmd/aad/user/user-add.md +4 -0
- package/docs/docs/cmd/aad/user/user-set.md +2 -2
- package/docs/docs/cmd/app/permission/permission-add.md +53 -0
- package/docs/docs/cmd/cli/cli-consent.md +6 -0
- package/docs/docs/cmd/cli/cli-doctor.md +17 -0
- package/docs/docs/cmd/cli/cli-issue.md +6 -0
- package/docs/docs/cmd/cli/cli-reconsent.md +6 -0
- package/docs/docs/cmd/cli/completion/completion-sh-setup.md +6 -0
- package/docs/docs/cmd/cli/config/config-get.md +6 -0
- package/docs/docs/cmd/docs.md +51 -0
- package/docs/docs/cmd/flow/environment/environment-list.md +18 -0
- package/docs/docs/cmd/flow/flow-get.md +20 -0
- package/docs/docs/cmd/flow/flow-list.md +17 -0
- package/docs/docs/cmd/flow/run/run-get.md +110 -9
- package/docs/docs/cmd/graph/changelog/changelog-list.md +52 -0
- package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +61 -0
- package/docs/docs/cmd/graph/schemaextension/schemaextension-get.md +61 -0
- package/docs/docs/cmd/graph/schemaextension/schemaextension-list.md +61 -0
- package/docs/docs/cmd/graph/schemaextension/schemaextension-remove.md +4 -0
- package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -0
- package/docs/docs/cmd/graph/subscription/subscription-add.md +73 -0
- package/docs/docs/cmd/login.md +1 -1
- package/docs/docs/cmd/onedrive/onedrive-list.md +225 -0
- package/docs/docs/cmd/onedrive/report/report-activityfilecounts.md +39 -0
- package/docs/docs/cmd/onedrive/report/report-activityusercounts.md +39 -0
- package/docs/docs/cmd/onedrive/report/report-activityuserdetail.md +43 -0
- package/docs/docs/cmd/onedrive/report/report-usageaccountcounts.md +38 -0
- package/docs/docs/cmd/onedrive/report/report-usageaccountdetail.md +43 -0
- package/docs/docs/cmd/onedrive/report/report-usagefilecounts.md +38 -0
- package/docs/docs/cmd/onedrive/report/report-usagestorage.md +37 -0
- package/docs/docs/cmd/onenote/notebook/notebook-list.md +79 -0
- package/docs/docs/cmd/pa/app/app-consent-set.md +47 -0
- package/docs/docs/cmd/planner/plan/plan-get.md +1 -1
- package/docs/docs/cmd/planner/plan/plan-list.md +1 -1
- package/docs/docs/cmd/planner/roster/roster-add.md +2 -1
- package/docs/docs/cmd/planner/roster/roster-get.md +1 -1
- package/docs/docs/cmd/planner/roster/roster-plan-list.md +109 -0
- package/docs/docs/cmd/planner/roster/roster-remove.md +2 -1
- package/docs/docs/cmd/planner/task/task-add.md +3 -1
- package/docs/docs/cmd/planner/task/task-get.md +0 -6
- package/docs/docs/cmd/planner/task/task-set.md +7 -5
- package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +6 -7
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +6 -7
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +4 -4
- package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +4 -4
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +10 -10
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +11 -11
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +10 -10
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +10 -10
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +10 -10
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -12
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +8 -9
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +8 -9
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +8 -8
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +8 -8
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.md +118 -0
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.md +111 -0
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-policysettings-list.md +97 -0
- package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +17 -0
- package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +17 -0
- package/docs/docs/cmd/setup.md +86 -0
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +1 -1
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.md +77 -0
- package/docs/docs/cmd/spo/commandset/commandset-set.md +1 -1
- package/docs/docs/cmd/spo/contenttype/contenttype-set.md +2 -2
- package/docs/docs/cmd/spo/customaction/customaction-add.md +1 -1
- package/docs/docs/cmd/spo/customaction/customaction-set.md +1 -1
- package/docs/docs/cmd/spo/feature/feature-enable.md +2 -2
- package/docs/docs/cmd/spo/file/file-add.md +1 -1
- package/docs/docs/cmd/spo/file/file-checkin.md +1 -1
- package/docs/docs/cmd/spo/file/file-checkout.md +1 -1
- package/docs/docs/cmd/spo/file/file-copy.md +1 -1
- package/docs/docs/cmd/spo/file/file-get.md +1 -1
- package/docs/docs/cmd/spo/file/file-list.md +93 -5
- package/docs/docs/cmd/spo/file/file-move.md +3 -3
- package/docs/docs/cmd/spo/file/file-remove.md +12 -0
- package/docs/docs/cmd/spo/file/file-rename.md +1 -1
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +3 -3
- package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md +2 -2
- package/docs/docs/cmd/spo/file/file-roleassignment-add.md +1 -1
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinginfo-get.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-add.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-get.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +1 -1
- package/docs/docs/cmd/spo/file/file-sharinglink-set.md +1 -1
- package/docs/docs/cmd/spo/file/file-version-clear.md +2 -2
- package/docs/docs/cmd/spo/file/file-version-get.md +1 -1
- package/docs/docs/cmd/spo/file/file-version-list.md +1 -1
- package/docs/docs/cmd/spo/file/file-version-remove.md +1 -1
- package/docs/docs/cmd/spo/file/file-version-restore.md +1 -1
- package/docs/docs/cmd/spo/folder/folder-add.md +9 -3
- package/docs/docs/cmd/spo/folder/folder-copy.md +2 -2
- package/docs/docs/cmd/spo/folder/folder-get.md +7 -7
- package/docs/docs/cmd/spo/folder/folder-list.md +45 -10
- package/docs/docs/cmd/spo/folder/folder-move.md +1 -1
- package/docs/docs/cmd/spo/folder/folder-remove.md +7 -7
- package/docs/docs/cmd/spo/folder/folder-rename.md +11 -5
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.md +3 -3
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.md +1 -1
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +1 -1
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +4 -4
- package/docs/docs/cmd/spo/list/list-get.md +10 -0
- package/docs/docs/cmd/spo/list/list-list.md +28 -0
- package/docs/docs/cmd/spo/listitem/listitem-batch-set.md +67 -0
- package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +19 -0
- package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +12 -0
- package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +6 -0
- package/docs/docs/cmd/spo/page/page-column-get.md +15 -0
- package/docs/docs/cmd/spo/page/page-column-list.md +16 -0
- package/docs/docs/cmd/spo/page/page-control-get.md +18 -0
- package/docs/docs/cmd/spo/page/page-control-list.md +18 -0
- package/docs/docs/cmd/spo/page/page-copy.md +35 -0
- package/docs/docs/cmd/spo/page/page-get.md +39 -0
- package/docs/docs/cmd/spo/page/page-list.md +53 -0
- package/docs/docs/cmd/spo/page/page-section-get.md +12 -0
- package/docs/docs/cmd/spo/page/page-section-list.md +13 -0
- package/docs/docs/cmd/spo/page/page-template-list.md +31 -0
- package/docs/docs/cmd/spo/propertybag/propertybag-get.md +6 -0
- package/docs/docs/cmd/spo/propertybag/propertybag-list.md +13 -0
- package/docs/docs/cmd/spo/report/report-activityfilecounts.md +7 -0
- package/docs/docs/cmd/spo/report/report-activitypages.md +7 -0
- package/docs/docs/cmd/spo/report/report-activityusercounts.md +7 -0
- package/docs/docs/cmd/spo/report/report-activityuserdetail.md +7 -0
- package/docs/docs/cmd/spo/report/report-siteusagedetail.md +7 -0
- package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +7 -0
- package/docs/docs/cmd/spo/report/report-siteusagepages.md +7 -0
- package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +7 -0
- package/docs/docs/cmd/spo/report/report-siteusagestorage.md +7 -0
- package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +20 -0
- package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +20 -0
- package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +20 -0
- package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +18 -0
- package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +20 -0
- package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +17 -0
- package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +13 -0
- package/docs/docs/cmd/spo/site/site-recyclebinitem-move.md +43 -0
- package/docs/docs/cmd/spo/site/site-recyclebinitem-remove.md +45 -0
- package/docs/docs/cmd/spo/spo-get.md +12 -0
- package/docs/docs/cmd/spo/spo-search.md +16 -3
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +1 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.md +103 -0
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.md +49 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.md +49 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-set.md +57 -0
- package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +57 -54
- package/docs/docs/cmd/spo/term/term-add.md +107 -6
- package/docs/docs/cmd/spo/term/term-get.md +111 -10
- package/docs/docs/cmd/spo/term/term-group-get.md +71 -5
- package/docs/docs/cmd/spo/term/term-group-list.md +70 -2
- package/docs/docs/cmd/spo/term/term-list.md +80 -8
- package/docs/docs/cmd/spo/term/term-set-add.md +95 -11
- package/docs/docs/cmd/spo/term/term-set-get.md +92 -8
- package/docs/docs/cmd/spo/term/term-set-list.md +85 -5
- package/docs/docs/cmd/spo/user/user-ensure.md +1 -2
- package/docs/docs/cmd/spo/user/user-get.md +24 -0
- package/docs/docs/cmd/spo/user/user-list.md +27 -3
- package/docs/docs/cmd/spo/userprofile/userprofile-get.md +21 -0
- package/docs/docs/cmd/spo/web/web-add.md +24 -0
- package/docs/docs/cmd/spo/web/web-clientsidewebpart-list.md +16 -0
- package/docs/docs/cmd/spo/web/web-get.md +124 -0
- package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +16 -0
- package/docs/docs/cmd/spo/web/web-list.md +16 -0
- package/docs/docs/cmd/spo/web/web-retentionlabel-list.md +29 -2
- package/docs/docs/cmd/teams/app/app-list.md +17 -0
- package/docs/docs/cmd/teams/app/app-publish.md +18 -1
- package/docs/docs/cmd/teams/channel/channel-add.md +20 -0
- package/docs/docs/cmd/teams/channel/channel-get.md +21 -0
- package/docs/docs/cmd/teams/channel/channel-list.md +21 -0
- package/docs/docs/cmd/teams/channel/channel-member-list.md +20 -0
- package/docs/docs/cmd/teams/channel/channel-member-set.md +21 -0
- package/docs/docs/cmd/teams/chat/chat-get.md +22 -0
- package/docs/docs/cmd/teams/chat/chat-list.md +22 -0
- package/docs/docs/cmd/teams/chat/chat-member-list.md +20 -0
- package/docs/docs/cmd/teams/chat/chat-member-remove.md +52 -0
- package/docs/docs/cmd/teams/chat/chat-message-list.md +23 -0
- package/docs/docs/cmd/teams/funsettings/funsettings-list.md +15 -0
- package/docs/docs/cmd/teams/guestsettings/guestsettings-list.md +13 -0
- package/docs/docs/cmd/teams/meeting/meeting-transcript-list.md +96 -0
- package/docs/docs/cmd/teams/membersettings/membersettings-list.md +17 -0
- package/docs/docs/cmd/teams/tab/tab-remove.md +1 -1
- package/docs/docs/cmd/version.md +1 -1
- package/docs/docs/cmd/yammer/group/group-list.md +42 -0
- package/docs/docs/cmd/yammer/message/message-add.md +32 -0
- package/docs/docs/cmd/yammer/message/message-get.md +32 -0
- package/docs/docs/cmd/yammer/message/message-list.md +34 -0
- package/docs/docs/cmd/yammer/network/network-list.md +70 -0
- package/docs/docs/cmd/yammer/report/report-activitycounts.md +7 -0
- package/docs/docs/cmd/yammer/report/report-activityusercounts.md +7 -0
- package/docs/docs/cmd/yammer/report/report-activityuserdetail.md +7 -0
- package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md +7 -0
- package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md +7 -0
- package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md +7 -0
- package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md +7 -0
- package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md +7 -0
- package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md +7 -0
- package/docs/docs/cmd/yammer/user/user-get.md +55 -0
- package/docs/docs/cmd/yammer/user/user-list.md +55 -0
- package/docs/docs/cmd/yammer/yammer-search.md +15 -3
- package/npm-shrinkwrap.json +269 -336
- package/package.json +15 -12
- package/dist/m365/spo/commands/file/FilePropertiesCollection.js +0 -3
- package/dist/m365/spo/commands/folder/FileFolderCollection.js +0 -3
|
@@ -24,7 +24,7 @@ m365 planner plan list [options]
|
|
|
24
24
|
## Remarks
|
|
25
25
|
|
|
26
26
|
!!! attention
|
|
27
|
-
When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
27
|
+
When using rosterId, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
28
28
|
|
|
29
29
|
## Examples
|
|
30
30
|
|
|
@@ -71,5 +71,6 @@ m365 planner roster add
|
|
|
71
71
|
assignedSensitivityLabel | null
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
##
|
|
74
|
+
## More information
|
|
75
|
+
|
|
75
76
|
Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
|
|
@@ -68,6 +68,6 @@ m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
|
|
|
68
68
|
assignedSensitivityLabel | null
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
##
|
|
71
|
+
## More information
|
|
72
72
|
|
|
73
73
|
Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# planner roster plan list
|
|
2
|
+
|
|
3
|
+
Lists all Microsoft Planner Roster plans for a specific user
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner roster plan list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--userId [userId]`
|
|
14
|
+
: User's Azure AD ID. Specify either `userId` or `userName` but not both. Specify this option only when using application permissions.
|
|
15
|
+
|
|
16
|
+
`--userName [userName]`
|
|
17
|
+
: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both. Specify this option only when using application permissions.
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
!!! attention
|
|
24
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
25
|
+
|
|
26
|
+
## Examples
|
|
27
|
+
|
|
28
|
+
List all Planner plans contained in a Roster where the current logged in user is member of.
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
m365 planner roster plan list
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
List all Planner plans contained in a Roster where specific user is member of by its UPN.
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
m365 planner roster plan list --userName john.doe@contoso.com
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
List all Planner plans contained in a Roster where specific user is member of by its Id.
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
m365 planner roster plan list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Response
|
|
47
|
+
|
|
48
|
+
=== "JSON"
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
[
|
|
52
|
+
{
|
|
53
|
+
"createdDateTime": "2023-04-06T14:41:49.8676617Z",
|
|
54
|
+
"owner": "59f80e08-24b1-41f8-8586-16765fd830d3",
|
|
55
|
+
"title": "My Planner Plan",
|
|
56
|
+
"creationSource": null,
|
|
57
|
+
"id": "_5GY9MJpZU2vb3DC46CP3MkACr8m",
|
|
58
|
+
"createdBy": {
|
|
59
|
+
"user": {
|
|
60
|
+
"displayName": null,
|
|
61
|
+
"id": "59f80e08-24b1-41f8-8586-16765fd830d3"
|
|
62
|
+
},
|
|
63
|
+
"application": {
|
|
64
|
+
"displayName": null,
|
|
65
|
+
"id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"container": {
|
|
69
|
+
"containerId": "_5GY9MJpZU2vb3DC46CP3MkACr8m",
|
|
70
|
+
"type": "unknownFutureValue",
|
|
71
|
+
"url": "https://graph.microsoft.com/beta/planner/rosters/_5GY9MJpZU2vb3DC46CP3MkACr8m"
|
|
72
|
+
},
|
|
73
|
+
"contexts": {},
|
|
74
|
+
"sharedWithContainers": []
|
|
75
|
+
}
|
|
76
|
+
]
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
=== "Text"
|
|
80
|
+
|
|
81
|
+
```text
|
|
82
|
+
id title createdDateTime owner
|
|
83
|
+
---------------------------- --------------- ---------------------------- ------------------------------------
|
|
84
|
+
_5GY9MJpZU2vb3DC46CP3MkACr8m My Planner Plan 2023-04-06T14:41:49.8676617Z 59f80e08-24b1-41f8-8586-16765fd830d3
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
=== "CSV"
|
|
88
|
+
|
|
89
|
+
```csv
|
|
90
|
+
createdDateTime,owner,title,id
|
|
91
|
+
2023-04-06T14:41:49.8676617Z,59f80e08-24b1-41f8-8586-16765fd830d3,My Planner Plan,_5GY9MJpZU2vb3DC46CP3MkACr8m
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
=== "Markdown"
|
|
95
|
+
|
|
96
|
+
```md
|
|
97
|
+
# planner roster plan list --userId "59f80e08-24b1-41f8-8586-16765fd830d3"
|
|
98
|
+
|
|
99
|
+
Date: 4/8/2023
|
|
100
|
+
|
|
101
|
+
## My Planner Plan (_5GY9MJpZU2vb3DC46CP3MkACr8m)
|
|
102
|
+
|
|
103
|
+
Property | Value
|
|
104
|
+
---------|-------
|
|
105
|
+
createdDateTime | 2023-04-06T14:41:49.8676617Z
|
|
106
|
+
owner | 59f80e08-24b1-41f8-8586-16765fd830d3
|
|
107
|
+
title | My Planner Plan
|
|
108
|
+
id | \_5GY9MJpZU2vb3DC46CP3MkACr8m
|
|
109
|
+
```
|
|
@@ -44,5 +44,6 @@ m365 planner roster remove --id tYqYlNd6eECmsNhN_fcq85cAGAnd --confirm
|
|
|
44
44
|
|
|
45
45
|
The command won't return a response on success.
|
|
46
46
|
|
|
47
|
-
##
|
|
47
|
+
## More information
|
|
48
|
+
|
|
48
49
|
Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.
|
|
@@ -50,7 +50,7 @@ m365 planner task add [options]
|
|
|
50
50
|
: Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
|
|
51
51
|
|
|
52
52
|
`--description [description]`
|
|
53
|
-
: Description of the task
|
|
53
|
+
: Description of the task.
|
|
54
54
|
|
|
55
55
|
`--appliedCategories [appliedCategories]`
|
|
56
56
|
: Comma-separated categories that should be added to the task. The possible options are: `category1`, `category2`, `category3`, `category4`, `category5` and/or `category6`. Additional info defined [here](https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0).
|
|
@@ -81,6 +81,8 @@ When you specify an integer value for `priority`, consider the following:
|
|
|
81
81
|
- values 5, 6 and 7 are interpreted as _Medium_
|
|
82
82
|
- values 8, 9 and 10 are interpreted as _Low_
|
|
83
83
|
|
|
84
|
+
When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
|
|
85
|
+
|
|
84
86
|
## Examples
|
|
85
87
|
|
|
86
88
|
Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
|
|
@@ -50,16 +50,16 @@ m365 planner task set [options]
|
|
|
50
50
|
: Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
51
51
|
|
|
52
52
|
`--description [description]`
|
|
53
|
-
: Description of the task
|
|
53
|
+
: Description of the task.
|
|
54
54
|
|
|
55
55
|
`--orderHint [orderHint]`
|
|
56
|
-
: Hint used to order items of this type in a list view
|
|
56
|
+
: Hint used to order items of this type in a list view.
|
|
57
57
|
|
|
58
58
|
`--assigneePriority [assigneePriority]`
|
|
59
|
-
: Hint used to order items of this type in a list view
|
|
59
|
+
: Hint used to order items of this type in a list view.
|
|
60
60
|
|
|
61
61
|
`--appliedCategories [appliedCategories]`
|
|
62
|
-
: Comma-separated categories that should be added to the task
|
|
62
|
+
: Comma-separated categories that should be added to the task.
|
|
63
63
|
|
|
64
64
|
`--priority [priority]`
|
|
65
65
|
: Priority of the task: Urgent, Important, Medium, Low. Or an integer between 0 and 10 (check remarks section for more info).
|
|
@@ -83,6 +83,8 @@ When you specify an integer value for `priority`, consider the following:
|
|
|
83
83
|
|
|
84
84
|
You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
|
|
85
85
|
|
|
86
|
+
When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
|
|
87
|
+
|
|
86
88
|
## Examples
|
|
87
89
|
|
|
88
90
|
Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
|
|
@@ -333,7 +335,7 @@ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50
|
|
|
333
335
|
checklist | {}
|
|
334
336
|
```
|
|
335
337
|
|
|
336
|
-
##
|
|
338
|
+
## More information
|
|
337
339
|
|
|
338
340
|
- Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
|
|
339
341
|
- Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)
|
|
@@ -49,13 +49,6 @@ Create a retention event to start retention at the end of 2022 for all employee
|
|
|
49
49
|
m365 purview retentionevent add --displayName 'Employee information expiration' --description 'Employee documents expired due to offboarding' --eventTypeName 'CustomRetentionTime' --triggerDateTime '2022-12-31' --assetIds 'ComplianceAssetId:EmployeeNr1234'
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
## More information
|
|
53
|
-
|
|
54
|
-
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.
|
|
55
|
-
|
|
56
|
-
[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
|
|
57
|
-
|
|
58
|
-
|
|
59
52
|
## Response
|
|
60
53
|
|
|
61
54
|
=== "JSON"
|
|
@@ -147,3 +140,9 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
147
140
|
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
148
141
|
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
149
142
|
```
|
|
143
|
+
|
|
144
|
+
## More information
|
|
145
|
+
|
|
146
|
+
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.
|
|
147
|
+
|
|
148
|
+
[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
|
|
@@ -31,13 +31,6 @@ m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
|
31
31
|
!!! attention
|
|
32
32
|
This command currently only supports delegated permissions.
|
|
33
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
34
|
## Response
|
|
42
35
|
|
|
43
36
|
=== "JSON"
|
|
@@ -130,3 +123,9 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
130
123
|
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
131
124
|
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
132
125
|
```
|
|
126
|
+
|
|
127
|
+
## More information
|
|
128
|
+
|
|
129
|
+
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.
|
|
130
|
+
|
|
131
|
+
[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
|
|
@@ -28,10 +28,6 @@ m365 purview retentionevent list
|
|
|
28
28
|
!!! attention
|
|
29
29
|
This command currently only supports delegated permissions.
|
|
30
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
31
|
## Response
|
|
36
32
|
|
|
37
33
|
|
|
@@ -105,3 +101,7 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
105
101
|
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
106
102
|
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
107
103
|
```
|
|
104
|
+
|
|
105
|
+
## More information
|
|
106
|
+
|
|
107
|
+
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,12 +34,12 @@ m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
|
34
34
|
!!! attention
|
|
35
35
|
This command currently only supports delegated permissions.
|
|
36
36
|
|
|
37
|
+
## Response
|
|
38
|
+
|
|
39
|
+
The command won't return a response on success.
|
|
40
|
+
|
|
37
41
|
## More information
|
|
38
42
|
|
|
39
43
|
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
44
|
|
|
41
45
|
[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.
|
|
@@ -18,14 +18,6 @@ m365 purview retentioneventtype add [options]
|
|
|
18
18
|
|
|
19
19
|
--8<-- "docs/cmd/_global.md"
|
|
20
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
21
|
## Remarks
|
|
30
22
|
|
|
31
23
|
!!! attention
|
|
@@ -34,9 +26,13 @@ m365 purview retentioneventtype add --displayName 'Contract Expiry' --descriptio
|
|
|
34
26
|
!!! attention
|
|
35
27
|
This command currently only supports delegated permissions.
|
|
36
28
|
|
|
37
|
-
##
|
|
29
|
+
## Examples
|
|
38
30
|
|
|
39
|
-
|
|
31
|
+
Create a retention event type *Contract Expiry*.
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
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.'
|
|
35
|
+
```
|
|
40
36
|
|
|
41
37
|
## Response
|
|
42
38
|
|
|
@@ -104,3 +100,7 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
104
100
|
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
105
101
|
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
106
102
|
```
|
|
103
|
+
|
|
104
|
+
## More information
|
|
105
|
+
|
|
106
|
+
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)
|
|
@@ -15,14 +15,6 @@ m365 purview retentioneventtype get [options]
|
|
|
15
15
|
|
|
16
16
|
--8<-- "docs/cmd/_global.md"
|
|
17
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
18
|
## Remarks
|
|
27
19
|
|
|
28
20
|
!!! attention
|
|
@@ -31,11 +23,13 @@ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
|
31
23
|
!!! attention
|
|
32
24
|
This command currently only supports delegated permissions.
|
|
33
25
|
|
|
34
|
-
##
|
|
26
|
+
## Examples
|
|
35
27
|
|
|
36
|
-
|
|
28
|
+
Get a retention event type by id
|
|
37
29
|
|
|
38
|
-
|
|
30
|
+
```sh
|
|
31
|
+
m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
32
|
+
```
|
|
39
33
|
|
|
40
34
|
## Response
|
|
41
35
|
|
|
@@ -101,3 +95,9 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
101
95
|
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
102
96
|
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
103
97
|
```
|
|
98
|
+
|
|
99
|
+
## More information
|
|
100
|
+
|
|
101
|
+
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.
|
|
102
|
+
|
|
103
|
+
[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
|
|
@@ -12,14 +12,6 @@ m365 purview retentioneventtype list [options]
|
|
|
12
12
|
|
|
13
13
|
--8<-- "docs/cmd/_global.md"
|
|
14
14
|
|
|
15
|
-
## Examples
|
|
16
|
-
|
|
17
|
-
Get a list of retention event types
|
|
18
|
-
|
|
19
|
-
```sh
|
|
20
|
-
m365 purview retentioneventtype list
|
|
21
|
-
```
|
|
22
|
-
|
|
23
15
|
## Remarks
|
|
24
16
|
|
|
25
17
|
!!! attention
|
|
@@ -28,9 +20,13 @@ m365 purview retentioneventtype list
|
|
|
28
20
|
!!! attention
|
|
29
21
|
This command currently only supports delegated permissions.
|
|
30
22
|
|
|
31
|
-
##
|
|
23
|
+
## Examples
|
|
32
24
|
|
|
33
|
-
|
|
25
|
+
Get a list of retention event types
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
m365 purview retentioneventtype list
|
|
29
|
+
```
|
|
34
30
|
|
|
35
31
|
## Response
|
|
36
32
|
|
|
@@ -95,3 +91,7 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
95
91
|
createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
|
|
96
92
|
lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
|
|
97
93
|
```
|
|
94
|
+
|
|
95
|
+
## More information
|
|
96
|
+
|
|
97
|
+
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.
|
|
@@ -18,14 +18,6 @@ m365 purview retentioneventtype remove [options]
|
|
|
18
18
|
|
|
19
19
|
--8<-- "docs/cmd/_global.md"
|
|
20
20
|
|
|
21
|
-
## Examples
|
|
22
|
-
|
|
23
|
-
Delete a retention event type by id
|
|
24
|
-
|
|
25
|
-
```sh
|
|
26
|
-
m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
27
|
-
```
|
|
28
|
-
|
|
29
21
|
## Remarks
|
|
30
22
|
|
|
31
23
|
!!! attention
|
|
@@ -34,10 +26,18 @@ m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
|
34
26
|
!!! attention
|
|
35
27
|
This command currently only supports delegated permissions.
|
|
36
28
|
|
|
37
|
-
##
|
|
29
|
+
## Examples
|
|
38
30
|
|
|
39
|
-
|
|
31
|
+
Delete a retention event type by id
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
35
|
+
```
|
|
40
36
|
|
|
41
37
|
## Response
|
|
42
38
|
|
|
43
39
|
The command won't return a response on success.
|
|
40
|
+
|
|
41
|
+
## More information
|
|
42
|
+
|
|
43
|
+
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)
|
|
@@ -18,14 +18,6 @@ m365 purview retentioneventtype set [options]
|
|
|
18
18
|
|
|
19
19
|
--8<-- "docs/cmd/_global.md"
|
|
20
20
|
|
|
21
|
-
## Examples
|
|
22
|
-
|
|
23
|
-
Update the description of a retention event type
|
|
24
|
-
|
|
25
|
-
```sh
|
|
26
|
-
m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
|
|
27
|
-
```
|
|
28
|
-
|
|
29
21
|
## Remarks
|
|
30
22
|
|
|
31
23
|
!!! attention
|
|
@@ -34,10 +26,18 @@ m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --
|
|
|
34
26
|
!!! attention
|
|
35
27
|
This command currently only supports delegated permissions.
|
|
36
28
|
|
|
37
|
-
##
|
|
29
|
+
## Examples
|
|
38
30
|
|
|
39
|
-
|
|
31
|
+
Update the description of a retention event type
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
|
|
35
|
+
```
|
|
40
36
|
|
|
41
37
|
## Response
|
|
42
38
|
|
|
43
39
|
The command won't return a response on success.
|
|
40
|
+
|
|
41
|
+
## More information
|
|
42
|
+
|
|
43
|
+
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)
|
|
@@ -45,6 +45,14 @@ m365 purview retentionlabel add [options]
|
|
|
45
45
|
|
|
46
46
|
--8<-- "docs/cmd/_global.md"
|
|
47
47
|
|
|
48
|
+
## Remarks
|
|
49
|
+
|
|
50
|
+
!!! attention
|
|
51
|
+
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.
|
|
52
|
+
|
|
53
|
+
!!! attention
|
|
54
|
+
This command currently only supports delegated permissions.
|
|
55
|
+
|
|
48
56
|
## Examples
|
|
49
57
|
|
|
50
58
|
Create a retention label that retains documents and deletes them after one year.
|
|
@@ -65,18 +73,6 @@ Create an event-based retention label that retains documents as records and dele
|
|
|
65
73
|
m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365 --retentionTrigger dateOfEvent --eventTypeName "Contract Expiry"
|
|
66
74
|
```
|
|
67
75
|
|
|
68
|
-
## Remarks
|
|
69
|
-
|
|
70
|
-
!!! attention
|
|
71
|
-
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.
|
|
72
|
-
|
|
73
|
-
!!! attention
|
|
74
|
-
This command currently only supports delegated permissions.
|
|
75
|
-
|
|
76
|
-
## More information
|
|
77
|
-
|
|
78
|
-
- Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
|
|
79
|
-
|
|
80
76
|
## Response
|
|
81
77
|
|
|
82
78
|
=== "JSON"
|
|
@@ -141,3 +137,7 @@ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringReten
|
|
|
141
137
|
displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
|
|
142
138
|
some label,Description for admins,Description for users,,dateLabeled,retain,delete,2022-12-21T09:33:32Z,2022-12-21T09:33:32Z,another label,startLocked,cfc8b132-7aef-45f4-9fcf-3c199090ba2a,"{""days"":365}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
|
|
143
139
|
```
|
|
140
|
+
|
|
141
|
+
## More information
|
|
142
|
+
|
|
143
|
+
- Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
|
|
@@ -15,14 +15,6 @@ m365 purview retentionlabel get [options]
|
|
|
15
15
|
|
|
16
16
|
--8<-- "docs/cmd/_global.md"
|
|
17
17
|
|
|
18
|
-
## Examples
|
|
19
|
-
|
|
20
|
-
Get a retention label
|
|
21
|
-
|
|
22
|
-
```sh
|
|
23
|
-
m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
24
|
-
```
|
|
25
|
-
|
|
26
18
|
## Remarks
|
|
27
19
|
|
|
28
20
|
!!! attention
|
|
@@ -31,8 +23,15 @@ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
|
31
23
|
!!! attention
|
|
32
24
|
This command currently only supports delegated permissions.
|
|
33
25
|
|
|
34
|
-
##
|
|
26
|
+
## Examples
|
|
27
|
+
|
|
28
|
+
Get a retention label
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
|
|
32
|
+
```
|
|
35
33
|
|
|
34
|
+
## Response
|
|
36
35
|
|
|
37
36
|
=== "JSON"
|
|
38
37
|
|
|
@@ -12,14 +12,6 @@ m365 purview retentionlabel list [options]
|
|
|
12
12
|
|
|
13
13
|
--8<-- "docs/cmd/_global.md"
|
|
14
14
|
|
|
15
|
-
## Examples
|
|
16
|
-
|
|
17
|
-
Get a list of retention labels
|
|
18
|
-
|
|
19
|
-
```sh
|
|
20
|
-
m365 purview retentionlabel list
|
|
21
|
-
```
|
|
22
|
-
|
|
23
15
|
## Remarks
|
|
24
16
|
|
|
25
17
|
!!! attention
|
|
@@ -28,8 +20,15 @@ m365 purview retentionlabel list
|
|
|
28
20
|
!!! attention
|
|
29
21
|
This command currently only supports delegated permissions.
|
|
30
22
|
|
|
31
|
-
##
|
|
23
|
+
## Examples
|
|
24
|
+
|
|
25
|
+
Get a list of retention labels
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
m365 purview retentionlabel list
|
|
29
|
+
```
|
|
32
30
|
|
|
31
|
+
## Response
|
|
33
32
|
|
|
34
33
|
=== "JSON"
|
|
35
34
|
|
|
@@ -18,14 +18,6 @@ m365 purview retentionlabel remove [options]
|
|
|
18
18
|
|
|
19
19
|
--8<-- "docs/cmd/_global.md"
|
|
20
20
|
|
|
21
|
-
## Examples
|
|
22
|
-
|
|
23
|
-
Delete a retention label
|
|
24
|
-
|
|
25
|
-
```sh
|
|
26
|
-
m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
|
|
27
|
-
```
|
|
28
|
-
|
|
29
21
|
## Remarks
|
|
30
22
|
|
|
31
23
|
!!! attention
|
|
@@ -34,6 +26,14 @@ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
|
|
|
34
26
|
!!! attention
|
|
35
27
|
This command currently only supports delegated permissions.
|
|
36
28
|
|
|
29
|
+
## Examples
|
|
30
|
+
|
|
31
|
+
Delete a retention label
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
|
|
35
|
+
```
|
|
36
|
+
|
|
37
37
|
## Response
|
|
38
38
|
|
|
39
39
|
The command won't return a response on success.
|
|
@@ -39,6 +39,14 @@ m365 purview retentionlabel set [options]
|
|
|
39
39
|
|
|
40
40
|
--8<-- "docs/cmd/_global.md"
|
|
41
41
|
|
|
42
|
+
## Remarks
|
|
43
|
+
|
|
44
|
+
!!! attention
|
|
45
|
+
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.
|
|
46
|
+
|
|
47
|
+
!!! attention
|
|
48
|
+
This command currently only supports delegated permissions.
|
|
49
|
+
|
|
42
50
|
## Examples
|
|
43
51
|
|
|
44
52
|
Update a retention label so that it retains documents as records and deletes them after one year.
|
|
@@ -53,14 +61,6 @@ Update a retention label so that it retains documents as regulatory records and
|
|
|
53
61
|
m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRegulatoryRecord --actionAfterRetentionPeriod startDispositionReview --retentionDuration 365 --retentionTrigger dateModified
|
|
54
62
|
```
|
|
55
63
|
|
|
56
|
-
## Remarks
|
|
57
|
-
|
|
58
|
-
!!! attention
|
|
59
|
-
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.
|
|
60
|
-
|
|
61
|
-
!!! attention
|
|
62
|
-
This command currently only supports delegated permissions.
|
|
63
|
-
|
|
64
64
|
## Response
|
|
65
65
|
|
|
66
66
|
The command won't return a response on success.
|