@pnp/cli-microsoft365 6.8.0-beta.74dea8a → 6.8.0-beta.85a1ca9
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/dist/Command.js +6 -0
- package/dist/chili/chili.js +298 -0
- package/dist/chili/index.js +20 -0
- package/dist/cli/Cli.js +2 -2
- 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 +1 -0
- package/dist/m365/commands/setup.js +180 -0
- package/dist/m365/commands/setupPresets.js +25 -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/listitem/listitem-batch-set.js +308 -0
- package/dist/m365/spo/commands/page/page-section-add.js +2 -3
- 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.js +6 -0
- package/dist/utils/formatting.js +35 -11
- package/dist/utils/pid.js +5 -0
- package/docs/docs/cmd/app/permission/permission-add.md +53 -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/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-remove.md +2 -1
- package/docs/docs/cmd/planner/task/task-set.md +1 -1
- 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/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/folder/folder-copy.md +1 -1
- package/docs/docs/cmd/spo/listitem/listitem-batch-set.md +67 -0
- 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/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/package.json +2 -1
|
@@ -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.
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# setup
|
|
2
|
+
|
|
3
|
+
Sets up CLI for Microsoft 365 based on your preferences
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 setup [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--interactive`
|
|
14
|
+
: Configure CLI for Microsoft 365 for interactive use without prompting for additional information
|
|
15
|
+
|
|
16
|
+
`--scripting`
|
|
17
|
+
: Configure CLI for Microsoft 365 for use in scripts without prompting for additional information
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
The `m365 setup` command is a wizard that helps you configure the CLI for Microsoft 365 for your needs. It will ask you a series of questions and based on your answers, it will configure the CLI for Microsoft 365 for you.
|
|
24
|
+
|
|
25
|
+
The command will ask you the following questions:
|
|
26
|
+
|
|
27
|
+
- _How do you plan to use the CLI?_
|
|
28
|
+
|
|
29
|
+
You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors and show spinners. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
|
|
30
|
+
|
|
31
|
+
- _Are you going to use the CLI in PowerShell?_ (asked only when you chose to configure CLI for scripting)
|
|
32
|
+
|
|
33
|
+
To simplify using CLI in PowerShell, you can configure the CLI to output errors to stdout, instead of the default stderr which is tedious to handle in PowerShell.
|
|
34
|
+
|
|
35
|
+
- _How experienced are you in using the CLI?_
|
|
36
|
+
|
|
37
|
+
You can choose between **beginner** and **proficient**. If you're just starting working with the CLI, it will show you full help information. For more experienced users, it will only show information about commands' options. No matter how you configure this setting, you can always invoke full help by using `--help full`.
|
|
38
|
+
|
|
39
|
+
After you answer these questions, the command will build a preset and ask you to confirm using it to configure the CLI.
|
|
40
|
+
|
|
41
|
+
If you want to configure the CLI on a non-interactive system, or want to configure CLI without answering the questions, you can use the `--interactive` or `--scripting` options. When using these options, CLI will apply the correct presets. Additionally, it will detect if it's used in PowerShell and configure CLI accordingly.
|
|
42
|
+
|
|
43
|
+
The `m365 setup` command uses the following presets:
|
|
44
|
+
|
|
45
|
+
- interactive use:
|
|
46
|
+
- autoOpenLinksInBrowser: true,
|
|
47
|
+
- copyDeviceCodeToClipboard: true,
|
|
48
|
+
- output: 'text',
|
|
49
|
+
- printErrorsAsPlainText: true,
|
|
50
|
+
- prompt: true,
|
|
51
|
+
- showHelpOnFailure: true,
|
|
52
|
+
- showSpinner: true
|
|
53
|
+
- scripting use:
|
|
54
|
+
- autoOpenLinksInBrowser: false,
|
|
55
|
+
- copyDeviceCodeToClipboard: false,
|
|
56
|
+
- output: 'json',
|
|
57
|
+
- printErrorsAsPlainText: false,
|
|
58
|
+
- prompt: false,
|
|
59
|
+
- showHelpOnFailure: false,
|
|
60
|
+
- showSpinner: false
|
|
61
|
+
- use in PowerShell:
|
|
62
|
+
- errorOutput: 'stdout'
|
|
63
|
+
- beginner:
|
|
64
|
+
- helpMode: 'full'
|
|
65
|
+
- proficient:
|
|
66
|
+
- helpMode: 'options'
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
Configure CLI for Microsoft based on your preferences interactively
|
|
71
|
+
|
|
72
|
+
```sh
|
|
73
|
+
m365 setup
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Configure CLI for Microsoft for interactive use without prompting for additional information
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
m365 setup --interactive
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Configure CLI for Microsoft for use in scripts without prompting for additional information
|
|
83
|
+
|
|
84
|
+
```sh
|
|
85
|
+
m365 setup --scripting
|
|
86
|
+
```
|
|
@@ -29,7 +29,7 @@ m365 spo applicationcustomizer add [options]
|
|
|
29
29
|
|
|
30
30
|
## Remarks
|
|
31
31
|
|
|
32
|
-
Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell
|
|
32
|
+
Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
|
|
33
33
|
|
|
34
34
|
```sh
|
|
35
35
|
m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# spo applicationcustomizer remove
|
|
2
|
+
|
|
3
|
+
Removes an application customizer that is added to a site
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo applicationcustomizer remove [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The url of the site.
|
|
15
|
+
|
|
16
|
+
`-t, --title [title]`
|
|
17
|
+
: The title of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.
|
|
18
|
+
|
|
19
|
+
`-i, --id [id]`
|
|
20
|
+
: The id of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.
|
|
21
|
+
|
|
22
|
+
`-c, --clientSideComponentId [clientSideComponentId]`
|
|
23
|
+
: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id` or `clientSideComponentId`.
|
|
24
|
+
|
|
25
|
+
`-s, --scope [scope]`
|
|
26
|
+
: Scope of the application customizer. Allowed values: `Site`, `Web`, and `All`. Defaults to `All`.
|
|
27
|
+
|
|
28
|
+
`--confirm`
|
|
29
|
+
: Don't prompt for confirming removal of the application customizer.
|
|
30
|
+
|
|
31
|
+
--8<-- "docs/cmd/_global.md"
|
|
32
|
+
|
|
33
|
+
## Remarks
|
|
34
|
+
|
|
35
|
+
If the command finds multiple application customizers with the specified title or clientSideComponentId, it will prompt you to disambiguate which customizer it should remove, listing the discovered IDs.
|
|
36
|
+
|
|
37
|
+
## Examples
|
|
38
|
+
|
|
39
|
+
Remove an application customizer by id
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Remove an application customizer by title
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
m365 spo applicationcustomizer remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Remove an application customizer by clientSideComponentId
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
m365 spo applicationcustomizer remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Remove an application customizer by its id without prompting for confirmation
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Remove an application customizer from a site collection by its id without prompting for confirmation
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm --scope Site
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Remove an application customizer from a site by its id without prompting for confirmation
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm --scope Web
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Response
|
|
76
|
+
|
|
77
|
+
The command won't return a response on success.
|
|
@@ -41,7 +41,7 @@ m365 spo commandset set [options]
|
|
|
41
41
|
|
|
42
42
|
## Remarks
|
|
43
43
|
|
|
44
|
-
Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell
|
|
44
|
+
Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how a ListView Command Set can be created from the Windows cmd.exe:
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
47
|
m365 spo commandset set --webUrl https://contoso.sharepoint.com/sites/test --title "CLI Commandset" --location "Both" --listType "List" --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# spo contenttype set
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Updates an existing content type
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
@@ -16,7 +16,7 @@ m365 spo contenttype set [options]
|
|
|
16
16
|
`-i, --id [id]`
|
|
17
17
|
: ID of the content type to update. Specify `id` or `name` but not both, one is required.
|
|
18
18
|
|
|
19
|
-
`-n, name [name]`
|
|
19
|
+
`-n, --name [name]`
|
|
20
20
|
: Name of the content type to update. Specify the `id` or the `name` but not both, one is required.
|
|
21
21
|
|
|
22
22
|
`--listTitle [listTitle]`
|
|
@@ -68,7 +68,7 @@ m365 spo customaction add [options]
|
|
|
68
68
|
|
|
69
69
|
## Remarks
|
|
70
70
|
|
|
71
|
-
Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell
|
|
71
|
+
Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
|
|
72
72
|
|
|
73
73
|
```sh
|
|
74
74
|
m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|