@pnp/cli-microsoft365 6.4.0-beta.aacf728 → 6.4.0-beta.dbf1225
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/.devcontainer/Dockerfile +5 -2
- package/.eslintrc.js +3 -0
- package/Dockerfile +6 -3
- package/README.md +12 -1
- package/dist/Auth.js +1 -3
- package/dist/Command.js +1 -0
- package/dist/m365/aad/commands/user/user-get.js +3 -0
- package/dist/m365/aad/commands/user/user-set.js +3 -0
- package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
- package/dist/m365/file/commands/file-list.js +5 -1
- package/dist/m365/flow/commands/owner/owner-ensure.js +147 -0
- package/dist/m365/flow/commands/owner/owner-remove.js +147 -0
- package/dist/m365/flow/commands/run/run-list.js +5 -2
- package/dist/m365/flow/commands.js +2 -0
- package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
- package/dist/m365/planner/commands/roster/roster-member-get.js +98 -0
- package/dist/m365/planner/commands.js +1 -0
- package/dist/m365/purview/commands/retentionevent/retentionevent-add.js +138 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +48 -14
- package/dist/m365/purview/commands.js +1 -0
- package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.0-beta.1.js +59 -0
- package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
- package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
- package/dist/m365/spo/commands/commandset/commandset-add.js +138 -0
- package/dist/m365/spo/commands/commandset/commandset-get.js +128 -0
- package/dist/m365/spo/commands/commandset/commandset-list.js +77 -0
- package/dist/m365/spo/commands/commandset/commandset-remove.js +146 -0
- package/dist/m365/spo/commands/commandset/commandset-set.js +182 -0
- package/dist/m365/spo/commands/customaction/customaction-get.js +27 -7
- package/dist/m365/spo/commands/file/file-move.js +1 -1
- package/dist/m365/spo/commands/group/group-member-add.js +54 -95
- package/dist/m365/spo/commands/list/list-add.js +11 -8
- package/dist/m365/spo/commands/list/list-set.js +3 -3
- package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
- package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
- package/dist/m365/spo/commands/term/term-get.js +68 -48
- package/dist/m365/spo/commands/user/user-ensure.js +105 -0
- package/dist/m365/spo/commands.js +7 -0
- package/dist/m365/todo/commands/task/task-add.js +35 -3
- package/dist/utils/aadGroup.js +18 -0
- package/dist/utils/aadUser.js +37 -0
- package/dist/utils/md.js +7 -0
- package/dist/utils/spo.js +32 -0
- package/docs/docs/cmd/aad/app/app-add.md +3 -3
- package/docs/docs/cmd/aad/approleassignment/approleassignment-add.md +5 -5
- package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +3 -3
- package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
- package/docs/docs/cmd/flow/owner/owner-ensure.md +61 -0
- package/docs/docs/cmd/flow/owner/owner-remove.md +67 -0
- package/docs/docs/cmd/flow/run/run-list.md +28 -0
- package/docs/docs/cmd/onenote/page/page-list.md +1 -1
- package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
- package/docs/docs/cmd/outlook/message/message-get.md +143 -0
- package/docs/docs/cmd/outlook/message/message-list.md +119 -0
- package/docs/docs/cmd/outlook/message/message-move.md +4 -0
- package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
- package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
- package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
- package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
- package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
- package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
- package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
- package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
- package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
- package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
- package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
- package/docs/docs/cmd/outlook/room/room-list.md +81 -0
- package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
- package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
- package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
- package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
- package/docs/docs/cmd/planner/roster/roster-member-get.md +87 -0
- package/docs/docs/cmd/planner/task/task-add.md +230 -0
- package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
- package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
- package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
- package/docs/docs/cmd/planner/task/task-get.md +131 -0
- package/docs/docs/cmd/planner/task/task-list.md +92 -0
- package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
- package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
- package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
- package/docs/docs/cmd/planner/task/task-remove.md +4 -0
- package/docs/docs/cmd/planner/task/task-set.md +230 -0
- package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
- package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
- package/docs/docs/cmd/pp/card/card-get.md +2 -2
- package/docs/docs/cmd/pp/card/card-list.md +2 -2
- package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +149 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -0
- package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
- package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
- package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
- package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
- package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
- package/docs/docs/cmd/spfx/project/project-permissions-grant.md +21 -0
- package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
- package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
- package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
- package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
- package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
- package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
- package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
- package/docs/docs/cmd/spo/commandset/commandset-add.md +159 -0
- package/docs/docs/cmd/spo/commandset/commandset-get.md +149 -0
- package/docs/docs/cmd/spo/commandset/commandset-list.md +109 -0
- package/docs/docs/cmd/spo/commandset/commandset-remove.md +55 -0
- package/docs/docs/cmd/spo/commandset/commandset-set.md +71 -0
- package/docs/docs/cmd/spo/customaction/customaction-get.md +113 -11
- package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
- package/docs/docs/cmd/spo/group/group-member-add.md +26 -4
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
- package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
- package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
- package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
- package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
- package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
- package/docs/docs/cmd/spo/list/list-add.md +2 -2
- package/docs/docs/cmd/spo/list/list-set.md +2 -2
- package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
- package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
- package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
- package/docs/docs/cmd/spo/navigation/navigation-node-add.md +3 -3
- package/docs/docs/cmd/spo/navigation/navigation-node-set.md +2 -2
- package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
- package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
- package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
- package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
- package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
- package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
- package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
- package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
- package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
- package/docs/docs/cmd/spo/site/site-list.md +3 -3
- package/docs/docs/cmd/spo/site/site-remove.md +3 -3
- package/docs/docs/cmd/spo/site/site-rename.md +3 -3
- package/docs/docs/cmd/spo/site/site-set.md +5 -5
- package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
- package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
- package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
- package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
- package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
- package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
- package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
- package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
- package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +28 -26
- package/docs/docs/cmd/spo/term/term-add.md +3 -3
- package/docs/docs/cmd/spo/term/term-get.md +3 -3
- package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
- package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
- package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
- package/docs/docs/cmd/spo/term/term-list.md +3 -1
- package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
- package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
- package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
- package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
- package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
- package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
- package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
- package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
- package/docs/docs/cmd/spo/user/user-ensure.md +109 -0
- package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
- package/docs/docs/cmd/teams/channel/channel-member-add.md +2 -2
- package/docs/docs/cmd/teams/message/message-get.md +39 -4
- package/docs/docs/cmd/teams/message/message-list.md +41 -6
- package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
- package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
- package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
- package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
- package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
- package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
- package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
- package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
- package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
- package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
- package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
- package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
- package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
- package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
- package/docs/docs/cmd/teams/team/team-add.md +77 -8
- package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
- package/docs/docs/cmd/teams/team/team-archive.md +2 -2
- package/docs/docs/cmd/teams/team/team-clone.md +8 -8
- package/docs/docs/cmd/teams/team/team-get.md +34 -4
- package/docs/docs/cmd/teams/team/team-list.md +34 -3
- package/docs/docs/cmd/teams/team/team-remove.md +3 -3
- package/docs/docs/cmd/teams/team/team-set.md +8 -8
- package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
- package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
- package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
- package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
- package/docs/docs/cmd/teams/user/user-list.md +21 -4
- package/docs/docs/cmd/todo/task/task-add.md +47 -2
- package/npm-shrinkwrap.json +277 -192
- package/package.json +14 -13
|
@@ -54,3 +54,58 @@ Enable Microsoft Planner but disallow roster plans to be created
|
|
|
54
54
|
```sh
|
|
55
55
|
m365 planner tenant settings set --isPlannerAllowed true --allowRosterCreation false
|
|
56
56
|
```
|
|
57
|
+
|
|
58
|
+
## Response
|
|
59
|
+
|
|
60
|
+
=== "JSON"
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
{
|
|
64
|
+
"id": "1",
|
|
65
|
+
"isPlannerAllowed": true,
|
|
66
|
+
"allowCalendarSharing": true,
|
|
67
|
+
"allowTenantMoveWithDataLoss": false,
|
|
68
|
+
"allowTenantMoveWithDataMigration": false,
|
|
69
|
+
"allowRosterCreation": true,
|
|
70
|
+
"allowPlannerMobilePushNotifications": true
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
=== "Text"
|
|
75
|
+
|
|
76
|
+
```txt
|
|
77
|
+
allowCalendarSharing : true
|
|
78
|
+
allowPlannerMobilePushNotifications: true
|
|
79
|
+
allowRosterCreation : true
|
|
80
|
+
allowTenantMoveWithDataLoss : false
|
|
81
|
+
allowTenantMoveWithDataMigration : false
|
|
82
|
+
isPlannerAllowed : true
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
=== "CSV"
|
|
86
|
+
|
|
87
|
+
```csv
|
|
88
|
+
isPlannerAllowed,allowCalendarSharing,allowTenantMoveWithDataLoss,allowTenantMoveWithDataMigration,allowRosterCreation,allowPlannerMobilePushNotifications
|
|
89
|
+
1,1,,,1,1
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
=== "Markdown"
|
|
93
|
+
|
|
94
|
+
```md
|
|
95
|
+
# planner tenant settings list
|
|
96
|
+
|
|
97
|
+
Date: 4/2/2023
|
|
98
|
+
|
|
99
|
+
## 1
|
|
100
|
+
|
|
101
|
+
Property | Value
|
|
102
|
+
---------|-------
|
|
103
|
+
id | 1
|
|
104
|
+
isPlannerAllowed | true
|
|
105
|
+
allowCalendarSharing | true
|
|
106
|
+
allowTenantMoveWithDataLoss | false
|
|
107
|
+
allowTenantMoveWithDataMigration | false
|
|
108
|
+
allowRosterCreation | true
|
|
109
|
+
allowPlannerMobilePushNotifications | true
|
|
110
|
+
disallowedSharedWithContainerTypes | []
|
|
111
|
+
```
|
|
@@ -97,7 +97,7 @@ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --
|
|
|
97
97
|
},
|
|
98
98
|
"owninguser":{
|
|
99
99
|
"azureactivedirectoryobjectid":"78637d62-e872-4dc9-b7c1-bd161e631682",
|
|
100
|
-
"fullname":"#
|
|
100
|
+
"fullname":"# John Doe",
|
|
101
101
|
"systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e",
|
|
102
102
|
"ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"
|
|
103
103
|
}
|
|
@@ -167,5 +167,5 @@ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --
|
|
|
167
167
|
publishsourceid | null
|
|
168
168
|
timezoneruleversionnumber | null
|
|
169
169
|
iscustomizable | {"Value":true,"CanBeChanged":true,"ManagedPropertyLogicalName":"iscustomizableanddeletable"}
|
|
170
|
-
owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"#
|
|
170
|
+
owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"# John Doe","systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e","ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"}
|
|
171
171
|
```
|
|
@@ -80,7 +80,7 @@ m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" -
|
|
|
80
80
|
},
|
|
81
81
|
"owninguser":{
|
|
82
82
|
"azureactivedirectoryobjectid":"78637d62-e872-4dc9-b7c1-bd161e631682",
|
|
83
|
-
"fullname":"#
|
|
83
|
+
"fullname":"# John Doe",
|
|
84
84
|
"systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e",
|
|
85
85
|
"ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"
|
|
86
86
|
}
|
|
@@ -149,5 +149,5 @@ m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" -
|
|
|
149
149
|
publishsourceid | null
|
|
150
150
|
timezoneruleversionnumber | null
|
|
151
151
|
iscustomizable | {"Value":true,"CanBeChanged":true,"ManagedPropertyLogicalName":"iscustomizableanddeletable"}
|
|
152
|
-
owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"#
|
|
152
|
+
owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"# John Doe","systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e","ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"}
|
|
153
153
|
```
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# purview retentionevent add
|
|
2
|
+
|
|
3
|
+
Create a retention event
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 purview retentionevent add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-n, --displayName <displayName>`
|
|
14
|
+
: The display name of the event
|
|
15
|
+
|
|
16
|
+
`-e, --eventTypeName [eventTypeName]`
|
|
17
|
+
: Name of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
|
|
18
|
+
|
|
19
|
+
`-i, --eventTypeId [eventTypeId]`
|
|
20
|
+
: Id of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
|
|
21
|
+
|
|
22
|
+
`-d, --description [description]`
|
|
23
|
+
: A description for the event
|
|
24
|
+
|
|
25
|
+
`--triggerDateTime [triggerDateTime]`
|
|
26
|
+
: Optional time when the event should be triggered.
|
|
27
|
+
|
|
28
|
+
`-a, --assetIds [assetIds]`
|
|
29
|
+
: The Asset IDs for items in SharePoint and OneDrive that are related to this event. Only items that have labels associated with the event type you chose will be retained. Specify `assetIds` and/or `keywords`, but at least one.
|
|
30
|
+
|
|
31
|
+
`-k, --keywords [keywords]`
|
|
32
|
+
: The keywords for items in Exchange that are related to this event. Only items that have labels associated with the event type you chose will be retained. Specify `assetIds` and/or `keywords`, but at least one.
|
|
33
|
+
|
|
34
|
+
--8<-- "docs/cmd/_global.md"
|
|
35
|
+
|
|
36
|
+
## Remarks
|
|
37
|
+
|
|
38
|
+
!!! attention
|
|
39
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
40
|
+
|
|
41
|
+
!!! attention
|
|
42
|
+
This command currently only supports delegated permissions.
|
|
43
|
+
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
Create a retention event to start retention at the end of 2022 for all employee documents that have been labeled and have the Asset ID _EmployeeNr1234_
|
|
47
|
+
|
|
48
|
+
```sh
|
|
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
|
+
```
|
|
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
|
+
## Response
|
|
60
|
+
|
|
61
|
+
=== "JSON"
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"displayName": "Event display name",
|
|
66
|
+
"description": "Event description",
|
|
67
|
+
"eventTriggerDateTime": "2023-04-02T15:47:54Z",
|
|
68
|
+
"lastStatusUpdateDateTime": "0001-01-01T00:00:00Z",
|
|
69
|
+
"createdDateTime": "2023-02-20T18:53:05Z",
|
|
70
|
+
"lastModifiedDateTime": "2023-02-20T18:53:05Z",
|
|
71
|
+
"id": "9f5c1a04-8f7a-4bff-e400-08db1373b324",
|
|
72
|
+
"eventQueries": [
|
|
73
|
+
{
|
|
74
|
+
"queryType": "files",
|
|
75
|
+
"query": "filesQuery,filesQuery1"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"queryType": "messages",
|
|
79
|
+
"query": "messagesQuery,messagesQuery1"
|
|
80
|
+
}
|
|
81
|
+
],
|
|
82
|
+
"eventStatus": {
|
|
83
|
+
"error": null,
|
|
84
|
+
"status": "pending"
|
|
85
|
+
},
|
|
86
|
+
"eventPropagationResults": [],
|
|
87
|
+
"createdBy": {
|
|
88
|
+
"user": {
|
|
89
|
+
"id": null,
|
|
90
|
+
"displayName": "John Doe"
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
"lastModifiedBy": {
|
|
94
|
+
"user": {
|
|
95
|
+
"id": null,
|
|
96
|
+
"displayName": "John Doe"
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
=== "Text"
|
|
103
|
+
|
|
104
|
+
```text
|
|
105
|
+
createdBy : {"user":{"id":null,"displayName":"John Doe"}}
|
|
106
|
+
createdDateTime : 2023-02-20T18:53:05Z
|
|
107
|
+
description : Event description
|
|
108
|
+
displayName : Event display name
|
|
109
|
+
eventPropagationResults : []
|
|
110
|
+
eventQueries : [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
|
|
111
|
+
eventStatus : {"error":null,"status":"pending"}
|
|
112
|
+
eventTriggerDateTime : 2023-04-02T15:47:54Z
|
|
113
|
+
id : 9f5c1a04-8f7a-4bff-e400-08db1373b324
|
|
114
|
+
lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
|
|
115
|
+
lastModifiedDateTime : 2023-02-20T18:53:05Z
|
|
116
|
+
lastStatusUpdateDateTime: 0001-01-01T00:00:00Z
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
=== "CSV"
|
|
120
|
+
|
|
121
|
+
```csv
|
|
122
|
+
displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,eventQueries,eventStatus,eventPropagationResults,createdBy,lastModifiedBy
|
|
123
|
+
Event display name,Event description,2023-04-02T15:47:54Z,0001-01-01T00:00:00Z,2023-02-20T18:53:05Z,2023-02-20T18:53:05Z,9f5c1a04-8f7a-4bff-e400-08db1373b324,"[{""queryType"":""files"",""query"":""filesQuery,filesQuery1""},{""queryType"":""messages"",""query"":""messagesQuery,messagesQuery1""}]","{""error"":null,""status"":""pending""}",[],"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
=== "Markdown"
|
|
127
|
+
|
|
128
|
+
```md
|
|
129
|
+
# purview retentionevent add --displayName "Event display name" --eventType "Event Type" --description "Event description" --triggerDateTime "2023-04-02T15:47:54Z" --assetIds "filesQuery,filesQuery1" --keywords "messagesQuery,messagesQuery1"
|
|
130
|
+
|
|
131
|
+
Date: 20/2/2023
|
|
132
|
+
|
|
133
|
+
## Event display name (9f5c1a04-8f7a-4bff-e400-08db1373b324)
|
|
134
|
+
|
|
135
|
+
Property | Value
|
|
136
|
+
---------|-------
|
|
137
|
+
displayName | Event display name
|
|
138
|
+
description | Event description
|
|
139
|
+
eventTriggerDateTime | 2023-04-02T15:47:54Z
|
|
140
|
+
lastStatusUpdateDateTime | 0001-01-01T00:00:00Z
|
|
141
|
+
createdDateTime | 2023-02-20T18:53:05Z
|
|
142
|
+
lastModifiedDateTime | 2023-02-20T18:53:05Z
|
|
143
|
+
id | 9f5c1a04-8f7a-4bff-e400-08db1373b324
|
|
144
|
+
eventQueries | [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
|
|
145
|
+
eventStatus | {"error":null,"status":"pending"}
|
|
146
|
+
eventPropagationResults | []
|
|
147
|
+
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
148
|
+
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
149
|
+
```
|
|
@@ -53,13 +53,13 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
53
53
|
"createdBy": {
|
|
54
54
|
"user": {
|
|
55
55
|
"id": null,
|
|
56
|
-
"displayName": "
|
|
56
|
+
"displayName": "John Doe"
|
|
57
57
|
}
|
|
58
58
|
},
|
|
59
59
|
"lastModifiedBy": {
|
|
60
60
|
"user": {
|
|
61
61
|
"id": null,
|
|
62
|
-
"displayName": "
|
|
62
|
+
"displayName": "John Doe"
|
|
63
63
|
}
|
|
64
64
|
}
|
|
65
65
|
}
|
|
@@ -69,12 +69,12 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
69
69
|
=== "Text"
|
|
70
70
|
|
|
71
71
|
```text
|
|
72
|
-
createdBy : {"user":{"id":null,"displayName":"
|
|
72
|
+
createdBy : {"user":{"id":null,"displayName":"John Doe"}}
|
|
73
73
|
createdDateTime : 2023-01-31T20:40:40Z
|
|
74
74
|
description : A retention event type to start a retention period based on the date that a contract expired.
|
|
75
75
|
displayName : Contract Expiry
|
|
76
76
|
id : 806cb481-4cc6-47c3-af26-26d64f6e7aab
|
|
77
|
-
lastModifiedBy : {"user":{"id":null,"displayName":"
|
|
77
|
+
lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
|
|
78
78
|
lastModifiedDateTime: 2023-01-31T20:40:40Z
|
|
79
79
|
```
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
82
82
|
|
|
83
83
|
```csv
|
|
84
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"":""
|
|
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"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
|
|
86
86
|
```
|
|
87
87
|
|
|
88
88
|
=== "Markdown"
|
|
@@ -101,6 +101,6 @@ This command is part of a series of commands that have to do with event-based re
|
|
|
101
101
|
createdDateTime | 2023-01-31T20:55:35Z
|
|
102
102
|
lastModifiedDateTime | 2023-01-31T20:55:35Z
|
|
103
103
|
id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
|
|
104
|
-
createdBy | {"user":{"id":null,"displayName":"
|
|
105
|
-
lastModifiedBy | {"user":{"id":null,"displayName":"
|
|
104
|
+
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
105
|
+
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
|
|
106
106
|
```
|
|
@@ -37,6 +37,12 @@ m365 purview retentionlabel add [options]
|
|
|
37
37
|
`--labelToBeApplied [labelToBeApplied]`
|
|
38
38
|
: Specifies the replacement label to be applied automatically after the retention period of the current label ends.
|
|
39
39
|
|
|
40
|
+
`--eventTypeId [eventTypeId]`
|
|
41
|
+
: The Id of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
|
|
42
|
+
|
|
43
|
+
`--eventTypeName [eventTypeName]`
|
|
44
|
+
: The display name of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
|
|
45
|
+
|
|
40
46
|
--8<-- "docs/cmd/_global.md"
|
|
41
47
|
|
|
42
48
|
## Examples
|
|
@@ -53,6 +59,12 @@ Create a retention label that retains documents as records and does not take any
|
|
|
53
59
|
m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod none --retentionDuration 365 --retentionTrigger dateModified
|
|
54
60
|
```
|
|
55
61
|
|
|
62
|
+
Create an event-based retention label that retains documents as records and deletes them one year after a _Contract Expiry_ event date.
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365 --retentionTrigger dateOfEvent --eventTypeName "Contract Expiry"
|
|
66
|
+
```
|
|
67
|
+
|
|
56
68
|
## Remarks
|
|
57
69
|
|
|
58
70
|
!!! attention
|
|
@@ -37,3 +37,41 @@ Gets the trends on how many users organized and participated in conference sessi
|
|
|
37
37
|
```sh
|
|
38
38
|
m365 skype report activitycounts --period D7 --output json > "activitycounts.json"
|
|
39
39
|
```
|
|
40
|
+
|
|
41
|
+
## Response
|
|
42
|
+
|
|
43
|
+
=== "JSON"
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
[
|
|
47
|
+
{
|
|
48
|
+
"Report Refresh Date": "2023-01-25",
|
|
49
|
+
"Report Date": "2023-01-19",
|
|
50
|
+
"Report Period": "7",
|
|
51
|
+
"Peer-to-peer": "0",
|
|
52
|
+
"Organized": "0",
|
|
53
|
+
"Participated": "0"
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
=== "Text"
|
|
59
|
+
|
|
60
|
+
```txt
|
|
61
|
+
Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
|
|
62
|
+
2023-01-25,2023-01-19,7,0,0,0
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
=== "CSV"
|
|
66
|
+
|
|
67
|
+
```csv
|
|
68
|
+
Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
|
|
69
|
+
2023-01-25,2023-01-19,7,0,0,0
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
=== "Markdown"
|
|
73
|
+
|
|
74
|
+
```md
|
|
75
|
+
Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
|
|
76
|
+
2023-01-25,2023-01-19,7,0,0,0
|
|
77
|
+
```
|
|
@@ -37,3 +37,41 @@ Gets the trends on how many unique users organized and participated in conferenc
|
|
|
37
37
|
```sh
|
|
38
38
|
m365 skype report activityusercounts --period D7 --output json > "activityusercounts.json"
|
|
39
39
|
```
|
|
40
|
+
|
|
41
|
+
## Response
|
|
42
|
+
|
|
43
|
+
=== "JSON"
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
[
|
|
47
|
+
{
|
|
48
|
+
"Report Refresh Date": "2023-01-25",
|
|
49
|
+
"Report Date": "2023-01-19",
|
|
50
|
+
"Report Period": "7",
|
|
51
|
+
"Peer-to-peer": "0",
|
|
52
|
+
"Organized": "0",
|
|
53
|
+
"Participated": "0"
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
=== "Text"
|
|
59
|
+
|
|
60
|
+
```txt
|
|
61
|
+
Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
|
|
62
|
+
2023-01-25,2023-01-19,7,0,0,0
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
=== "CSV"
|
|
66
|
+
|
|
67
|
+
```csv
|
|
68
|
+
Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
|
|
69
|
+
2023-01-25,2023-01-19,7,0,0,0
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
=== "Markdown"
|
|
73
|
+
|
|
74
|
+
```md
|
|
75
|
+
Report Refresh Date,Report Date,Report Period,Peer-to-peer,Organized,Participated
|
|
76
|
+
2023-01-25,2023-01-19,7,0,0,0
|
|
77
|
+
```
|
|
@@ -46,3 +46,70 @@ Gets details about Skype for Business activity by user for the last week and exp
|
|
|
46
46
|
```sh
|
|
47
47
|
m365 skype report activityuserdetail --period D7 --output json > "activityuserdetail.json"
|
|
48
48
|
```
|
|
49
|
+
|
|
50
|
+
## Response
|
|
51
|
+
|
|
52
|
+
=== "JSON"
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
[
|
|
56
|
+
{
|
|
57
|
+
"Report Refresh Date": "2023-01-25",
|
|
58
|
+
"User Principal Name": "john.doe@contoso.com",
|
|
59
|
+
"Is Deleted": "False",
|
|
60
|
+
"Deleted Date": "",
|
|
61
|
+
"Last Activity Date": "2021-03-22",
|
|
62
|
+
"Total Peer-to-peer Session Count": "0",
|
|
63
|
+
"Total Organized Conference Count": "0",
|
|
64
|
+
"Total Participated Conference Count": "0",
|
|
65
|
+
"Peer-to-peer Last Activity Date": "2021-03-22",
|
|
66
|
+
"Organized Conference Last Activity Date": "2021-02-15",
|
|
67
|
+
"Participated Conference Last Activity Date": "2021-02-15",
|
|
68
|
+
"Peer-to-peer IM Count": "0",
|
|
69
|
+
"Peer-to-peer Audio Count": "0",
|
|
70
|
+
"Peer-to-peer Audio Minutes": "0",
|
|
71
|
+
"Peer-to-peer Video Count": "0",
|
|
72
|
+
"Peer-to-peer Video Minutes": "0",
|
|
73
|
+
"Peer-to-peer App Sharing Count": "0",
|
|
74
|
+
"Peer-to-peer File Transfer Count": "0",
|
|
75
|
+
"Organized Conference IM Count": "0",
|
|
76
|
+
"Organized Conference Audio/Video Count": "0",
|
|
77
|
+
"Organized Conference Audio/Video Minutes": "0",
|
|
78
|
+
"Organized Conference App Sharing Count": "0",
|
|
79
|
+
"Organized Conference Web Count": "0",
|
|
80
|
+
"Organized Conference Dial-in/out 3rd Party Count": "0",
|
|
81
|
+
"Organized Conference Dial-in/out Microsoft Count": "0",
|
|
82
|
+
"Organized Conference Dial-in Microsoft Minutes": "0",
|
|
83
|
+
"Organized Conference Dial-out Microsoft Minutes": "0",
|
|
84
|
+
"Participated Conference IM Count": "0",
|
|
85
|
+
"Participated Conference Audio/Video Count": "0",
|
|
86
|
+
"Participated Conference Audio/Video Minutes": "0",
|
|
87
|
+
"Participated Conference App Sharing Count": "0",
|
|
88
|
+
"Participated Conference Web Count": "0",
|
|
89
|
+
"Participated Conference Dial-in/out 3rd Party Count": "0",
|
|
90
|
+
"Assigned Products": "MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN",
|
|
91
|
+
"Report Period": "7"
|
|
92
|
+
}
|
|
93
|
+
]
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
=== "Text"
|
|
97
|
+
|
|
98
|
+
```txt
|
|
99
|
+
Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Total Peer-to-peer Session Count,Total Organized Conference Count,Total Participated Conference Count,Peer-to-peer Last Activity Date,Organized Conference Last Activity Date,Participated Conference Last Activity Date,Peer-to-peer IM Count,Peer-to-peer Audio Count,Peer-to-peer Audio Minutes,Peer-to-peer Video Count,Peer-to-peer Video Minutes,Peer-to-peer App Sharing Count,Peer-to-peer File Transfer Count,Organized Conference IM Count,Organized Conference Audio/Video Count,Organized Conference Audio/Video Minutes,Organized Conference App Sharing Count,Organized Conference Web Count,Organized Conference Dial-in/out 3rd Party Count,Organized Conference Dial-in/out Microsoft Count,Organized Conference Dial-in Microsoft Minutes,Organized Conference Dial-out Microsoft Minutes,Participated Conference IM Count,Participated Conference Audio/Video Count,Participated Conference Audio/Video Minutes,Participated Conference App Sharing Count,Participated Conference Web Count,Participated Conference Dial-in/out 3rd Party Count,Assigned Products,Report Period
|
|
100
|
+
2023-01-25,john.doe@contoso.com,False,,2021-03-22,0,0,0,2021-03-22,2021-02-15,2021-02-15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN,7
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
=== "CSV"
|
|
104
|
+
|
|
105
|
+
```csv
|
|
106
|
+
Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Total Peer-to-peer Session Count,Total Organized Conference Count,Total Participated Conference Count,Peer-to-peer Last Activity Date,Organized Conference Last Activity Date,Participated Conference Last Activity Date,Peer-to-peer IM Count,Peer-to-peer Audio Count,Peer-to-peer Audio Minutes,Peer-to-peer Video Count,Peer-to-peer Video Minutes,Peer-to-peer App Sharing Count,Peer-to-peer File Transfer Count,Organized Conference IM Count,Organized Conference Audio/Video Count,Organized Conference Audio/Video Minutes,Organized Conference App Sharing Count,Organized Conference Web Count,Organized Conference Dial-in/out 3rd Party Count,Organized Conference Dial-in/out Microsoft Count,Organized Conference Dial-in Microsoft Minutes,Organized Conference Dial-out Microsoft Minutes,Participated Conference IM Count,Participated Conference Audio/Video Count,Participated Conference Audio/Video Minutes,Participated Conference App Sharing Count,Participated Conference Web Count,Participated Conference Dial-in/out 3rd Party Count,Assigned Products,Report Period
|
|
107
|
+
2023-01-25,john.doe@contoso.com,False,,2021-03-22,0,0,0,2021-03-22,2021-02-15,2021-02-15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN,7
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
=== "Markdown"
|
|
111
|
+
|
|
112
|
+
```md
|
|
113
|
+
Report Refresh Date,User Principal Name,Is Deleted,Deleted Date,Last Activity Date,Total Peer-to-peer Session Count,Total Organized Conference Count,Total Participated Conference Count,Peer-to-peer Last Activity Date,Organized Conference Last Activity Date,Participated Conference Last Activity Date,Peer-to-peer IM Count,Peer-to-peer Audio Count,Peer-to-peer Audio Minutes,Peer-to-peer Video Count,Peer-to-peer Video Minutes,Peer-to-peer App Sharing Count,Peer-to-peer File Transfer Count,Organized Conference IM Count,Organized Conference Audio/Video Count,Organized Conference Audio/Video Minutes,Organized Conference App Sharing Count,Organized Conference Web Count,Organized Conference Dial-in/out 3rd Party Count,Organized Conference Dial-in/out Microsoft Count,Organized Conference Dial-in Microsoft Minutes,Organized Conference Dial-out Microsoft Minutes,Participated Conference IM Count,Participated Conference Audio/Video Count,Participated Conference Audio/Video Minutes,Participated Conference App Sharing Count,Participated Conference Web Count,Participated Conference Dial-in/out 3rd Party Count,Assigned Products,Report Period
|
|
114
|
+
2023-01-25,john.doe@contoso.com,False,,2021-03-22,0,0,0,2021-03-22,2021-02-15,2021-02-15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,MICROSOFT 365 E5+MICROSOFT POWER APPS PLAN 2 TRIAL+POWER BI (FREE)+MICROSOFT POWER AUTOMATE FREE+POWER AUTOMATE PER USER PLAN,7
|
|
115
|
+
```
|
|
@@ -28,15 +28,15 @@ m365 spfx project doctor [options]
|
|
|
28
28
|
`--debug`
|
|
29
29
|
: Runs command with debug logging
|
|
30
30
|
|
|
31
|
-
!!! important
|
|
32
|
-
Run this command in the folder where the project that you want to validate is located. This command doesn't change your project files.
|
|
33
|
-
|
|
34
31
|
## Remarks
|
|
35
32
|
|
|
36
33
|
The `spfx project doctor` command helps you validate that your SharePoint Framework project is set up correctly. The command automatically detects the version of your project using version information specified in the project's .yo-rc.json file or package.json (if no version information is included in .yo-rc.json). Based on the detected project version, the command executes several checks and reports any issues in the specified format.
|
|
37
34
|
|
|
38
35
|
This command doesn't change your project files. Instead, it gives you a report with all steps necessary to validate your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
|
|
39
36
|
|
|
37
|
+
!!! important
|
|
38
|
+
Run this command in the folder where the project that you want to validate is located. This command doesn't change your project files.
|
|
39
|
+
|
|
40
40
|
## Examples
|
|
41
41
|
|
|
42
42
|
Validate if your project is correctly set up and save the findings in a Markdown file
|
|
@@ -28,11 +28,11 @@ m365 spfx project externalize [options]
|
|
|
28
28
|
`--debug`
|
|
29
29
|
: Runs command with debug logging
|
|
30
30
|
|
|
31
|
-
!!! important
|
|
32
|
-
Run this command in the folder where the project for which you want to externalize dependencies is located. This command doesn't change your project files.
|
|
33
|
-
|
|
34
31
|
## Remarks
|
|
35
32
|
|
|
33
|
+
!!! important
|
|
34
|
+
Run this command in the folder where the project for which you want to externalize dependencies is located. This command doesn't change your project files.
|
|
35
|
+
|
|
36
36
|
!!! attention
|
|
37
37
|
This command is in preview and could change once it's officially released. If you see any room for improvement, we'd love to hear from you at [https://github.com/pnp/cli-microsoft365/issues](https://github.com/pnp/cli-microsoft365/issues).
|
|
38
38
|
|
|
@@ -63,3 +63,24 @@ m365 spfx project permissions grant
|
|
|
63
63
|
ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
|
|
64
64
|
6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
|
|
65
65
|
```
|
|
66
|
+
|
|
67
|
+
=== "Markdown"
|
|
68
|
+
|
|
69
|
+
```md
|
|
70
|
+
# spfx project permissions grant
|
|
71
|
+
|
|
72
|
+
Date: 2/17/2023
|
|
73
|
+
|
|
74
|
+
## QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
|
|
75
|
+
|
|
76
|
+
Property | Value
|
|
77
|
+
---------|-------
|
|
78
|
+
ClientId | 6004a642-185c-479a-992a-15d1c23e2229
|
|
79
|
+
ConsentType | AllPrincipals
|
|
80
|
+
IsDomainIsolated | false
|
|
81
|
+
ObjectId | QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
|
|
82
|
+
PackageName | null
|
|
83
|
+
Resource | Microsoft Graph
|
|
84
|
+
ResourceId | a46b0017-21e2-4db1-bc69-ca63576a38d6
|
|
85
|
+
Scope | Mail.Read
|
|
86
|
+
```
|
|
@@ -27,15 +27,15 @@ m365 spfx project upgrade [options]
|
|
|
27
27
|
|
|
28
28
|
--8<-- "docs/cmd/_global.md"
|
|
29
29
|
|
|
30
|
-
!!! important
|
|
31
|
-
Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
|
|
32
|
-
|
|
33
30
|
## Remarks
|
|
34
31
|
|
|
35
32
|
The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.1).
|
|
36
33
|
|
|
37
34
|
This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
|
|
38
35
|
|
|
36
|
+
!!! important
|
|
37
|
+
Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
|
|
38
|
+
|
|
39
39
|
## Examples
|
|
40
40
|
|
|
41
41
|
Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and save the findings in a Markdown file
|
|
@@ -31,9 +31,6 @@ m365 spfx doctor [options]
|
|
|
31
31
|
`--debug`
|
|
32
32
|
: Runs command with debug logging
|
|
33
33
|
|
|
34
|
-
!!! important
|
|
35
|
-
Checks ran by this command are based on what is officially supported by Microsoft. It's possible that using different package managers or packages versions will work just fine.
|
|
36
|
-
|
|
37
34
|
## Remarks
|
|
38
35
|
|
|
39
36
|
This commands helps you to verify if your environment meets all prerequisites for building solutions using a particular version of the SharePoint Framework.
|
|
@@ -46,6 +43,9 @@ If you miss any required tools or use a version that doesn't meet the SharePoint
|
|
|
46
43
|
|
|
47
44
|
Next to verifying the readiness of your environment to use a particular version of the SharePoint Framework, you can also check if the version of the SharePoint Framework that you use is compatible with the specific version of SharePoint. Supported versions are `sp2016`, `sp2019` and `spo`.
|
|
48
45
|
|
|
46
|
+
!!! important
|
|
47
|
+
Checks ran by this command are based on what is officially supported by Microsoft. It's possible that using different package managers or packages versions will work just fine.
|
|
48
|
+
|
|
49
49
|
!!! important
|
|
50
50
|
This command supports only text output.
|
|
51
51
|
|
|
@@ -11,26 +11,26 @@ m365 spo cdn get [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-t, --type [type]`
|
|
14
|
-
: Type of CDN to manage. `Public
|
|
14
|
+
: Type of CDN to manage. Allowed values `Public`, `Private`. Default `Public`.
|
|
15
15
|
|
|
16
16
|
--8<-- "docs/cmd/_global.md"
|
|
17
17
|
|
|
18
|
-
!!! important
|
|
19
|
-
To use this command you have to have permissions to access the tenant admin site.
|
|
20
|
-
|
|
21
18
|
## Remarks
|
|
22
19
|
|
|
23
20
|
Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
|
|
24
21
|
|
|
22
|
+
!!! important
|
|
23
|
+
To use this command you have to have permissions to access the tenant admin site.
|
|
24
|
+
|
|
25
25
|
## Examples
|
|
26
26
|
|
|
27
|
-
Show if the Public CDN is currently enabled or not
|
|
27
|
+
Show if the Public CDN is currently enabled or not.
|
|
28
28
|
|
|
29
29
|
```sh
|
|
30
30
|
m365 spo cdn get
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Show if the Private CDN is currently enabled or not
|
|
33
|
+
Show if the Private CDN is currently enabled or not.
|
|
34
34
|
|
|
35
35
|
```sh
|
|
36
36
|
m365 spo cdn get --type Private
|
|
@@ -18,13 +18,13 @@ m365 spo cdn origin add [options]
|
|
|
18
18
|
|
|
19
19
|
--8<-- "docs/cmd/_global.md"
|
|
20
20
|
|
|
21
|
-
!!! important
|
|
22
|
-
To use this command you have to have permissions to access the tenant admin site.
|
|
23
|
-
|
|
24
21
|
## Remarks
|
|
25
22
|
|
|
26
23
|
Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
|
|
27
24
|
|
|
25
|
+
!!! important
|
|
26
|
+
To use this command you have to have permissions to access the tenant admin site.
|
|
27
|
+
|
|
28
28
|
## Examples
|
|
29
29
|
|
|
30
30
|
Add _*/CDN_ to the list of origins of the Public CDN
|
|
@@ -15,13 +15,13 @@ m365 spo cdn origin list [options]
|
|
|
15
15
|
|
|
16
16
|
--8<-- "docs/cmd/_global.md"
|
|
17
17
|
|
|
18
|
-
!!! important
|
|
19
|
-
To use this command you have to have permissions to access the tenant admin site.
|
|
20
|
-
|
|
21
18
|
## Remarks
|
|
22
19
|
|
|
23
20
|
Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
|
|
24
21
|
|
|
22
|
+
!!! important
|
|
23
|
+
To use this command you have to have permissions to access the tenant admin site.
|
|
24
|
+
|
|
25
25
|
## Examples
|
|
26
26
|
|
|
27
27
|
Show the list of origins configured for the Public CDN
|