@pnp/cli-microsoft365 7.1.0-beta.aca68bd → 7.1.0-beta.ba486fa
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 +0 -1
- package/.eslintrc.cjs +1 -0
- package/Dockerfile +0 -1
- package/dist/Auth.js +2 -2
- package/dist/Command.js +18 -28
- package/dist/appInsights.js +5 -9
- package/dist/cli/Cli.js +9 -4
- package/dist/m365/aad/commands/group/group-user-list.js +146 -0
- package/dist/m365/aad/commands/m365group/m365group-remove.js +109 -15
- package/dist/m365/aad/commands.js +1 -0
- package/dist/m365/cli/commands/cli-doctor.js +11 -6
- package/dist/m365/commands/setup.js +6 -1
- package/dist/m365/spo/commands/app/app-deploy.js +1 -1
- package/dist/m365/spo/commands/app/app-get.js +1 -1
- package/dist/m365/spo/commands/app/app-teamspackage-download.js +1 -1
- package/dist/m365/spo/commands/apppage/apppage-add.js +1 -1
- package/dist/m365/spo/commands/feature/feature-disable.js +8 -6
- package/dist/m365/spo/commands/feature/feature-enable.js +6 -5
- package/dist/m365/spo/commands/page/Page.js +1 -1
- package/dist/m365/spo/commands/page/page-add.js +1 -1
- package/dist/m365/spo/commands/page/page-get.js +1 -1
- package/dist/m365/spo/commands/page/page-header-set.js +1 -1
- package/dist/m365/spo/commands/page/page-remove.js +1 -1
- package/dist/m365/spo/commands/page/page-set.js +2 -2
- package/dist/m365/spo/commands/page/page-text-add.js +1 -1
- package/dist/m365/spo/commands/sitedesign/sitedesign-get.js +15 -14
- package/dist/m365/spo/commands/sitedesign/sitedesign-remove.js +22 -22
- package/dist/m365/spo/commands/user/user-get.js +7 -1
- package/dist/m365/todo/commands/task/task-list.js +8 -10
- package/dist/m365/todo/commands/task/task-remove.js +36 -36
- package/dist/m365/todo/commands/task/task-set.js +11 -13
- package/dist/m365/yammer/commands/group/group-user-remove.js +22 -23
- package/dist/telemetry.js +30 -14
- package/dist/telemetryRunner.js +26 -0
- package/dist/utils/odata.js +20 -19
- package/dist/utils/prompt.js +16 -0
- package/docs/docs/cmd/aad/group/group-user-list.mdx +135 -0
- package/docs/docs/cmd/aad/license/license-list.mdx +21 -16
- package/docs/docs/cmd/aad/m365group/m365group-add.mdx +1 -1
- package/docs/docs/cmd/aad/m365group/m365group-remove.mdx +11 -1
- package/docs/docs/cmd/aad/user/user-add.mdx +2 -4
- package/docs/docs/cmd/aad/user/user-license-add.mdx +2 -4
- package/docs/docs/cmd/aad/user/user-license-list.mdx +3 -5
- package/docs/docs/cmd/aad/user/user-recyclebinitem-list.mdx +1 -3
- package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.mdx +1 -3
- package/docs/docs/cmd/flow/environment/environment-get.mdx +3 -4
- package/docs/docs/cmd/flow/environment/environment-list.mdx +3 -4
- package/docs/docs/cmd/flow/owner/owner-list.mdx +2 -3
- package/docs/docs/cmd/flow/run/run-list.mdx +6 -8
- package/docs/docs/cmd/graph/schemaextension/schemaextension-list.mdx +2 -3
- package/docs/docs/cmd/onenote/page/page-list.mdx +6 -9
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -15
- package/docs/docs/cmd/outlook/message/message-list.mdx +5 -14
- package/docs/docs/cmd/outlook/room/room-list.mdx +3 -6
- package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx +1 -3
- package/docs/docs/cmd/pa/app/app-get.mdx +4 -7
- package/docs/docs/cmd/pa/app/app-list.mdx +4 -7
- package/docs/docs/cmd/pa/connector/connector-list.mdx +2 -4
- package/docs/docs/cmd/pa/environment/environment-get.mdx +2 -4
- package/docs/docs/cmd/pa/environment/environment-list.mdx +1 -3
- package/docs/docs/cmd/planner/plan/plan-add.mdx +4 -11
- package/docs/docs/cmd/planner/plan/plan-get.mdx +4 -9
- package/docs/docs/cmd/planner/plan/plan-list.mdx +3 -6
- package/docs/docs/cmd/planner/plan/plan-set.mdx +3 -9
- package/docs/docs/cmd/planner/roster/roster-member-add.mdx +2 -4
- package/docs/docs/cmd/planner/roster/roster-member-get.mdx +2 -4
- package/docs/docs/cmd/planner/roster/roster-member-list.mdx +1 -3
- package/docs/docs/cmd/planner/task/task-add.mdx +4 -14
- package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +2 -4
- package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +1 -3
- package/docs/docs/cmd/planner/task/task-get.mdx +0 -7
- package/docs/docs/cmd/planner/task/task-list.mdx +1 -5
- package/docs/docs/cmd/planner/task/task-reference-add.mdx +0 -2
- package/docs/docs/cmd/planner/task/task-reference-list.mdx +0 -2
- package/docs/docs/cmd/planner/task/task-set.mdx +4 -13
- package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +1 -3
- package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +3 -5
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.mdx +6 -8
- package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.mdx +4 -7
- package/docs/docs/cmd/pp/card/card-get.mdx +4 -8
- package/docs/docs/cmd/pp/card/card-list.mdx +0 -4
- package/docs/docs/cmd/pp/chatbot/chatbot-get.mdx +4 -6
- package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +3 -14
- package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +3 -14
- package/docs/docs/cmd/pp/environment/environment-get.mdx +3 -5
- package/docs/docs/cmd/pp/environment/environment-list.mdx +2 -4
- package/docs/docs/cmd/pp/gateway/gateway-get.mdx +0 -3
- package/docs/docs/cmd/pp/gateway/gateway-list.mdx +1 -4
- package/docs/docs/cmd/purview/auditlog/auditlog-list.mdx +4 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx +3 -8
- package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx +1 -3
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx +1 -5
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx +0 -2
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.mdx +1 -3
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.mdx +1 -3
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-get.mdx +3 -6
- package/docs/docs/cmd/purview/sensitivitylabel/sensitivitylabel-list.mdx +3 -5
- package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +4 -8
- package/docs/docs/cmd/spo/app/app-add.mdx +94 -7
- package/docs/docs/cmd/spo/app/app-deploy.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-get.mdx +117 -8
- package/docs/docs/cmd/spo/app/app-install.mdx +9 -5
- package/docs/docs/cmd/spo/app/app-instance-list.mdx +85 -2
- package/docs/docs/cmd/spo/app/app-list.mdx +95 -3
- package/docs/docs/cmd/spo/app/app-remove.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-retract.mdx +9 -5
- package/docs/docs/cmd/spo/app/app-teamspackage-download.mdx +12 -8
- package/docs/docs/cmd/spo/app/app-uninstall.mdx +11 -7
- package/docs/docs/cmd/spo/app/app-upgrade.mdx +9 -5
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +4 -2
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +9 -7
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +6 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx +12 -6
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +4 -2
- package/docs/docs/cmd/spo/apppage/apppage-add.mdx +54 -5
- package/docs/docs/cmd/spo/apppage/apppage-set.mdx +8 -4
- package/docs/docs/cmd/spo/cdn/cdn-get.mdx +36 -1
- package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +7 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +48 -3
- package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +8 -4
- package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +53 -3
- package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +7 -3
- package/docs/docs/cmd/spo/cdn/cdn-set.mdx +7 -3
- package/docs/docs/cmd/spo/commandset/commandset-add.mdx +6 -6
- package/docs/docs/cmd/spo/commandset/commandset-get.mdx +3 -5
- package/docs/docs/cmd/spo/commandset/commandset-list.mdx +6 -5
- package/docs/docs/cmd/spo/commandset/commandset-remove.mdx +7 -3
- package/docs/docs/cmd/spo/commandset/commandset-set.mdx +6 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-add.mdx +148 -9
- package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +19 -15
- package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +12 -8
- package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +147 -8
- package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +115 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx +8 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +8 -4
- package/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx +44 -0
- package/docs/docs/cmd/spo/customaction/customaction-add.mdx +12 -8
- package/docs/docs/cmd/spo/customaction/customaction-clear.mdx +10 -7
- package/docs/docs/cmd/spo/customaction/customaction-get.mdx +11 -15
- package/docs/docs/cmd/spo/customaction/customaction-list.mdx +87 -5
- package/docs/docs/cmd/spo/customaction/customaction-remove.mdx +17 -13
- package/docs/docs/cmd/spo/customaction/customaction-set.mdx +27 -23
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +29 -14
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +66 -5
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx +4 -0
- package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +78 -7
- package/docs/docs/cmd/spo/feature/feature-disable.mdx +10 -6
- package/docs/docs/cmd/spo/feature/feature-enable.mdx +9 -5
- package/docs/docs/cmd/spo/feature/feature-list.mdx +52 -0
- package/docs/docs/cmd/spo/field/field-add.mdx +177 -11
- package/docs/docs/cmd/spo/field/field-get.mdx +175 -9
- package/docs/docs/cmd/spo/field/field-list.mdx +135 -8
- package/docs/docs/cmd/spo/field/field-remove.mdx +16 -12
- package/docs/docs/cmd/spo/field/field-set.mdx +15 -11
- package/docs/docs/cmd/spo/file/file-add.mdx +31 -27
- package/docs/docs/cmd/spo/file/file-checkin.mdx +13 -9
- package/docs/docs/cmd/spo/file/file-checkout.mdx +9 -5
- package/docs/docs/cmd/spo/file/file-copy.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-get.mdx +89 -18
- package/docs/docs/cmd/spo/file/file-list.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-move.mdx +5 -5
- package/docs/docs/cmd/spo/file/file-remove.mdx +13 -9
- package/docs/docs/cmd/spo/file/file-rename.mdx +63 -5
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +3 -3
- package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +4 -0
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +7 -3
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +9 -5
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +10 -6
- package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +133 -5
- package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +21 -3
- package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +18 -0
- package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +20 -3
- package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +2 -7
- package/docs/docs/cmd/spo/file/file-version-clear.mdx +7 -7
- package/docs/docs/cmd/spo/file/file-version-get.mdx +28 -6
- package/docs/docs/cmd/spo/file/file-version-list.mdx +28 -6
- package/docs/docs/cmd/spo/file/file-version-remove.mdx +8 -8
- package/docs/docs/cmd/spo/file/file-version-restore.mdx +8 -8
- package/docs/docs/cmd/spo/folder/folder-add.mdx +3 -3
- package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-get.mdx +257 -3
- package/docs/docs/cmd/spo/folder/folder-list.mdx +3 -4
- package/docs/docs/cmd/spo/folder/folder-move.mdx +5 -5
- package/docs/docs/cmd/spo/folder/folder-remove.mdx +6 -2
- package/docs/docs/cmd/spo/folder/folder-rename.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +3 -3
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +13 -8
- package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +8 -4
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.mdx +4 -0
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.mdx +5 -1
- package/docs/docs/cmd/spo/group/group-add.mdx +78 -0
- package/docs/docs/cmd/spo/group/group-get.mdx +81 -3
- package/docs/docs/cmd/spo/group/group-list.mdx +74 -3
- package/docs/docs/cmd/spo/group/group-member-add.mdx +13 -21
- package/docs/docs/cmd/spo/group/group-member-list.mdx +80 -5
- package/docs/docs/cmd/spo/group/group-member-remove.mdx +4 -4
- package/docs/docs/cmd/spo/group/group-remove.mdx +10 -6
- package/docs/docs/cmd/spo/group/group-set.mdx +9 -5
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +36 -1
- package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +6 -2
- package/docs/docs/cmd/spo/hubsite/hubsite-data-get.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-add.mdx +0 -3
- package/docs/docs/cmd/spo/list/list-contenttype-add.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +0 -2
- package/docs/docs/cmd/spo/list/list-get.mdx +1 -4
- package/docs/docs/cmd/spo/list/list-list.mdx +0 -4
- package/docs/docs/cmd/spo/list/list-view-add.mdx +0 -3
- package/docs/docs/cmd/spo/list/list-view-get.mdx +9 -12
- package/docs/docs/cmd/spo/list/list-view-list.mdx +4 -7
- package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +8 -11
- package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -2
- package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +4 -6
- package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +0 -2
- package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +4 -6
- package/docs/docs/cmd/spo/page/page-copy.mdx +4 -8
- package/docs/docs/cmd/spo/page/page-get.mdx +2 -5
- package/docs/docs/cmd/spo/page/page-list.mdx +1 -5
- package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +4 -4
- package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +6 -7
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +3 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +5 -3
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +4 -2
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-remove.mdx +5 -1
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +2 -0
- package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +2 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +5 -2
- package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +4 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-remove.mdx +5 -1
- package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +3 -1
- package/docs/docs/cmd/spo/user/user-get.mdx +6 -0
- package/docs/docs/cmd/teams/channel/channel-member-list.mdx +3 -5
- package/docs/docs/cmd/teams/channel/channel-member-set.mdx +0 -2
- package/docs/docs/cmd/teams/chat/chat-get.mdx +2 -4
- package/docs/docs/cmd/teams/chat/chat-list.mdx +1 -3
- package/docs/docs/cmd/teams/chat/chat-member-list.mdx +2 -4
- package/docs/docs/cmd/teams/message/message-get.mdx +0 -7
- package/docs/docs/cmd/teams/message/message-list.mdx +0 -6
- package/docs/docs/cmd/teams/message/message-reply-list.mdx +0 -6
- package/docs/docs/cmd/teams/tab/tab-add.mdx +10 -12
- package/docs/docs/cmd/teams/tab/tab-get.mdx +8 -10
- package/docs/docs/cmd/teams/tab/tab-list.mdx +4 -7
- package/docs/docs/cmd/teams/team/team-add.mdx +0 -7
- package/docs/docs/cmd/teams/team/team-get.mdx +0 -6
- package/docs/docs/cmd/tenant/security/security-alerts-list.mdx +1 -1
- package/docs/docs/cmd/todo/task/task-add.mdx +9 -13
- package/docs/docs/cmd/todo/task/task-set.mdx +10 -14
- package/eslint-rules/lib/index.js +2 -1
- package/eslint-rules/lib/rules/no-by-server-relative-url-usage.js +55 -0
- package/npm-shrinkwrap.json +86 -82
- package/package.json +52 -31
|
@@ -16,19 +16,19 @@ m365 spo customaction get [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-i, --id [id]`
|
|
19
|
-
: ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId
|
|
19
|
+
: ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`.
|
|
20
20
|
|
|
21
21
|
`-t, --title [title]`
|
|
22
|
-
: Title of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId
|
|
22
|
+
: Title of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`.
|
|
23
23
|
|
|
24
24
|
`-c, --clientSideComponentId [clientSideComponentId]`
|
|
25
|
-
: clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId
|
|
25
|
+
: clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`.
|
|
26
26
|
|
|
27
27
|
`-u, --webUrl <webUrl>`
|
|
28
|
-
: Url of the site or site collection to retrieve the custom action from
|
|
28
|
+
: Url of the site or site collection to retrieve the custom action from.
|
|
29
29
|
|
|
30
30
|
`-s, --scope [scope]`
|
|
31
|
-
: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All
|
|
31
|
+
: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`.
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
<Global />
|
|
@@ -39,37 +39,37 @@ If the command finds multiple user custom actions with the specified `title` or
|
|
|
39
39
|
|
|
40
40
|
## Examples
|
|
41
41
|
|
|
42
|
-
Return details about the user custom action based on the id and a given url
|
|
42
|
+
Return details about the user custom action based on the id and a given url.
|
|
43
43
|
|
|
44
44
|
```sh
|
|
45
45
|
m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Return details about the user custom action based on the title and a given url
|
|
48
|
+
Return details about the user custom action based on the title and a given url.
|
|
49
49
|
|
|
50
50
|
```sh
|
|
51
51
|
m365 spo customaction get --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Return details about the user custom action based on the clientSideComponentId and a given url
|
|
54
|
+
Return details about the user custom action based on the clientSideComponentId and a given url.
|
|
55
55
|
|
|
56
56
|
```sh
|
|
57
57
|
m365 spo customaction get --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --webUrl https://contoso.sharepoint.com/sites/test
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Return details about the user custom action based on the id and a given url and the scope
|
|
60
|
+
Return details about the user custom action based on the id and a given url and the scope.
|
|
61
61
|
|
|
62
62
|
```sh
|
|
63
63
|
m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Site
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Return details about the user custom action based on the id and a given url and the scope
|
|
66
|
+
Return details about the user custom action based on the id and a given url and the scope.
|
|
67
67
|
|
|
68
68
|
```sh
|
|
69
69
|
m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Return details about the user custom action based on the id and a given url and the scope
|
|
72
|
+
Return details about the user custom action based on the id and a given url and the scope.
|
|
73
73
|
|
|
74
74
|
```sh
|
|
75
75
|
m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
|
|
@@ -150,17 +150,14 @@ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl h
|
|
|
150
150
|
Property | Value
|
|
151
151
|
---------|-------
|
|
152
152
|
ClientSideComponentId | 34a019f9-6198-4053-a3b6-fbdea9a107fd
|
|
153
|
-
ClientSideComponentProperties | {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
|
|
154
153
|
CommandUIExtension | null
|
|
155
154
|
Description | null
|
|
156
155
|
Group | null
|
|
157
156
|
Id | 158cb0d1-8703-4a36-866d-84aed8233bd3
|
|
158
157
|
ImageUrl | null
|
|
159
158
|
Location | ClientSideExtension.ListViewCommandSet.CommandBar
|
|
160
|
-
Name | {158cb0d1-8703-4a36-866d-84aed8233bd3}
|
|
161
159
|
RegistrationId | 100
|
|
162
160
|
RegistrationType | 1
|
|
163
|
-
Rights | {"High":0,"Low":0}
|
|
164
161
|
Scope | Web
|
|
165
162
|
ScriptBlock | null
|
|
166
163
|
ScriptSrc | null
|
|
@@ -172,4 +169,3 @@ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl h
|
|
|
172
169
|
|
|
173
170
|
</TabItem>
|
|
174
171
|
</Tabs>
|
|
175
|
-
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# spo customaction list
|
|
4
6
|
|
|
@@ -14,10 +16,10 @@ m365 spo customaction list [options]
|
|
|
14
16
|
|
|
15
17
|
```md definition-list
|
|
16
18
|
`-u, --webUrl <webUrl>`
|
|
17
|
-
: Url of the site or site collection to retrieve the custom action from
|
|
19
|
+
: Url of the site or site collection to retrieve the custom action from.
|
|
18
20
|
|
|
19
21
|
`-s, --scope [scope]`
|
|
20
|
-
: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All
|
|
22
|
+
: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`.
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
<Global />
|
|
@@ -28,24 +30,104 @@ When using the text output type (default), the command lists only the values of
|
|
|
28
30
|
|
|
29
31
|
## Examples
|
|
30
32
|
|
|
31
|
-
Return details about all user custom actions located in site or site collection
|
|
33
|
+
Return details about all user custom actions located in the specified site or site collection.
|
|
32
34
|
|
|
33
35
|
```sh
|
|
34
36
|
m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test
|
|
35
37
|
```
|
|
36
38
|
|
|
37
|
-
Return details about all user custom actions located in site collection
|
|
39
|
+
Return details about all user custom actions located in the specified site collection.
|
|
38
40
|
|
|
39
41
|
```sh
|
|
40
42
|
m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Site
|
|
41
43
|
```
|
|
42
44
|
|
|
43
|
-
Return details about all user custom actions located in site
|
|
45
|
+
Return details about all user custom actions located in the specified site.
|
|
44
46
|
|
|
45
47
|
```sh
|
|
46
48
|
m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Web
|
|
47
49
|
```
|
|
48
50
|
|
|
51
|
+
## Response
|
|
52
|
+
|
|
53
|
+
<Tabs>
|
|
54
|
+
<TabItem value="JSON">
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
[
|
|
58
|
+
{
|
|
59
|
+
"ClientSideComponentId": "b41916e7-e69d-467f-b37f-ff8ecf8f99f2",
|
|
60
|
+
"ClientSideComponentProperties": "'{testMessage:Test message}'",
|
|
61
|
+
"CommandUIExtension": null,
|
|
62
|
+
"Description": null,
|
|
63
|
+
"Group": null,
|
|
64
|
+
"HostProperties": "",
|
|
65
|
+
"Id": "a70d8013-3b9f-4601-93a5-0e453ab9a1f3",
|
|
66
|
+
"ImageUrl": null,
|
|
67
|
+
"Location": "ClientSideExtension.ApplicationCustomizer",
|
|
68
|
+
"Name": "YourName",
|
|
69
|
+
"RegistrationId": null,
|
|
70
|
+
"RegistrationType": 0,
|
|
71
|
+
"Rights": {
|
|
72
|
+
"High": 0,
|
|
73
|
+
"Low": 0
|
|
74
|
+
},
|
|
75
|
+
"Scope": 3,
|
|
76
|
+
"ScriptBlock": null,
|
|
77
|
+
"ScriptSrc": null,
|
|
78
|
+
"Sequence": 0,
|
|
79
|
+
"Title": "YourAppCustomizer",
|
|
80
|
+
"Url": null,
|
|
81
|
+
"VersionOfUserCustomAction": "16.0.1.0"
|
|
82
|
+
}
|
|
83
|
+
]
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
</TabItem>
|
|
87
|
+
<TabItem value="Text">
|
|
88
|
+
|
|
89
|
+
```text
|
|
90
|
+
Name Location Scope Id
|
|
91
|
+
--------------- ----------------------------------------- ----- ------------------------------------
|
|
92
|
+
YourName ClientSideExtension.ApplicationCustomizer Web a70d8013-3b9f-4601-93a5-0e453ab9a1f3
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
</TabItem>
|
|
96
|
+
<TabItem value="CSV">
|
|
97
|
+
|
|
98
|
+
```csv
|
|
99
|
+
ClientSideComponentId,ClientSideComponentProperties,HostProperties,Id,Location,Name,RegistrationType,Scope,Sequence,Title,VersionOfUserCustomAction
|
|
100
|
+
b41916e7-e69d-467f-b37f-ff8ecf8f99f2,'{testMessage:Test message}',,a70d8013-3b9f-4601-93a5-0e453ab9a1f3,ClientSideExtension.ApplicationCustomizer,YourName,0,Web,0,YourAppCustomizer,16.0.1.0
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
</TabItem>
|
|
104
|
+
<TabItem value="Markdown">
|
|
105
|
+
|
|
106
|
+
```md
|
|
107
|
+
# spo customaction list --webUrl "https://contoso.sharepoint.com/sites/sales"
|
|
108
|
+
|
|
109
|
+
Date: 10/2/2023
|
|
110
|
+
|
|
111
|
+
## YourAppCustomizer (a70d8013-3b9f-4601-93a5-0e453ab9a1f3)
|
|
112
|
+
|
|
113
|
+
Property | Value
|
|
114
|
+
---------|-------
|
|
115
|
+
ClientSideComponentId | b41916e7-e69d-467f-b37f-ff8ecf8f99f2
|
|
116
|
+
ClientSideComponentProperties | '{testMessage:Test message}'
|
|
117
|
+
HostProperties |
|
|
118
|
+
Id | a70d8013-3b9f-4601-93a5-0e453ab9a1f3
|
|
119
|
+
Location | ClientSideExtension.ApplicationCustomizer
|
|
120
|
+
Name | YourName
|
|
121
|
+
RegistrationType | 0
|
|
122
|
+
Scope | Web
|
|
123
|
+
Sequence | 0
|
|
124
|
+
Title | YourAppCustomizer
|
|
125
|
+
VersionOfUserCustomAction | 16.0.1.0
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
</TabItem>
|
|
129
|
+
</Tabs>
|
|
130
|
+
|
|
49
131
|
## More information
|
|
50
132
|
|
|
51
133
|
- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
|
|
@@ -14,19 +14,19 @@ m365 spo customaction remove [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-i, --id [id]`
|
|
17
|
-
: Id (GUID) of the custom action to remove. Specify either `id` or `title
|
|
17
|
+
: Id (GUID) of the custom action to remove. Specify either `id` or `title`.
|
|
18
18
|
|
|
19
19
|
`-t, --title [title]`
|
|
20
|
-
: Title of the user custom action to retrieve information for. Specify either `id` or `title
|
|
20
|
+
: Title of the user custom action to retrieve information for. Specify either `id` or `title`.
|
|
21
21
|
|
|
22
22
|
`-u, --webUrl <webUrl>`
|
|
23
|
-
: Url of the site or site collection to remove the custom action from
|
|
23
|
+
: Url of the site or site collection to remove the custom action from.
|
|
24
24
|
|
|
25
25
|
`-s, --scope [scope]`
|
|
26
|
-
: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All
|
|
26
|
+
: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`.
|
|
27
27
|
|
|
28
28
|
`-f, --force`
|
|
29
|
-
: Don't prompt for confirming removal of a user custom action
|
|
29
|
+
: Don't prompt for confirming removal of a user custom action.
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<Global />
|
|
@@ -37,54 +37,58 @@ If the command finds multiple user custom actions with the specified title, it w
|
|
|
37
37
|
|
|
38
38
|
## Examples
|
|
39
39
|
|
|
40
|
-
Removes user custom action with ID
|
|
40
|
+
Removes user custom action with given ID located in the specified site or site collection.
|
|
41
41
|
|
|
42
42
|
```sh
|
|
43
43
|
m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
Removes user custom action with Title
|
|
46
|
+
Removes user custom action with given Title located in the specified site or site collection.
|
|
47
47
|
|
|
48
48
|
```sh
|
|
49
49
|
m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
Removes user custom action with ID
|
|
52
|
+
Removes user custom action with given ID located in the specified site or site collection. Skips the confirmation prompt message.
|
|
53
53
|
|
|
54
54
|
```sh
|
|
55
55
|
m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --force
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Removes user custom action with Title
|
|
58
|
+
Removes user custom action with given Title located in the specified site or site collection. Skips the confirmation prompt message.
|
|
59
59
|
|
|
60
60
|
```sh
|
|
61
61
|
m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --force
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Removes user custom action with ID
|
|
64
|
+
Removes user custom action with given ID located in the specified site collection.
|
|
65
65
|
|
|
66
66
|
```sh
|
|
67
67
|
m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Site
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Removes user custom action with Title
|
|
70
|
+
Removes user custom action with given Title located in site collection _https://contoso.sharepoint.com/sites/test_
|
|
71
71
|
|
|
72
72
|
```sh
|
|
73
73
|
m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --scope Site
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
Removes user custom action with ID
|
|
76
|
+
Removes user custom action with given ID located in the specified site.
|
|
77
77
|
|
|
78
78
|
```sh
|
|
79
79
|
m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Web
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Removes user custom action with Title
|
|
82
|
+
Removes user custom action with given Title located in the specified site.
|
|
83
83
|
|
|
84
84
|
```sh
|
|
85
85
|
m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
+
## Response
|
|
89
|
+
|
|
90
|
+
The command won't return a response on success.
|
|
91
|
+
|
|
88
92
|
## More information
|
|
89
93
|
|
|
90
94
|
- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
|
|
@@ -14,61 +14,61 @@ m365 spo customaction set [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-u, --webUrl <webUrl>`
|
|
17
|
-
: Url of the site or site collection to update the custom action
|
|
17
|
+
: Url of the site or site collection to update the custom action.
|
|
18
18
|
|
|
19
19
|
`-i, --id <id>`
|
|
20
|
-
: ID of the custom action to update
|
|
20
|
+
: ID of the custom action to update.
|
|
21
21
|
|
|
22
22
|
`-n, --name [name]`
|
|
23
|
-
: The name of the custom action
|
|
23
|
+
: The name of the custom action.
|
|
24
24
|
|
|
25
25
|
`-t, --title [title]`
|
|
26
|
-
: The title of the custom action
|
|
26
|
+
: The title of the custom action.
|
|
27
27
|
|
|
28
28
|
`-l, --location [location]`
|
|
29
|
-
: The actual location where this custom action need to be added like `CommandUI.Ribbon
|
|
29
|
+
: The actual location where this custom action need to be added like `CommandUI.Ribbon`.
|
|
30
30
|
|
|
31
31
|
`-g, --group [group]`
|
|
32
|
-
: The group of the custom action like `SiteActions
|
|
32
|
+
: The group of the custom action like `SiteActions`.
|
|
33
33
|
|
|
34
34
|
`-d, --description [description]`
|
|
35
|
-
: The description of the custom action
|
|
35
|
+
: The description of the custom action.
|
|
36
36
|
|
|
37
37
|
`--sequence [sequence]`
|
|
38
|
-
: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page
|
|
38
|
+
: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page.
|
|
39
39
|
|
|
40
40
|
`--actionUrl [actionUrl]`
|
|
41
|
-
: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx
|
|
41
|
+
: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx`.
|
|
42
42
|
|
|
43
43
|
`--imageUrl [imageUrl]`
|
|
44
|
-
: The URL of the image associated with the custom action
|
|
44
|
+
: The URL of the image associated with the custom action.
|
|
45
45
|
|
|
46
46
|
`-e, --commandUIExtension [commandUIExtension]`
|
|
47
|
-
: XML fragment that determines user interface properties of the custom action
|
|
47
|
+
: XML fragment that determines user interface properties of the custom action.
|
|
48
48
|
|
|
49
49
|
`--registrationId [registrationId]`
|
|
50
|
-
: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier
|
|
50
|
+
: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier.
|
|
51
51
|
|
|
52
52
|
`--registrationType [registrationType]`
|
|
53
|
-
: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`.
|
|
53
|
+
: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Defaults to `None`.
|
|
54
54
|
|
|
55
55
|
`--rights [rights]`
|
|
56
|
-
: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`, `UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`.
|
|
56
|
+
: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`, `UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Defaults to `EmptyMask`.
|
|
57
57
|
|
|
58
58
|
`-s, --scope [scope]`
|
|
59
59
|
: Scope of the existing custom action. Allowed values `Site`, `Web`, `All`. Default `All`. Note, this would not update the scope, but might speed up the execution of the scope of the custom action is known.
|
|
60
60
|
|
|
61
61
|
`--scriptBlock [scriptBlock]`
|
|
62
|
-
: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
|
|
62
|
+
: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink.
|
|
63
63
|
|
|
64
64
|
`--scriptSrc [scriptSrc]`
|
|
65
|
-
: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink
|
|
65
|
+
: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink.
|
|
66
66
|
|
|
67
67
|
`-c, --clientSideComponentId [clientSideComponentId]`
|
|
68
|
-
: The Client Side Component Id (GUID) of the custom action
|
|
68
|
+
: The Client Side Component Id (GUID) of the custom action.
|
|
69
69
|
|
|
70
70
|
`-p, --clientSideComponentProperties [clientSideComponentProperties]`
|
|
71
|
-
: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'
|
|
71
|
+
: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'`.
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
<Global />
|
|
@@ -93,36 +93,40 @@ When using the `--clientSideComponentProperties` option it's possible to enter a
|
|
|
93
93
|
|
|
94
94
|
## Examples
|
|
95
95
|
|
|
96
|
-
Updates tenant-wide SharePoint Framework Application Customizer extension properties in site
|
|
96
|
+
Updates a tenant-wide SharePoint Framework Application Customizer extension properties in the specified site.
|
|
97
97
|
|
|
98
98
|
```sh
|
|
99
99
|
m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"testMessage":"Test message"}'
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
Updates tenant-wide SharePoint Framework **modern List View** Command Set extension in site
|
|
102
|
+
Updates a tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site.
|
|
103
103
|
|
|
104
104
|
```sh
|
|
105
105
|
m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --sequence 100
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
Updates url custom action in the SiteActions menu in site
|
|
108
|
+
Updates a url custom action in the SiteActions menu in the specified site.
|
|
109
109
|
|
|
110
110
|
```sh
|
|
111
111
|
m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --actionUrl "~site/SitePages/Home.aspx"
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
Updates ScriptLink custom action with script source in **classic pages** in site collection
|
|
114
|
+
Updates a ScriptLink custom action with script source in **classic pages** in the specified site collection.
|
|
115
115
|
|
|
116
116
|
```sh
|
|
117
117
|
m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --scriptSrc "~sitecollection/SiteAssets/YourScript.js"
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
-
Creates custom action with delegated rights in the SiteActions menu in site
|
|
120
|
+
Creates a custom action with delegated rights in the SiteActions menu in the specified site.
|
|
121
121
|
|
|
122
122
|
```sh
|
|
123
123
|
m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --rights "AddListItems,DeleteListItems,ManageLists"
|
|
124
124
|
```
|
|
125
125
|
|
|
126
|
+
## Response
|
|
127
|
+
|
|
128
|
+
The command won't return a response on success.
|
|
129
|
+
|
|
126
130
|
## More information
|
|
127
131
|
|
|
128
132
|
- UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
|
|
@@ -41,34 +41,34 @@ m365 spo eventreceiver get [options]
|
|
|
41
41
|
|
|
42
42
|
## Examples
|
|
43
43
|
|
|
44
|
-
Retrieve event
|
|
44
|
+
Retrieve an event receiver with the given name in the specified site.
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
|
-
m365 spo eventreceiver
|
|
47
|
+
m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Retrieve event
|
|
50
|
+
Retrieve an event receiver with the given id in the specified site.
|
|
51
51
|
|
|
52
52
|
```sh
|
|
53
|
-
m365 spo eventreceiver
|
|
53
|
+
m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Retrieve event
|
|
56
|
+
Retrieve an event receiver with the given name for a list with the given title in the specified site.
|
|
57
57
|
|
|
58
58
|
```sh
|
|
59
|
-
m365 spo eventreceiver
|
|
59
|
+
m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Retrieve event
|
|
62
|
+
Retrieve an event receiver with the given id for a list with the given ID in the specified site.
|
|
63
63
|
|
|
64
64
|
```sh
|
|
65
|
-
m365 spo eventreceiver
|
|
65
|
+
m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Retrieve event
|
|
68
|
+
Retrieve an event receiver with the given name for a list with the given url in the specified site.
|
|
69
69
|
|
|
70
70
|
```sh
|
|
71
|
-
m365 spo eventreceiver
|
|
71
|
+
m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
## Response
|
|
@@ -112,8 +112,23 @@ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contos
|
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
</TabItem>
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
115
|
+
<TabItem value="Markdown">
|
|
116
|
+
|
|
117
|
+
```md
|
|
118
|
+
# spo eventreceiver get --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --id "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec"
|
|
119
|
+
|
|
120
|
+
Date: 10/2/2023
|
|
121
|
+
|
|
122
|
+
Property | Value
|
|
123
|
+
---------|-------
|
|
124
|
+
ReceiverAssembly | Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c
|
|
125
|
+
ReceiverClass | Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver
|
|
126
|
+
ReceiverId | c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
|
|
127
|
+
ReceiverName | PnP Test Receiver
|
|
128
|
+
SequenceNumber | 10000
|
|
129
|
+
Synchronization | 2
|
|
130
|
+
EventType | 10204
|
|
131
|
+
```
|
|
119
132
|
|
|
133
|
+
</TabItem>
|
|
134
|
+
</Tabs>
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# spo eventreceiver list
|
|
4
6
|
|
|
@@ -33,32 +35,91 @@ m365 spo eventreceiver list [options]
|
|
|
33
35
|
|
|
34
36
|
## Examples
|
|
35
37
|
|
|
36
|
-
Retrieves event receivers in
|
|
38
|
+
Retrieves event receivers in the specified site.
|
|
37
39
|
|
|
38
40
|
```sh
|
|
39
41
|
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
|
|
40
42
|
```
|
|
41
43
|
|
|
42
|
-
Retrieves event receivers in site
|
|
44
|
+
Retrieves event receivers in the specified site.
|
|
43
45
|
|
|
44
46
|
```sh
|
|
45
47
|
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site
|
|
46
48
|
```
|
|
47
49
|
|
|
48
|
-
Retrieves event receivers for list with title
|
|
50
|
+
Retrieves event receivers for list with given title in the specified site.
|
|
49
51
|
|
|
50
52
|
```sh
|
|
51
53
|
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
|
|
52
54
|
```
|
|
53
55
|
|
|
54
|
-
Retrieves event receivers for list with ID
|
|
56
|
+
Retrieves event receivers for list with given ID in the specified site.
|
|
55
57
|
|
|
56
58
|
```sh
|
|
57
59
|
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
|
|
58
60
|
```
|
|
59
61
|
|
|
60
|
-
Retrieves event receivers for list with url
|
|
62
|
+
Retrieves event receivers for list with given url in the specified site.
|
|
61
63
|
|
|
62
64
|
```sh
|
|
63
65
|
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
|
|
64
66
|
```
|
|
67
|
+
|
|
68
|
+
## Response
|
|
69
|
+
|
|
70
|
+
<Tabs>
|
|
71
|
+
<TabItem value="JSON">
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
[
|
|
75
|
+
{
|
|
76
|
+
"ReceiverAssembly": "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",
|
|
77
|
+
"ReceiverClass": "Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver",
|
|
78
|
+
"ReceiverId": "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec",
|
|
79
|
+
"ReceiverName": "PnP Test Receiver",
|
|
80
|
+
"SequenceNumber": 10000,
|
|
81
|
+
"Synchronization": 2,
|
|
82
|
+
"EventType": 10204,
|
|
83
|
+
"ReceiverUrl": "https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b"
|
|
84
|
+
}
|
|
85
|
+
]
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
</TabItem>
|
|
89
|
+
<TabItem value="Text">
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
ReceiverId ReceiverName
|
|
93
|
+
------------------------------------ -------------------------------------------------------------------------
|
|
94
|
+
c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec PnP Test Receiver
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
</TabItem>
|
|
98
|
+
<TabItem value="CSV">
|
|
99
|
+
|
|
100
|
+
```csv
|
|
101
|
+
ReceiverAssembly,ReceiverClass,ReceiverId,ReceiverName,SequenceNumber,Synchronization,EventType
|
|
102
|
+
"Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver,c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec,PnP Test Receiver,10000,2,10204
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
</TabItem>
|
|
106
|
+
<TabItem value="Markdown">
|
|
107
|
+
|
|
108
|
+
```md
|
|
109
|
+
# spo eventreceiver list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
|
|
110
|
+
|
|
111
|
+
Date: 10/2/2023
|
|
112
|
+
|
|
113
|
+
Property | Value
|
|
114
|
+
---------|-------
|
|
115
|
+
ReceiverAssembly | Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c
|
|
116
|
+
ReceiverClass | Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver
|
|
117
|
+
ReceiverId | c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
|
|
118
|
+
ReceiverName | PnP Test Receiver
|
|
119
|
+
SequenceNumber | 10000
|
|
120
|
+
Synchronization | 2
|
|
121
|
+
EventType | 10204
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
</TabItem>
|
|
125
|
+
</Tabs>
|
|
@@ -79,3 +79,7 @@ Remove event receiver in a specific list retrieved by list url by name.
|
|
|
79
79
|
```sh
|
|
80
80
|
m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
|
|
81
81
|
```
|
|
82
|
+
|
|
83
|
+
## Response
|
|
84
|
+
|
|
85
|
+
The command won't return a response on success.
|