@pnp/cli-microsoft365 7.1.0-beta.aca68bd → 7.1.0-beta.d53f0d9
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 +1 -1
- package/dist/appInsights.js +5 -9
- package/dist/cli/Cli.js +6 -2
- 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/user/user-get.js +7 -1
- package/dist/telemetry.js +30 -14
- package/dist/telemetryRunner.js +26 -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/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 +20 -19
|
@@ -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 folder get
|
|
4
6
|
|
|
@@ -36,20 +38,272 @@ If root level folder is passed, you will get a `Please ensure the specified fold
|
|
|
36
38
|
|
|
37
39
|
## Examples
|
|
38
40
|
|
|
39
|
-
Get folder properties for a folder with a specific site-relative URL
|
|
41
|
+
Get folder properties for a folder with a specific site-relative URL.
|
|
40
42
|
|
|
41
43
|
```sh
|
|
42
44
|
m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --url "/Shared Documents"
|
|
43
45
|
```
|
|
44
46
|
|
|
45
|
-
Get folder properties for a folder with a specific id (UniqueId)
|
|
47
|
+
Get folder properties for a folder with a specific id (UniqueId).
|
|
46
48
|
|
|
47
49
|
```sh
|
|
48
50
|
m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
49
51
|
```
|
|
50
52
|
|
|
51
|
-
Get folder properties with permissions for a folder with server-relative URL
|
|
53
|
+
Get folder properties with permissions for a folder with server-relative URL.
|
|
52
54
|
|
|
53
55
|
```sh
|
|
54
56
|
m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/test --url "/sites/test/Shared Documents/Test1" --withPermissions
|
|
55
57
|
```
|
|
58
|
+
|
|
59
|
+
## Response
|
|
60
|
+
|
|
61
|
+
### Standard response
|
|
62
|
+
|
|
63
|
+
<Tabs>
|
|
64
|
+
<TabItem value="JSON">
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"Exists": true,
|
|
69
|
+
"ExistsAllowThrowForPolicyFailures": true,
|
|
70
|
+
"IsWOPIEnabled": false,
|
|
71
|
+
"ItemCount": 0,
|
|
72
|
+
"Name": "Test",
|
|
73
|
+
"ProgID": null,
|
|
74
|
+
"ServerRelativeUrl": "/sites/test/Shared Documents/Test",
|
|
75
|
+
"TimeCreated": "2020-10-29T17:28:43Z",
|
|
76
|
+
"TimeLastModified": "2023-10-02T19:25:28Z",
|
|
77
|
+
"UniqueId": "ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e",
|
|
78
|
+
"WelcomePage": ""
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
</TabItem>
|
|
83
|
+
<TabItem value="Text">
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
Exists : true
|
|
87
|
+
ExistsAllowThrowForPolicyFailures: true
|
|
88
|
+
IsWOPIEnabled : false
|
|
89
|
+
ItemCount : 0
|
|
90
|
+
Name : Test
|
|
91
|
+
ProgID : null
|
|
92
|
+
ServerRelativeUrl : /sites/test/Shared Documents/Test
|
|
93
|
+
TimeCreated : 2020-10-29T17:28:43Z
|
|
94
|
+
TimeLastModified : 2023-10-02T19:25:28Z
|
|
95
|
+
UniqueId : ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e
|
|
96
|
+
WelcomePage :
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
</TabItem>
|
|
100
|
+
<TabItem value="CSV">
|
|
101
|
+
|
|
102
|
+
```csv
|
|
103
|
+
Exists,ExistsAllowThrowForPolicyFailures,IsWOPIEnabled,ItemCount,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,UniqueId,WelcomePage
|
|
104
|
+
1,1,,0,Test,/sites/test/Shared Documents/Test,2020-10-29T17:28:43Z,2023-10-02T19:25:28Z,ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e,
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
</TabItem>
|
|
108
|
+
<TabItem value="Markdown">
|
|
109
|
+
|
|
110
|
+
```md
|
|
111
|
+
# spo folder get --webUrl "https://contoso.sharepoint.com/sites/test" --url "/sites/test/Shared Documents/Test"
|
|
112
|
+
|
|
113
|
+
Date: 10/3/2023
|
|
114
|
+
|
|
115
|
+
## Test (ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e)
|
|
116
|
+
|
|
117
|
+
Property | Value
|
|
118
|
+
---------|-------
|
|
119
|
+
Exists | true
|
|
120
|
+
ExistsAllowThrowForPolicyFailures | true
|
|
121
|
+
IsWOPIEnabled | false
|
|
122
|
+
ItemCount | 0
|
|
123
|
+
Name | Test
|
|
124
|
+
ServerRelativeUrl | /sites/test/Shared Documents/Test
|
|
125
|
+
TimeCreated | 2020-10-29T17:28:43Z
|
|
126
|
+
TimeLastModified | 2023-10-02T19:25:28Z
|
|
127
|
+
UniqueId | ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e
|
|
128
|
+
WelcomePage |
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
</TabItem>
|
|
132
|
+
</Tabs>
|
|
133
|
+
|
|
134
|
+
### `withPermissions` response
|
|
135
|
+
|
|
136
|
+
When we make use of the option `withPermissions` the response will differ.
|
|
137
|
+
|
|
138
|
+
## Response
|
|
139
|
+
|
|
140
|
+
<Tabs>
|
|
141
|
+
<TabItem value="JSON">
|
|
142
|
+
|
|
143
|
+
```json
|
|
144
|
+
{
|
|
145
|
+
"ListItemAllFields": {
|
|
146
|
+
"RoleAssignments": [
|
|
147
|
+
{
|
|
148
|
+
"Member": {
|
|
149
|
+
"Id": 4,
|
|
150
|
+
"IsHiddenInUI": false,
|
|
151
|
+
"LoginName": "SPDemo Owners",
|
|
152
|
+
"Title": "SPDemo Owners",
|
|
153
|
+
"PrincipalType": 8,
|
|
154
|
+
"AllowMembersEditMembership": false,
|
|
155
|
+
"AllowRequestToJoinLeave": false,
|
|
156
|
+
"AutoAcceptRequestToJoinLeave": false,
|
|
157
|
+
"Description": null,
|
|
158
|
+
"OnlyAllowMembersViewMembership": false,
|
|
159
|
+
"OwnerTitle": "SPDemo Owners",
|
|
160
|
+
"RequestToJoinLeaveEmailSetting": "",
|
|
161
|
+
"PrincipalTypeString": "SharePointGroup"
|
|
162
|
+
},
|
|
163
|
+
"RoleDefinitionBindings": [
|
|
164
|
+
{
|
|
165
|
+
"BasePermissions": {
|
|
166
|
+
"High": "2147483647",
|
|
167
|
+
"Low": "4294967295"
|
|
168
|
+
},
|
|
169
|
+
"Description": "Has full control.",
|
|
170
|
+
"Hidden": false,
|
|
171
|
+
"Id": 1073741829,
|
|
172
|
+
"Name": "Full Control",
|
|
173
|
+
"Order": 1,
|
|
174
|
+
"RoleTypeKind": 5,
|
|
175
|
+
"BasePermissionsValue": [
|
|
176
|
+
"ViewListItems",
|
|
177
|
+
"AddListItems",
|
|
178
|
+
"EditListItems",
|
|
179
|
+
"DeleteListItems",
|
|
180
|
+
"ApproveItems",
|
|
181
|
+
"OpenItems",
|
|
182
|
+
"ViewVersions",
|
|
183
|
+
"DeleteVersions",
|
|
184
|
+
"CancelCheckout",
|
|
185
|
+
"ManagePersonalViews",
|
|
186
|
+
"ManageLists",
|
|
187
|
+
"ViewFormPages",
|
|
188
|
+
"AnonymousSearchAccessList",
|
|
189
|
+
"Open",
|
|
190
|
+
"ViewPages",
|
|
191
|
+
"AddAndCustomizePages",
|
|
192
|
+
"ApplyThemeAndBorder",
|
|
193
|
+
"ApplyStyleSheets",
|
|
194
|
+
"ViewUsageData",
|
|
195
|
+
"CreateSSCSite",
|
|
196
|
+
"ManageSubwebs",
|
|
197
|
+
"CreateGroups",
|
|
198
|
+
"ManagePermissions",
|
|
199
|
+
"BrowseDirectories",
|
|
200
|
+
"BrowseUserInfo",
|
|
201
|
+
"AddDelPrivateWebParts",
|
|
202
|
+
"UpdatePersonalWebParts",
|
|
203
|
+
"ManageWeb",
|
|
204
|
+
"AnonymousSearchAccessWebLists",
|
|
205
|
+
"UseClientIntegration",
|
|
206
|
+
"UseRemoteAPIs",
|
|
207
|
+
"ManageAlerts",
|
|
208
|
+
"CreateAlerts",
|
|
209
|
+
"EditMyUserInfo",
|
|
210
|
+
"EnumeratePermissions"
|
|
211
|
+
],
|
|
212
|
+
"RoleTypeKindValue": "Administrator"
|
|
213
|
+
}
|
|
214
|
+
],
|
|
215
|
+
"PrincipalId": 4
|
|
216
|
+
}
|
|
217
|
+
],
|
|
218
|
+
"HasUniqueRoleAssignments": false,
|
|
219
|
+
"FileSystemObjectType": 1,
|
|
220
|
+
"Id": 7,
|
|
221
|
+
"ServerRedirectedEmbedUri": null,
|
|
222
|
+
"ServerRedirectedEmbedUrl": "",
|
|
223
|
+
"ContentTypeId": "0x012000ACCD7E1ACA45684498AF2BD37B05082B",
|
|
224
|
+
"ComplianceAssetId": null,
|
|
225
|
+
"Title": null,
|
|
226
|
+
"MediaServiceOCR": null,
|
|
227
|
+
"MediaServiceKeyPoints": null,
|
|
228
|
+
"HideFromDelve": null,
|
|
229
|
+
"MediaServiceImageTags": [],
|
|
230
|
+
"SharedWithUsersId": null,
|
|
231
|
+
"SharedWithDetails": null,
|
|
232
|
+
"OData__ColorTag": null,
|
|
233
|
+
"OData__Version": null,
|
|
234
|
+
"ID": 7,
|
|
235
|
+
"Created": "2020-10-29T10:28:43",
|
|
236
|
+
"AuthorId": 7,
|
|
237
|
+
"Modified": "2020-10-29T10:28:43",
|
|
238
|
+
"EditorId": 7,
|
|
239
|
+
"OData__CopySource": null,
|
|
240
|
+
"CheckoutUserId": null,
|
|
241
|
+
"OData__UIVersionString": "1.0",
|
|
242
|
+
"GUID": "d66963e6-7b83-45e6-aa97-ce8d92857b28"
|
|
243
|
+
},
|
|
244
|
+
"Exists": true,
|
|
245
|
+
"ExistsAllowThrowForPolicyFailures": true,
|
|
246
|
+
"IsWOPIEnabled": false,
|
|
247
|
+
"ItemCount": 0,
|
|
248
|
+
"Name": "Test",
|
|
249
|
+
"ProgID": null,
|
|
250
|
+
"ServerRelativeUrl": "/sites/test/Shared Documents/Test",
|
|
251
|
+
"TimeCreated": "2020-10-29T17:28:43Z",
|
|
252
|
+
"TimeLastModified": "2023-10-02T19:25:28Z",
|
|
253
|
+
"UniqueId": "ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e",
|
|
254
|
+
"WelcomePage": ""
|
|
255
|
+
}
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
</TabItem>
|
|
259
|
+
<TabItem value="Text">
|
|
260
|
+
|
|
261
|
+
```text
|
|
262
|
+
Exists : true
|
|
263
|
+
ExistsAllowThrowForPolicyFailures: true
|
|
264
|
+
IsWOPIEnabled : false
|
|
265
|
+
ItemCount : 0
|
|
266
|
+
ListItemAllFields : {"RoleAssignments":[{"Member":{"Id":4,"IsHiddenInUI":false,"LoginName":"SPDemo Owners","Title":"SPDemo Owners","PrincipalType":8,"AllowMembersEditMembership":false,"AllowRequestToJoinLeave":false,"AutoAcceptRequestToJoinLeave":false,"Description":null,"OnlyAllowMembersViewMembership":false,"OwnerTitle":"SPDemo Owners","RequestToJoinLeaveEmailSetting":"","PrincipalTypeString":"SharePointGroup"},"RoleDefinitionBindings":[{"BasePermissions":{"High":"2147483647","Low":"4294967295"},"Description":"Has full control.","Hidden":false,"Id":1073741829,"Name":"Full Control","Order":1,"RoleTypeKind":5,"BasePermissionsValue":["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"],"RoleTypeKindValue":"Administrator"}],"PrincipalId":4},"RoleDefinitionBindings":[{"BasePermissions":{"High":"48","Low":"134287360"},"Description":"Can view specific lists, document libraries, list items, folders, or documents when given permissions.","Hidden":true,"Id":1073741825,"Name":"Limited Access","Order":160,"RoleTypeKind":1,"BasePermissionsValue":["ViewFormPages","Open","BrowseUserInfo","UseClientIntegration","UseRemoteAPIs"],"RoleTypeKindValue":"Guest"}],"PrincipalId":30}],"HasUniqueRoleAssignments":false,"FileSystemObjectType":1,"Id":7,"ServerRedirectedEmbedUri":null,"ServerRedirectedEmbedUrl":"","ContentTypeId":"0x012000ACCD7E1ACA45684498AF2BD37B05082B","ComplianceAssetId":null,"Title":null,"MediaServiceOCR":null,"MediaServiceKeyPoints":null,"HideFromDelve":null,"MediaServiceImageTags":[],"SharedWithUsersId":null,"SharedWithDetails":null,"OData__ColorTag":null,"OData__Version":null,"ID":7,"Created":"2020-10-29T10:28:43","AuthorId":7,"Modified":"2020-10-29T10:28:43","EditorId":7,"OData__CopySource":null,"CheckoutUserId":null,"OData__UIVersionString":"1.0","GUID":"d66963e6-7b83-45e6-aa97-ce8d92857b28"}
|
|
267
|
+
Name : Test
|
|
268
|
+
ProgID : null
|
|
269
|
+
ServerRelativeUrl : /sites/test/Shared Documents/Test
|
|
270
|
+
TimeCreated : 2020-10-29T17:28:43Z
|
|
271
|
+
TimeLastModified : 2023-10-02T19:25:28Z
|
|
272
|
+
UniqueId : ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e
|
|
273
|
+
WelcomePage :
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
</TabItem>
|
|
277
|
+
<TabItem value="CSV">
|
|
278
|
+
|
|
279
|
+
```csv
|
|
280
|
+
Exists,ExistsAllowThrowForPolicyFailures,IsWOPIEnabled,ItemCount,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,UniqueId,WelcomePage
|
|
281
|
+
1,1,,0,Test,/sites/test/Shared Documents/Test,2020-10-29T17:28:43Z,2023-10-02T19:25:28Z,ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e,
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
</TabItem>
|
|
285
|
+
<TabItem value="Markdown">
|
|
286
|
+
|
|
287
|
+
```md
|
|
288
|
+
# spo folder get --webUrl "https://contoso.sharepoint.com/sites/test" --url "/sites/test/Shared Documents/Test" --withPermissions "true"
|
|
289
|
+
|
|
290
|
+
Date: 10/3/2023
|
|
291
|
+
|
|
292
|
+
## Test (ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e)
|
|
293
|
+
|
|
294
|
+
Property | Value
|
|
295
|
+
---------|-------
|
|
296
|
+
Exists | true
|
|
297
|
+
ExistsAllowThrowForPolicyFailures | true
|
|
298
|
+
IsWOPIEnabled | false
|
|
299
|
+
ItemCount | 0
|
|
300
|
+
Name | Test
|
|
301
|
+
ServerRelativeUrl | /sites/test/Shared Documents/Test
|
|
302
|
+
TimeCreated | 2020-10-29T17:28:43Z
|
|
303
|
+
TimeLastModified | 2023-10-02T19:25:28Z
|
|
304
|
+
UniqueId | ab5efdaf-bc47-44ae-a29c-2cfff63ecc9e
|
|
305
|
+
WelcomePage |
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
</TabItem>
|
|
309
|
+
</Tabs>
|
|
@@ -35,19 +35,19 @@ m365 spo folder list [options]
|
|
|
35
35
|
|
|
36
36
|
## Examples
|
|
37
37
|
|
|
38
|
-
Gets list of folders under a parent folder with site-relative URL
|
|
38
|
+
Gets list of folders under a parent folder with site-relative URL.
|
|
39
39
|
|
|
40
40
|
```sh
|
|
41
41
|
m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Gets recursive list of folders under a specific folder on a specific site
|
|
44
|
+
Gets recursive list of folders under a specific folder on a specific site.
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
47
|
m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents' --recursive
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Return a filtered list of folders and only return the list item ID
|
|
50
|
+
Return a filtered list of folders and only return the list item ID.
|
|
51
51
|
|
|
52
52
|
```sh
|
|
53
53
|
m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --fields ListItemAllFields/Id --filter "startswith(Name,'Folder')"
|
|
@@ -118,4 +118,3 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
|
|
|
118
118
|
|
|
119
119
|
</TabItem>
|
|
120
120
|
</Tabs>
|
|
121
|
-
|
|
@@ -29,7 +29,7 @@ m365 spo folder move [options]
|
|
|
29
29
|
: The new name of the destination folder.
|
|
30
30
|
|
|
31
31
|
`--nameConflictBehavior [nameConflictBehavior]`
|
|
32
|
-
: Behavior when a file or folder with the same name is already present at the destination.
|
|
32
|
+
: Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `rename`. Defaults to `fail`.
|
|
33
33
|
|
|
34
34
|
`--retainEditorAndModified`
|
|
35
35
|
: Use this option to retain the editor and modified date. When not specified, these values are reset.
|
|
@@ -51,25 +51,25 @@ When you specify a value for `nameConflictBehavior`, consider the following:
|
|
|
51
51
|
|
|
52
52
|
## Examples
|
|
53
53
|
|
|
54
|
-
Move a folder to a document library in another site collection by server-relative URL
|
|
54
|
+
Move a folder to a document library in another site collection by server-relative URL.
|
|
55
55
|
|
|
56
56
|
```sh
|
|
57
57
|
m365 spo folder move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents/Reports January"
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Move a folder to another location using site-relative URLs and rename it
|
|
60
|
+
Move a folder to another location using site-relative URLs and rename it.
|
|
61
61
|
|
|
62
62
|
```sh
|
|
63
63
|
m365 spo folder move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents" --newName "Reports January"
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Move a folder to another location and use a new name on conflict
|
|
66
|
+
Move a folder to another location and use a new name on conflict.
|
|
67
67
|
|
|
68
68
|
```sh
|
|
69
69
|
m365 spo folder move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl "/sites/project-x/Shared Documents/Reports" --targetUrl "/sites/project-y/Shared Documents/Project files" --nameConflictBehavior rename
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Move a folder referenced by its ID to another document library and retain editor and modified date
|
|
72
|
+
Move a folder referenced by its ID to another document library and retain editor and modified date.
|
|
73
73
|
|
|
74
74
|
```sh
|
|
75
75
|
m365 spo folder move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/Project files" --retainEditorAndModified
|
|
@@ -34,14 +34,18 @@ The `spo folder remove` command will remove folder only if it is empty. If the f
|
|
|
34
34
|
|
|
35
35
|
## Examples
|
|
36
36
|
|
|
37
|
-
Remove a folder with a specific site-relative URL
|
|
37
|
+
Remove a folder with a specific site-relative URL.
|
|
38
38
|
|
|
39
39
|
```sh
|
|
40
40
|
m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder'
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Remove a folder with a specific server relative URL to the site recycle bin
|
|
43
|
+
Remove a folder with a specific server relative URL to the site recycle bin.
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
46
|
m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/Shared Documents/My Folder' --recycle
|
|
47
47
|
```
|
|
48
|
+
|
|
49
|
+
## Response
|
|
50
|
+
|
|
51
|
+
The command won't return a response on success.
|
|
@@ -27,13 +27,13 @@ m365 spo folder rename [options]
|
|
|
27
27
|
|
|
28
28
|
## Examples
|
|
29
29
|
|
|
30
|
-
Renames a folder with a specific site-relative URL
|
|
30
|
+
Renames a folder with a specific site-relative URL.
|
|
31
31
|
|
|
32
32
|
```sh
|
|
33
33
|
m365 spo folder rename --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder 1' --name 'My Folder 2'
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Renames a folder with a specific server-relative URL
|
|
36
|
+
Renames a folder with a specific server-relative URL.
|
|
37
37
|
|
|
38
38
|
```sh
|
|
39
39
|
m365 spo folder rename --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/Shared Documents/My Folder 1' --name 'My Folder 2'
|
|
@@ -14,7 +14,7 @@ m365 spo folder retentionlabel ensure [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-u, --webUrl <webUrl>`
|
|
17
|
-
: URL of the site where the retention label from a file to apply is located
|
|
17
|
+
: URL of the site where the retention label from a file to apply is located.
|
|
18
18
|
|
|
19
19
|
`--folderUrl [folderUrl]`
|
|
20
20
|
: The server- or site-relative decoded URL of the folder that should be labelled. Specify either `folderUrl` or `folderId` but not both.
|
|
@@ -34,13 +34,13 @@ You can also use [spo listitem retentionlabel remove](./../../../cmd/spo/listite
|
|
|
34
34
|
|
|
35
35
|
## Examples
|
|
36
36
|
|
|
37
|
-
Applies a retention label to a folder based on the label name and the folderUrl
|
|
37
|
+
Applies a retention label to a folder based on the label name and the folderUrl.
|
|
38
38
|
|
|
39
39
|
```sh
|
|
40
40
|
m365 spo folder retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents' --name 'Some label'
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Applies a retention label to a folder based on the label name and the folderId
|
|
43
|
+
Applies a retention label to a folder based on the label name and the folderId.
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
46
|
m365 spo folder retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --folderId '26541f96-017c-4189-a604-599e083533b8' --name 'Some label'
|
|
@@ -30,13 +30,13 @@ m365 spo folder retentionlabel remove [options]
|
|
|
30
30
|
|
|
31
31
|
## Examples
|
|
32
32
|
|
|
33
|
-
Removes the retention label from a folder in a given site based on the folder id
|
|
33
|
+
Removes the retention label from a folder in a given site based on the folder id.
|
|
34
34
|
|
|
35
35
|
```sh
|
|
36
36
|
m365 spo folder retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderId 0cd891ef-afce-4e55-b836-fce03286cccf
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Removes the retention label from a folder in a given site based on the folder url
|
|
39
|
+
Removes the retention label from a folder in a given site based on the folder url.
|
|
40
40
|
|
|
41
41
|
```sh
|
|
42
42
|
m365 spo folder retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl /sites/project-x/Shared Documents/Folder --id 1
|
|
@@ -20,19 +20,19 @@ m365 spo folder roleassignment add [options]
|
|
|
20
20
|
: The server- or site-relative decoded URL of the folder.
|
|
21
21
|
|
|
22
22
|
`--principalId [principalId]`
|
|
23
|
-
: The SharePoint principal id. It may be either an user id or group id for which the role assignment will be addd. Specify either upn
|
|
23
|
+
: The SharePoint principal id. It may be either an user id or group id for which the role assignment will be addd. Specify either `upn`, `groupName` or `principalId` but not multiple.
|
|
24
24
|
|
|
25
25
|
`--upn [upn]`
|
|
26
|
-
: The upn/email of the user. Specify either upn
|
|
26
|
+
: The upn/email of the user. Specify either `upn`, `groupName` or `principalId` but not multiple.
|
|
27
27
|
|
|
28
28
|
`--groupName [groupName]`
|
|
29
|
-
: The Azure AD or SharePoint group name. Specify either upn
|
|
29
|
+
: The Azure AD or SharePoint group name. Specify either `upn`, `groupName` or `principalId` but not multiple.
|
|
30
30
|
|
|
31
31
|
`--roleDefinitionId [roleDefinitionId]`
|
|
32
|
-
: ID of the role definition. Specify either roleDefinitionId or roleDefinitionName but not both.
|
|
32
|
+
: ID of the role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
|
|
33
33
|
|
|
34
34
|
`--roleDefinitionName [roleDefinitionName]`
|
|
35
|
-
: The name of the role definition. E.g. 'Contribute', 'Read'. Specify either roleDefinitionId or roleDefinitionName but not both.
|
|
35
|
+
: The name of the role definition. E.g. 'Contribute', 'Read'. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
<Global />
|
|
@@ -45,19 +45,24 @@ Add the role assignment to the specified folder based on the group name and role
|
|
|
45
45
|
m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --groupName "saleGroup" --roleDefinitionName "Edit"
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Add the role assignment to the specified folder based on the principal Id and role definition id
|
|
48
|
+
Add the role assignment to the specified folder based on the principal Id and role definition id.
|
|
49
49
|
|
|
50
50
|
```sh
|
|
51
51
|
m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2 --roleDefinitionId 1073741827
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Add the role assignment to the specified folder based on the upn and role definition name
|
|
54
|
+
Add the role assignment to the specified folder based on the upn and role definition name.
|
|
55
55
|
|
|
56
56
|
```sh
|
|
57
57
|
m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com" --roleDefinitionName "Edit"
|
|
58
58
|
```
|
|
59
|
-
|
|
59
|
+
|
|
60
|
+
Add the role assignment to the root folder based on the upn and role definition name.
|
|
60
61
|
|
|
61
62
|
```sh
|
|
62
63
|
m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents" --upn "test@contoso.onmicrosoft.com" --roleDefinitionName "Edit"
|
|
63
64
|
```
|
|
65
|
+
|
|
66
|
+
## Response
|
|
67
|
+
|
|
68
|
+
The command won't return a response on success.
|
|
@@ -20,13 +20,13 @@ m365 spo folder roleassignment remove [options]
|
|
|
20
20
|
: The server- or site-relative decoded URL of the folder.
|
|
21
21
|
|
|
22
22
|
`--principalId [principalId]`
|
|
23
|
-
: The SharePoint principal id. It may be either an user id or group id for which the role assignment will be removed. Specify either upn
|
|
23
|
+
: The SharePoint principal id. It may be either an user id or group id for which the role assignment will be removed. Specify either `upn`, `groupName` or `principalId` but not multiple.
|
|
24
24
|
|
|
25
25
|
`--upn [upn]`
|
|
26
|
-
: The upn/email of the user. Specify either upn
|
|
26
|
+
: The upn/email of the user. Specify either `upn`, `groupName` or `principalId` but not multiple.
|
|
27
27
|
|
|
28
28
|
`--groupName [groupName]`
|
|
29
|
-
: The Azure AD or SharePoint group name. Specify either upn
|
|
29
|
+
: The Azure AD or SharePoint group name. Specify either `upn`, `groupName` or `principalId` but not multiple.
|
|
30
30
|
|
|
31
31
|
`-f, --force`
|
|
32
32
|
: Don't prompt for confirmation when removing the role assignment.
|
|
@@ -36,7 +36,7 @@ m365 spo folder roleassignment remove [options]
|
|
|
36
36
|
|
|
37
37
|
## Examples
|
|
38
38
|
|
|
39
|
-
Remove roleassignment from folder based on group name
|
|
39
|
+
Remove roleassignment from folder based on group name.
|
|
40
40
|
|
|
41
41
|
```sh
|
|
42
42
|
m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --groupName "saleGroup"
|
|
@@ -59,3 +59,7 @@ Remove the role assignment from the specified folder based on the upn.
|
|
|
59
59
|
```sh
|
|
60
60
|
m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com"
|
|
61
61
|
```
|
|
62
|
+
|
|
63
|
+
## Response
|
|
64
|
+
|
|
65
|
+
The command won't return a response on success.
|
|
@@ -47,3 +47,7 @@ Break the inheritance of the specified root folder for the library with a specif
|
|
|
47
47
|
```sh
|
|
48
48
|
m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --clearExistingPermissions --force
|
|
49
49
|
```
|
|
50
|
+
|
|
51
|
+
## Response
|
|
52
|
+
|
|
53
|
+
The command won't return a response on success.
|
|
@@ -27,7 +27,7 @@ m365 spo folder roleinheritance reset [options]
|
|
|
27
27
|
|
|
28
28
|
## Examples
|
|
29
29
|
|
|
30
|
-
Reset inheritance of folder with a specific site-relative URL
|
|
30
|
+
Reset inheritance of folder with a specific site-relative URL.
|
|
31
31
|
|
|
32
32
|
```sh
|
|
33
33
|
m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
|
|
@@ -44,3 +44,7 @@ Reset inheritance of the specified root folder for the library with a specific s
|
|
|
44
44
|
```sh
|
|
45
45
|
m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --force
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
## Response
|
|
49
|
+
|
|
50
|
+
The command won't return a response on success.
|
|
@@ -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 group add
|
|
4
6
|
|
|
@@ -53,3 +55,79 @@ Create group with membership requests
|
|
|
53
55
|
```sh
|
|
54
56
|
m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
|
|
55
57
|
```
|
|
58
|
+
|
|
59
|
+
## Response
|
|
60
|
+
|
|
61
|
+
<Tabs>
|
|
62
|
+
<TabItem value="JSON">
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"Id": 37,
|
|
67
|
+
"IsHiddenInUI": false,
|
|
68
|
+
"LoginName": "Project leaders",
|
|
69
|
+
"Title": "Project leaders",
|
|
70
|
+
"PrincipalType": 8,
|
|
71
|
+
"AllowMembersEditMembership": false,
|
|
72
|
+
"AllowRequestToJoinLeave": false,
|
|
73
|
+
"AutoAcceptRequestToJoinLeave": false,
|
|
74
|
+
"Description": "This group contains all project leaders",
|
|
75
|
+
"OnlyAllowMembersViewMembership": true,
|
|
76
|
+
"OwnerTitle": "Jon Doe",
|
|
77
|
+
"RequestToJoinLeaveEmailSetting": null
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
</TabItem>
|
|
82
|
+
<TabItem value="Text">
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
AllowMembersEditMembership : false
|
|
86
|
+
AllowRequestToJoinLeave : false
|
|
87
|
+
AutoAcceptRequestToJoinLeave : false
|
|
88
|
+
Description : This group contains all project leaders
|
|
89
|
+
Id : 38
|
|
90
|
+
IsHiddenInUI : false
|
|
91
|
+
LoginName : Project leaders
|
|
92
|
+
OnlyAllowMembersViewMembership: true
|
|
93
|
+
OwnerTitle : Jon Doe
|
|
94
|
+
PrincipalType : 8
|
|
95
|
+
RequestToJoinLeaveEmailSetting: null
|
|
96
|
+
Title : Project leaders
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
</TabItem>
|
|
100
|
+
<TabItem value="CSV">
|
|
101
|
+
|
|
102
|
+
```csv
|
|
103
|
+
Id,IsHiddenInUI,LoginName,Title,PrincipalType,AllowMembersEditMembership,AllowRequestToJoinLeave,AutoAcceptRequestToJoinLeave,Description,OnlyAllowMembersViewMembership,OwnerTitle
|
|
104
|
+
39,,Project leaders,Project leaders,8,,,,This group contains all project leaders,1,Jon Doe
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
</TabItem>
|
|
108
|
+
<TabItem value="Markdown">
|
|
109
|
+
|
|
110
|
+
```md
|
|
111
|
+
# spo group add --webUrl "https://contoso.sharepoint.com/sites/project-x" --name "Project leaders" --description "This group contains all project leaders"
|
|
112
|
+
|
|
113
|
+
Date: 10/3/2023
|
|
114
|
+
|
|
115
|
+
## Project leaders (40)
|
|
116
|
+
|
|
117
|
+
Property | Value
|
|
118
|
+
---------|-------
|
|
119
|
+
Id | 40
|
|
120
|
+
IsHiddenInUI | false
|
|
121
|
+
LoginName | Project leaders
|
|
122
|
+
Title | Project leaders
|
|
123
|
+
PrincipalType | 8
|
|
124
|
+
AllowMembersEditMembership | false
|
|
125
|
+
AllowRequestToJoinLeave | false
|
|
126
|
+
AutoAcceptRequestToJoinLeave | false
|
|
127
|
+
Description | This group contains all project leaders
|
|
128
|
+
OnlyAllowMembersViewMembership | true
|
|
129
|
+
OwnerTitle | Jon Doe
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
</TabItem>
|
|
133
|
+
</Tabs>
|