@pnp/cli-microsoft365 6.9.0-beta.91abae4 → 6.9.0-beta.eff4ea7
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/cli/Cli.js +16 -0
- package/dist/m365/cli/commands/config/config-set.js +1 -0
- package/dist/m365/planner/commands/bucket/bucket-add.js +15 -13
- package/dist/m365/planner/commands/bucket/bucket-get.js +27 -28
- package/dist/m365/planner/commands/bucket/bucket-list.js +15 -13
- package/dist/m365/planner/commands/bucket/bucket-remove.js +33 -34
- package/dist/m365/planner/commands/bucket/bucket-set.js +33 -34
- package/dist/m365/planner/commands/plan/plan-add.js +49 -52
- package/dist/m365/planner/commands/plan/plan-set.js +19 -20
- package/dist/m365/planner/commands/task/task-add.js +75 -78
- package/dist/m365/planner/commands/task/task-checklistitem-add.js +11 -10
- package/dist/m365/planner/commands/task/task-checklistitem-remove.js +10 -8
- package/dist/m365/planner/commands/task/task-get.js +53 -56
- package/dist/m365/planner/commands/task/task-list.js +23 -24
- package/dist/m365/planner/commands/task/task-reference-add.js +11 -10
- package/dist/m365/planner/commands/task/task-reference-remove.js +13 -14
- package/dist/m365/planner/commands/task/task-remove.js +44 -48
- package/dist/m365/planner/commands/task/task-set.js +83 -87
- package/dist/m365/pp/commands/card/card-get.js +6 -1
- package/dist/m365/purview/commands/retentionevent/retentionevent-add.js +0 -5
- package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +0 -5
- package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +0 -5
- package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +0 -5
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +0 -5
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +0 -5
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +0 -5
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +0 -5
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +0 -5
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +0 -5
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +0 -5
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +0 -5
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +19 -22
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +0 -5
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-set.js +154 -0
- package/dist/m365/spo/commands/commandset/commandset-set.js +11 -2
- package/dist/m365/spo/commands/list/list-sensitivitylabel-ensure.js +127 -0
- package/dist/m365/spo/commands/navigation/navigation-node-add.js +31 -1
- package/dist/m365/spo/commands/navigation/navigation-node-set.js +31 -2
- package/dist/m365/spo/commands/tenant/Solution.js +3 -0
- package/dist/m365/spo/commands/tenant/tenant-commandset-add.js +215 -0
- package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +114 -0
- package/dist/m365/spo/commands/tenant/tenant-commandset-list.js +50 -0
- package/dist/m365/spo/commands/tenant/tenant-commandset-set.js +1 -1
- package/dist/m365/spo/commands.js +5 -0
- package/dist/settingsNames.js +1 -0
- package/dist/utils/spo.js +60 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +0 -6
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +0 -6
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +0 -7
- package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.mdx +0 -6
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +0 -6
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +0 -6
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +0 -6
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.mdx +0 -6
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.mdx +0 -6
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.mdx +0 -6
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.mdx +0 -6
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.mdx +0 -6
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.mdx +0 -6
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.mdx +0 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +72 -0
- package/docs/docs/cmd/spo/commandset/commandset-set.mdx +12 -3
- package/docs/docs/cmd/spo/list/list-sensitivitylabel-ensure.mdx +64 -0
- package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +7 -4
- package/docs/docs/cmd/spo/navigation/navigation-node-set.mdx +9 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +183 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +155 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +114 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +1 -1
- package/package.json +1 -1
|
@@ -51,12 +51,6 @@ This command is based on a Microsoft Graph API that is currently in preview and
|
|
|
51
51
|
|
|
52
52
|
:::
|
|
53
53
|
|
|
54
|
-
:::caution
|
|
55
|
-
|
|
56
|
-
This command currently only supports delegated permissions.
|
|
57
|
-
|
|
58
|
-
:::
|
|
59
|
-
|
|
60
54
|
## Examples
|
|
61
55
|
|
|
62
56
|
Update a retention label so that it retains documents as records and deletes them after one year.
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# spo applicationcustomizer set
|
|
4
|
+
|
|
5
|
+
Updates an existing Application Customizer on a site
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 spo applicationcustomizer set [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
|
|
15
|
+
```md definition-list
|
|
16
|
+
`-u, --webUrl <webUrl>`
|
|
17
|
+
: The site to update the Application Customizer on.
|
|
18
|
+
|
|
19
|
+
`-t, --title [title]`
|
|
20
|
+
: The title of the Application Customizer to update. Specify either `title`, `id` or `clientSideComponentId`.
|
|
21
|
+
|
|
22
|
+
`-i, --id [id]`
|
|
23
|
+
: The id of the Application Customizer to update. Specify either `title`, `id` or `clientSideComponentId`.
|
|
24
|
+
|
|
25
|
+
`-c, --clientSideComponentId [clientSideComponentId]`
|
|
26
|
+
: The Client Side Component Id (GUID) of the Application Customizer to update. Specify either `title`, `id` or `clientSideComponentId`.
|
|
27
|
+
|
|
28
|
+
`--newTitle [newTitle]`
|
|
29
|
+
: The new title of the Application Customizer.
|
|
30
|
+
|
|
31
|
+
`-p, --clientSideComponentProperties [clientSideComponentProperties]`
|
|
32
|
+
: The Client Side Component properties of the Application Customizer.
|
|
33
|
+
|
|
34
|
+
`-s, --scope [scope]`
|
|
35
|
+
: The scope where to lookup the Application Customizer. Allowed values: `Site`, `Web`, and `All`. Defaults to `All`.
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
<Global />
|
|
39
|
+
|
|
40
|
+
## Remarks
|
|
41
|
+
|
|
42
|
+
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 clientSideComponentProperties option that has JSON value because the command shell treats quotes differently. For example, this is how Application Customizer can be updated from the Windows cmd.exe:
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
m365 spo applicationcustomizer set --webUrl https://contoso.sharepoint.com/sites/sales --id b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --newTitle "Some customizer" --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
|
|
49
|
+
|
|
50
|
+
:::caution Escaping JSON in PowerShell
|
|
51
|
+
|
|
52
|
+
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.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
|
|
53
|
+
|
|
54
|
+
:::
|
|
55
|
+
|
|
56
|
+
## Examples
|
|
57
|
+
|
|
58
|
+
Updates the title of an application customizer on the sales site
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
m365 spo applicationcustomizer set --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --newTitle "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Updates the properties of an application customizer on the sales site
|
|
65
|
+
|
|
66
|
+
```sh
|
|
67
|
+
m365 spo applicationcustomizer set --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{ "testMessage": "Test message" }' --webUrl https://contoso.sharepoint.com/sites/sales
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Response
|
|
71
|
+
|
|
72
|
+
The command won't return a response on success.
|
|
@@ -22,16 +22,19 @@ m365 spo commandset set [options]
|
|
|
22
22
|
`-i, --id [id]`
|
|
23
23
|
: The id of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
|
|
24
24
|
|
|
25
|
-
`-c, --clientSideComponentId
|
|
25
|
+
`-c, --clientSideComponentId [clientSideComponentId]`
|
|
26
26
|
: The Client Side Component Id (GUID) of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
|
|
27
27
|
|
|
28
|
+
`--newClientSideComponentId [newClientSideComponentId]`
|
|
29
|
+
: The new Client Side Component Id (GUID) of the ListView Command Set.
|
|
30
|
+
|
|
28
31
|
`--newTitle [newTitle]`
|
|
29
32
|
: The new title of the ListView Command Set.
|
|
30
33
|
|
|
31
34
|
`-l, --listType [listType]`
|
|
32
35
|
: The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`.
|
|
33
36
|
|
|
34
|
-
`--clientSideComponentProperties
|
|
37
|
+
`--clientSideComponentProperties [clientSideComponentProperties]`
|
|
35
38
|
: The Client Side Component properties of the ListView Command Set.
|
|
36
39
|
|
|
37
40
|
`-s, --scope [scope]`
|
|
@@ -64,7 +67,7 @@ When using the `--clientSideComponentProperties` option it's possible to enter a
|
|
|
64
67
|
Updates the title and location of a ListView Command Set on the sales site.
|
|
65
68
|
|
|
66
69
|
```sh
|
|
67
|
-
m365 spo commandset
|
|
70
|
+
m365 spo commandset set --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --newTitle "Some new title" --location Both --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
|
|
68
71
|
```
|
|
69
72
|
|
|
70
73
|
Updates a ListView Command Set on the sales site with some properties.
|
|
@@ -73,6 +76,12 @@ Updates a ListView Command Set on the sales site with some properties.
|
|
|
73
76
|
m365 spo commandset set --title "Some customizer" --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
|
|
74
77
|
```
|
|
75
78
|
|
|
79
|
+
Updates the Client Side Component Id of a ListView Command Set.
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
m365 spo commandset set --title "Some customizer" --newClientSideComponentId b2c5faf3-638f-44ae-bfde-1730d94283bf --webUrl https://contoso.sharepoint.com/sites/sales
|
|
83
|
+
```
|
|
84
|
+
|
|
76
85
|
## Response
|
|
77
86
|
|
|
78
87
|
The command won't return a response on success.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# spo list sensitivitylabel ensure
|
|
4
|
+
|
|
5
|
+
Applies a default sensitivity label to the specified document library
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 spo list sensitivitylabel ensure [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
|
|
15
|
+
```md definition-list
|
|
16
|
+
`-u, --webUrl <webUrl>`
|
|
17
|
+
: The URL of the site where the library is located.
|
|
18
|
+
|
|
19
|
+
`-n, --name <name>`
|
|
20
|
+
: The name of the label.
|
|
21
|
+
|
|
22
|
+
`-t, --listTitle [listTitle]`
|
|
23
|
+
: The title of the library on which to apply the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
|
|
24
|
+
|
|
25
|
+
`-l, --listId [listId]`
|
|
26
|
+
: The ID of the library on which to apply the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
|
|
27
|
+
|
|
28
|
+
`--listUrl [listUrl]`
|
|
29
|
+
: Server- or web-relative URL of the library on which to apply the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
<Global />
|
|
33
|
+
|
|
34
|
+
## Remarks
|
|
35
|
+
|
|
36
|
+
:::caution
|
|
37
|
+
|
|
38
|
+
This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
|
|
39
|
+
|
|
40
|
+
:::
|
|
41
|
+
|
|
42
|
+
## Examples
|
|
43
|
+
|
|
44
|
+
Applies a sensitivity label to a document library based on the list title.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo list sensitivitylabel ensure --webUrl 'https://contoso.sharepoint.com' --listTitle 'Shared Documents' --name 'Confidential'
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Applies a sensitivity label to a document library based on the list url.
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
m365 spo list sensitivitylabel ensure --webUrl 'https://contoso.sharepoint.com' --listUrl '/Shared Documents' --name 'Confidential'
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Applies a sensitivity label to a document library based on the list id.
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
m365 spo list sensitivitylabel ensure --webUrl 'https://contoso.sharepoint.com' --listId 'b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7' --name 'Confidential'
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Response
|
|
63
|
+
|
|
64
|
+
The command won't return a response on success.
|
|
@@ -35,6 +35,9 @@ m365 spo navigation node add [options]
|
|
|
35
35
|
|
|
36
36
|
`--audienceIds [audienceIds]`
|
|
37
37
|
: Comma-separated list of group IDs that will be used for audience targeting. The limit is 10 ids per navigation node.
|
|
38
|
+
|
|
39
|
+
`--openInNewWindow`
|
|
40
|
+
: Set, if the link has to be opened in a new window.
|
|
38
41
|
```
|
|
39
42
|
|
|
40
43
|
<Global />
|
|
@@ -57,16 +60,16 @@ Add a navigation node pointing to an external page to the quick launch
|
|
|
57
60
|
m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --location QuickLaunch --title "About us" --url https://contoso.com/about-us --isExternal
|
|
58
61
|
```
|
|
59
62
|
|
|
60
|
-
Add a navigation node below an existing node
|
|
63
|
+
Add a navigation node below an existing node and opens it in a new window
|
|
61
64
|
|
|
62
65
|
```sh
|
|
63
|
-
m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --parentNodeId 2010 --title About --url /sites/team-s/sitepages/about.aspx
|
|
66
|
+
m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --parentNodeId 2010 --title About --url /sites/team-s/sitepages/about.aspx --openInNewWindow
|
|
64
67
|
```
|
|
65
68
|
|
|
66
|
-
Add a navigation node to the top navigation which is audience targetted
|
|
69
|
+
Add a navigation node to the top navigation which is audience targetted and open it in a new window
|
|
67
70
|
|
|
68
71
|
```sh
|
|
69
|
-
m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --location TopNavigationBar --title About --url /sites/team-s/sitepages/about.aspx --audienceIds "7aa4a1ca-4035-4f2f-bac7-7beada59b5ba,4bbf236f-a131-4019-b4a2-315902fcfa3a"
|
|
72
|
+
m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --location TopNavigationBar --title About --url /sites/team-s/sitepages/about.aspx --audienceIds "7aa4a1ca-4035-4f2f-bac7-7beada59b5ba,4bbf236f-a131-4019-b4a2-315902fcfa3a" --openInNewWindow
|
|
70
73
|
```
|
|
71
74
|
|
|
72
75
|
## Response
|
|
@@ -30,6 +30,9 @@ m365 spo navigation node set [options]
|
|
|
30
30
|
|
|
31
31
|
`--isExternal [isExternal]`
|
|
32
32
|
: Whether the navigation node points to an external URL. Valid values: `true` or `false`.
|
|
33
|
+
|
|
34
|
+
`--openInNewWindow [openInNewWindow]`
|
|
35
|
+
: Open the URL in a new window. Valid values: `true` or `false`.
|
|
33
36
|
```
|
|
34
37
|
|
|
35
38
|
<Global />
|
|
@@ -58,6 +61,12 @@ Updates audience targeting of a navigation node with 3 groups
|
|
|
58
61
|
m365 spo navigation node set --webUrl https://contoso.sharepoint.com/sites/marketing --id 2209 --audienceIds "61f78c73-f71a-471e-a3b9-15daa936e200,9524e6b4-e663-44fe-b179-210c963e37e7,c42b8756-494d-4141-a575-45f01320e26a"
|
|
59
62
|
```
|
|
60
63
|
|
|
64
|
+
Updates the navigation node so that it opens in a new window
|
|
65
|
+
|
|
66
|
+
```sh
|
|
67
|
+
m365 spo navigation node set --webUrl https://contoso.sharepoint.com/sites/marketing --id 2209 --openInNewWindow true
|
|
68
|
+
```
|
|
69
|
+
|
|
61
70
|
## Response
|
|
62
71
|
|
|
63
72
|
The command won't return a response on success.
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# spo tenant commandset add
|
|
6
|
+
|
|
7
|
+
Add a ListView Command Set as a tenant-wide extension.
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 spo tenant commandset add [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md defintion-list
|
|
18
|
+
`-t, --title <title>`
|
|
19
|
+
: The title of the ListView Command Set.
|
|
20
|
+
|
|
21
|
+
`-l, --listType <listType>`
|
|
22
|
+
: The list or library type to register the ListView Command Set on. Allowed values `List` or `Library`.
|
|
23
|
+
|
|
24
|
+
`-i, --clientSideComponentId <clientSideComponentId>`
|
|
25
|
+
: The Client Side Component Id (GUID) of the ListView Command Set.
|
|
26
|
+
|
|
27
|
+
`-p, --clientSideComponentProperties [clientSideComponentProperties]`
|
|
28
|
+
: The Client Side Component properties of the ListView Command Set.
|
|
29
|
+
|
|
30
|
+
`-w, --webTemplate [webTemplate]`
|
|
31
|
+
: Optionally add a web template (e.g. STS#3, SITEPAGEPUBLISHING#0, etc) as a filter for what kind of sites the ListView Command Set is registered on.
|
|
32
|
+
|
|
33
|
+
`--location [location]`
|
|
34
|
+
: The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`. Defaults to `CommandBar`.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
<Global />
|
|
38
|
+
|
|
39
|
+
## Remarks
|
|
40
|
+
|
|
41
|
+
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 commandset user custom action can be created from the Windows cmd.exe:
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo tenant commandset add --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
|
|
48
|
+
|
|
49
|
+
:::caution Escaping JSON in PowerShell
|
|
50
|
+
|
|
51
|
+
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.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
|
|
52
|
+
|
|
53
|
+
:::
|
|
54
|
+
|
|
55
|
+
:::info
|
|
56
|
+
|
|
57
|
+
To use this command, you need to be a SharePoint Admin.
|
|
58
|
+
|
|
59
|
+
:::
|
|
60
|
+
|
|
61
|
+
## Examples
|
|
62
|
+
|
|
63
|
+
Adds a ListView Command Set that's deployed tenant wide to CommandBars of Lists.
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
m365 spo tenant commandset add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --listType List
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Adds a ListView Command Set that is configured to the context menu of communication site libraries.
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
m365 spo tenant commandset add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webTemplate "SITEPAGEPUBLISHING#0" --listType Library --location ContextMenu
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Response
|
|
76
|
+
|
|
77
|
+
<Tabs>
|
|
78
|
+
<TabItem value="JSON">
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"FileSystemObjectType": 0,
|
|
83
|
+
"Id": 4,
|
|
84
|
+
"ServerRedirectedEmbedUri": null,
|
|
85
|
+
"ServerRedirectedEmbedUrl": "",
|
|
86
|
+
"ID": 4,
|
|
87
|
+
"ContentTypeId": "0x00693E2C487575B448BD420C12CEAE7EFE",
|
|
88
|
+
"Title": "Some ListView Command Set",
|
|
89
|
+
"Modified": "2023-01-11T15:47:38Z",
|
|
90
|
+
"Created": "2023-01-11T15:47:38Z",
|
|
91
|
+
"AuthorId": 9,
|
|
92
|
+
"EditorId": 9,
|
|
93
|
+
"OData__UIVersionString": "1.0",
|
|
94
|
+
"Attachments": false,
|
|
95
|
+
"GUID": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
|
|
96
|
+
"ComplianceAssetId": null,
|
|
97
|
+
"TenantWideExtensionComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
|
|
98
|
+
"TenantWideExtensionComponentProperties": "{\"testMessage\":\"Test message\"}",
|
|
99
|
+
"TenantWideExtensionWebTemplate": null,
|
|
100
|
+
"TenantWideExtensionListTemplate": 101,
|
|
101
|
+
"TenantWideExtensionLocation": "ClientSideExtension.ListViewCommandSet.ContextMenu",
|
|
102
|
+
"TenantWideExtensionSequence": 0,
|
|
103
|
+
"TenantWideExtensionHostProperties": null,
|
|
104
|
+
"TenantWideExtensionDisabled": false
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
</TabItem>
|
|
109
|
+
<TabItem value="Text">
|
|
110
|
+
|
|
111
|
+
```text
|
|
112
|
+
Attachments : false
|
|
113
|
+
AuthorId : 9
|
|
114
|
+
ComplianceAssetId : null
|
|
115
|
+
ContentTypeId : 0x00693E2C487575B448BD420C12CEAE7EFE
|
|
116
|
+
Created : 2023-01-11T15:47:38Z
|
|
117
|
+
EditorId : 9
|
|
118
|
+
FileSystemObjectType : 0
|
|
119
|
+
GUID : 14125658-a9bc-4ddf-9c75-1b5767c9a337
|
|
120
|
+
Id : 4
|
|
121
|
+
ID : 4
|
|
122
|
+
Modified : 2023-01-11T15:47:38Z
|
|
123
|
+
OData__UIVersionString : 1.0
|
|
124
|
+
ServerRedirectedEmbedUri : null
|
|
125
|
+
ServerRedirectedEmbedUrl :
|
|
126
|
+
TenantWideExtensionComponentId : 7096cded-b83d-4eab-96f0-df477ed7c0bc
|
|
127
|
+
TenantWideExtensionComponentProperties: {"testMessage":"Test message"}
|
|
128
|
+
TenantWideExtensionDisabled : false
|
|
129
|
+
TenantWideExtensionHostProperties : null
|
|
130
|
+
TenantWideExtensionListTemplate : 101
|
|
131
|
+
TenantWideExtensionLocation : ClientSideExtension.ListViewCommandSet.ContextMenu
|
|
132
|
+
TenantWideExtensionSequence : 0
|
|
133
|
+
TenantWideExtensionWebTemplate : null
|
|
134
|
+
Title : Some ListView Command Set
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
</TabItem>
|
|
138
|
+
<TabItem value="CSV">
|
|
139
|
+
|
|
140
|
+
```csv
|
|
141
|
+
FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ID,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,TenantWideExtensionComponentId,TenantWideExtensionComponentProperties,TenantWideExtensionWebTemplate,TenantWideExtensionListTemplate,TenantWideExtensionLocation,TenantWideExtensionSequence,TenantWideExtensionHostProperties,TenantWideExtensionDisabled
|
|
142
|
+
0,4,,,4,0x00693E2C487575B448BD420C12CEAE7EFE,Some ListView Command Set,2023-01-11T15:47:38Z,2023-01-11T15:47:38Z,9,9,1.0,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,7096cded-b83d-4eab-96f0-df477ed7c0bc,"{""testMessage"":""Test message""}",,101,ClientSideExtension.ListViewCommandSet.ContextMenu,0,,
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
</TabItem>
|
|
146
|
+
<TabItem value="Markdown">
|
|
147
|
+
|
|
148
|
+
```md
|
|
149
|
+
# spo listitem add --webUrl "https://contoso.sharepoint.com/sites/appcatalog" --listUrl "/sites/appcatalog/Lists/TenantWideExtensions" --Title "Some ListView Command Set" --TenantWideExtensionComponentId "7096cded-b83d-4eab-96f0-df477ed7c0bc" --TenantWideExtensionLocation "ClientSideExtension.ListViewCommandSet.ContextMenu" --TenantWideExtensionSequence "0" --TenantWideExtensionListTemplate "101" --TenantWideExtensionComponentProperties "{"testMessage":"Test message"}" --TenantWideExtensionWebTemplate "" --TenantWideExtensionDisabled "false" --verbose "false" --debug "false" --_ ""
|
|
150
|
+
|
|
151
|
+
Date: 1/13/2023
|
|
152
|
+
|
|
153
|
+
## Some ListView Command Set (4)
|
|
154
|
+
|
|
155
|
+
Property | Value
|
|
156
|
+
---------|-------
|
|
157
|
+
FileSystemObjectType | 0
|
|
158
|
+
Id | 4
|
|
159
|
+
ServerRedirectedEmbedUri | null
|
|
160
|
+
ServerRedirectedEmbedUrl |
|
|
161
|
+
ID | 4
|
|
162
|
+
ContentTypeId | 0x00693E2C487575B448BD420C12CEAE7EFE
|
|
163
|
+
Title | Some customizer
|
|
164
|
+
Modified | 2023-01-11T15:47:38Z
|
|
165
|
+
Created | 2023-01-11T15:47:38Z
|
|
166
|
+
AuthorId | 9
|
|
167
|
+
EditorId | 9
|
|
168
|
+
OData\_\_UIVersionString | 1.0
|
|
169
|
+
Attachments | false
|
|
170
|
+
GUID | 14125658-a9bc-4ddf-9c75-1b5767c9a337
|
|
171
|
+
ComplianceAssetId | null
|
|
172
|
+
TenantWideExtensionComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
|
|
173
|
+
TenantWideExtensionComponentProperties | {"testMessage":"Test message"}
|
|
174
|
+
TenantWideExtensionWebTemplate | null
|
|
175
|
+
TenantWideExtensionListTemplate | 101
|
|
176
|
+
TenantWideExtensionLocation | ClientSideExtension.ListViewCommandSet.ContextMenu
|
|
177
|
+
TenantWideExtensionSequence | 0
|
|
178
|
+
TenantWideExtensionHostProperties | null
|
|
179
|
+
TenantWideExtensionDisabled | false
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
</TabItem>
|
|
183
|
+
</Tabs>
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# spo tenant commandset get
|
|
6
|
+
|
|
7
|
+
Get a ListView Command Set that is installed tenant wide
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
spo tenant commandset get [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md defintion-list
|
|
18
|
+
`-t, --title [title]`
|
|
19
|
+
: The title of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.
|
|
20
|
+
|
|
21
|
+
`-i, --id [id]`
|
|
22
|
+
: The id of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.
|
|
23
|
+
|
|
24
|
+
`-c, --clientSideComponentId [clientSideComponentId]`
|
|
25
|
+
: The Client Side Component Id (GUID) of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
<Global />
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
Retrieves a ListView Command Set by title.
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo tenant commandset get --title "Some customizer"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Retrieves a ListView Command Set by id.
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 spo tenant commandset get --id 3
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Retrieves a ListView Command Set by clientSideComponentId.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo tenant commandset get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Response
|
|
51
|
+
|
|
52
|
+
<Tabs>
|
|
53
|
+
<TabItem value="JSON">
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"FileSystemObjectType": 0,
|
|
58
|
+
"Id": 4,
|
|
59
|
+
"ServerRedirectedEmbedUri": null,
|
|
60
|
+
"ServerRedirectedEmbedUrl": "",
|
|
61
|
+
"ContentTypeId": "0x00693E2C487575B448BD420C12CEAE7EFE",
|
|
62
|
+
"Title": "Some ListView Command Set",
|
|
63
|
+
"Modified": "2023-01-11T15:47:38Z",
|
|
64
|
+
"Created": "2023-01-11T15:47:38Z",
|
|
65
|
+
"AuthorId": 9,
|
|
66
|
+
"EditorId": 9,
|
|
67
|
+
"OData__UIVersionString": "1.0",
|
|
68
|
+
"Attachments": false,
|
|
69
|
+
"GUID": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
|
|
70
|
+
"ComplianceAssetId": null,
|
|
71
|
+
"TenantWideExtensionComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
|
|
72
|
+
"TenantWideExtensionComponentProperties": "{\"testMessage\":\"Test message\"}",
|
|
73
|
+
"TenantWideExtensionWebTemplate": null,
|
|
74
|
+
"TenantWideExtensionListTemplate": 101,
|
|
75
|
+
"TenantWideExtensionLocation": "ClientSideExtension.ListViewCommandSet.ContextMenu",
|
|
76
|
+
"TenantWideExtensionSequence": 0,
|
|
77
|
+
"TenantWideExtensionHostProperties": null,
|
|
78
|
+
"TenantWideExtensionDisabled": false
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
</TabItem>
|
|
83
|
+
<TabItem value="Text">
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
Attachments : false
|
|
87
|
+
AuthorId : 9
|
|
88
|
+
ComplianceAssetId : null
|
|
89
|
+
ContentTypeId : 0x00693E2C487575B448BD420C12CEAE7EFE
|
|
90
|
+
Created : 2023-01-11T15:47:38Z
|
|
91
|
+
EditorId : 9
|
|
92
|
+
FileSystemObjectType : 0
|
|
93
|
+
GUID : 14125658-a9bc-4ddf-9c75-1b5767c9a337
|
|
94
|
+
Id : 4
|
|
95
|
+
Modified : 2023-01-11T15:47:38Z
|
|
96
|
+
OData__UIVersionString : 1.0
|
|
97
|
+
ServerRedirectedEmbedUri : null
|
|
98
|
+
ServerRedirectedEmbedUrl :
|
|
99
|
+
TenantWideExtensionComponentId : 7096cded-b83d-4eab-96f0-df477ed7c0bc
|
|
100
|
+
TenantWideExtensionComponentProperties: {"testMessage":"Test message"}
|
|
101
|
+
TenantWideExtensionDisabled : false
|
|
102
|
+
TenantWideExtensionHostProperties : null
|
|
103
|
+
TenantWideExtensionListTemplate : 101
|
|
104
|
+
TenantWideExtensionLocation : ClientSideExtension.ListViewCommandSet.ContextMenu
|
|
105
|
+
TenantWideExtensionSequence : 0
|
|
106
|
+
TenantWideExtensionWebTemplate : null
|
|
107
|
+
Title : Some ListView Command Set
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
</TabItem>
|
|
111
|
+
<TabItem value="CSV">
|
|
112
|
+
|
|
113
|
+
```csv
|
|
114
|
+
FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,TenantWideExtensionComponentId,TenantWideExtensionComponentProperties,TenantWideExtensionWebTemplate,TenantWideExtensionListTemplate,TenantWideExtensionLocation,TenantWideExtensionSequence,TenantWideExtensionHostProperties,TenantWideExtensionDisabled
|
|
115
|
+
0,4,,,0x00693E2C487575B448BD420C12CEAE7EFE,Some ListView Command Set,2023-01-11T15:47:38Z,2023-01-11T15:47:38Z,9,9,1.0,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,7096cded-b83d-4eab-96f0-df477ed7c0bc,"{""testMessage"":""Test message""}",,101,ClientSideExtension.ListViewCommandSet.ContextMenu,0,,
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
</TabItem>
|
|
119
|
+
<TabItem value="Markdown">
|
|
120
|
+
|
|
121
|
+
```md
|
|
122
|
+
# spo tenant commandset get --title "Some ListView Command Set"
|
|
123
|
+
|
|
124
|
+
Date: 1/13/2023
|
|
125
|
+
|
|
126
|
+
## Some ListView Command Set (4)
|
|
127
|
+
|
|
128
|
+
Property | Value
|
|
129
|
+
---------|-------
|
|
130
|
+
FileSystemObjectType | 0
|
|
131
|
+
Id | 4
|
|
132
|
+
ServerRedirectedEmbedUri | null
|
|
133
|
+
ServerRedirectedEmbedUrl |
|
|
134
|
+
ContentTypeId | 0x00693E2C487575B448BD420C12CEAE7EFE
|
|
135
|
+
Title | Some customizer
|
|
136
|
+
Modified | 2023-01-11T15:47:38Z
|
|
137
|
+
Created | 2023-01-11T15:47:38Z
|
|
138
|
+
AuthorId | 9
|
|
139
|
+
EditorId | 9
|
|
140
|
+
OData\_\_UIVersionString | 1.0
|
|
141
|
+
Attachments | false
|
|
142
|
+
GUID | 14125658-a9bc-4ddf-9c75-1b5767c9a337
|
|
143
|
+
ComplianceAssetId | null
|
|
144
|
+
TenantWideExtensionComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
|
|
145
|
+
TenantWideExtensionComponentProperties | {"testMessage":"Test message"}
|
|
146
|
+
TenantWideExtensionWebTemplate | null
|
|
147
|
+
TenantWideExtensionListTemplate | 101
|
|
148
|
+
TenantWideExtensionLocation | ClientSideExtension.ListViewCommandSet.ContextMenu
|
|
149
|
+
TenantWideExtensionSequence | 0
|
|
150
|
+
TenantWideExtensionHostProperties | null
|
|
151
|
+
TenantWideExtensionDisabled | false
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
</TabItem>
|
|
155
|
+
</Tabs>
|