@pnp/cli-microsoft365 6.3.0-beta.4c3b2c9 → 6.3.0-beta.861847a
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/dist/m365/purview/commands/retentionevent/retentionevent-get.js +76 -0
- package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +47 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +8 -8
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +44 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
- package/dist/m365/purview/commands.js +7 -1
- package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
- package/dist/m365/spo/commands.js +1 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
- package/package.json +1 -1
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# purview retentioneventtype set
|
|
2
|
+
|
|
3
|
+
Update a retention event type
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 purview retentioneventtype set [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --id <id>`
|
|
14
|
+
: The id of the retention event type.
|
|
15
|
+
|
|
16
|
+
`-d, --description [description]`
|
|
17
|
+
: The new description of the event type.
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
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
|
+
## Remarks
|
|
30
|
+
|
|
31
|
+
!!! attention
|
|
32
|
+
This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
|
|
33
|
+
|
|
34
|
+
!!! attention
|
|
35
|
+
This command currently only supports delegated permissions.
|
|
36
|
+
|
|
37
|
+
## More information
|
|
38
|
+
|
|
39
|
+
This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
|
|
40
|
+
|
|
41
|
+
## Response
|
|
42
|
+
|
|
43
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# spo tenant applicationcustomizer add
|
|
2
|
+
|
|
3
|
+
Add an application customizer as a tenant wide extension.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo tenant applicationcustomizer add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-t, --title <title>`
|
|
14
|
+
: The title of the Application Customizer.
|
|
15
|
+
|
|
16
|
+
`-i, --clientSideComponentId <clientSideComponentId>`
|
|
17
|
+
: The Client Side Component Id (GUID) of the application customizer.
|
|
18
|
+
|
|
19
|
+
`-p, --clientSideComponentProperties [clientSideComponentProperties]`
|
|
20
|
+
: The Client Side Component properties of the application customizer.
|
|
21
|
+
|
|
22
|
+
`-w, --webTemplate [webTemplate]`
|
|
23
|
+
: Optionally add a web template (e.g. STS#3, SITEPAGEPUBLISHING#0, etc) as a filter for what kind of sites the application customizer is registered on.
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
!!! important
|
|
28
|
+
To use this command, you need to be a SharePoint Admin.
|
|
29
|
+
|
|
30
|
+
## Remarks
|
|
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 treat quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo tenant applicationcustomizer add --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
|
|
39
|
+
|
|
40
|
+
!!! warning "Escaping JSON in PowerShell"
|
|
41
|
+
When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
|
|
42
|
+
|
|
43
|
+
## Examples
|
|
44
|
+
|
|
45
|
+
Adds an application customizer that's deployed tenant wide
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Adds an application customizer that is configured for all communication sites.
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webTemplate "SITEPAGEPUBLISHING#0"
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Response
|
|
58
|
+
|
|
59
|
+
The command won't return a response on success.
|
package/package.json
CHANGED