@pnp/cli-microsoft365 6.0.0-beta.a0a813f → 6.0.0-beta.a2ec37b
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Command.js +16 -2
- package/dist/m365/aad/commands/app/app-list.js +38 -0
- package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
- package/dist/m365/aad/commands.js +2 -0
- package/dist/m365/commands/status.js +6 -1
- package/dist/m365/outlook/commands/mail/mail-send.js +54 -30
- package/dist/m365/outlook/commands/message/message-get.js +97 -0
- package/dist/m365/outlook/commands.js +1 -0
- package/dist/m365/planner/commands/plan/plan-get.js +5 -20
- package/dist/m365/pp/commands/card/card-get.js +110 -0
- package/dist/m365/pp/commands/card/card-remove.js +130 -0
- package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
- package/dist/m365/pp/commands/solution/solution-get.js +117 -0
- package/dist/m365/pp/commands.js +4 -0
- package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
- package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
- package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
- package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
- package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
- package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
- package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
- package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
- package/dist/m365/spo/commands/field/field-add.js +26 -1
- package/dist/m365/spo/commands/field/field-set.js +23 -13
- package/dist/m365/spo/commands/folder/folder-list.js +35 -12
- package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
- package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
- package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
- package/dist/m365/spo/commands/list/list-webhook-get.js +2 -3
- package/dist/m365/spo/commands/list/list-webhook-list.js +4 -28
- package/dist/m365/spo/commands/list/list-webhook-set.js +11 -12
- package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
- package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
- package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
- package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
- package/dist/m365/spo/commands/listitem/listitem-list.js +21 -11
- package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
- package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
- package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
- package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
- package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
- package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
- package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
- package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
- package/dist/m365/spo/commands/site/site-add.js +4 -11
- package/dist/m365/spo/commands/{hubsite/hubsite-connect.js → site/site-hubsite-connect.js} +10 -10
- package/dist/m365/spo/commands/{hubsite/hubsite-disconnect.js → site/site-hubsite-disconnect.js} +13 -13
- package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
- package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
- package/dist/m365/spo/commands.js +5 -3
- package/dist/m365/teams/commands/team/team-set.js +0 -7
- package/dist/m365/todo/commands/list/list-get.js +89 -0
- package/dist/m365/todo/commands/task/task-add.js +55 -3
- package/dist/m365/todo/commands/task/task-get.js +108 -0
- package/dist/m365/todo/commands.js +2 -0
- package/docs/docs/_clisettings.md +18 -0
- package/docs/docs/cmd/aad/app/app-list.md +149 -0
- package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
- package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +3 -0
- package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
- package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
- package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
- package/docs/docs/cmd/outlook/message/message-get.md +48 -0
- package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
- package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
- package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
- package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
- package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
- package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
- package/docs/docs/cmd/planner/plan/plan-get.md +75 -6
- package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
- package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
- package/docs/docs/cmd/planner/task/task-get.md +0 -3
- package/docs/docs/cmd/pp/card/card-get.md +51 -0
- package/docs/docs/cmd/pp/card/card-remove.md +82 -0
- package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
- package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
- package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
- package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
- package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
- package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
- package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
- package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
- package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
- package/docs/docs/cmd/spo/field/field-add.md +20 -2
- package/docs/docs/cmd/spo/field/field-set.md +15 -3
- package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
- package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
- package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
- package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
- package/docs/docs/cmd/spo/list/list-view-set.md +14 -3
- package/docs/docs/cmd/spo/list/list-webhook-get.md +1 -1
- package/docs/docs/cmd/spo/list/list-webhook-list.md +3 -9
- package/docs/docs/cmd/spo/list/list-webhook-set.md +11 -4
- package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
- package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
- package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
- package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
- package/docs/docs/cmd/spo/listitem/listitem-list.md +10 -1
- package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
- package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
- package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
- package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
- package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
- package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
- package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +5 -10
- package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
- package/docs/docs/cmd/spo/site/site-add.md +0 -3
- package/docs/docs/cmd/spo/{hubsite/hubsite-connect.md → site/site-hubsite-connect.md} +4 -4
- package/docs/docs/cmd/spo/{hubsite/hubsite-disconnect.md → site/site-hubsite-disconnect.md} +7 -7
- package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
- package/docs/docs/cmd/spo/term/term-add.md +5 -0
- package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
- package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
- package/docs/docs/cmd/teams/team/team-clone.md +0 -3
- package/docs/docs/cmd/teams/team/team-set.md +0 -3
- package/docs/docs/cmd/tenant/id/id-get.md +20 -0
- package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
- package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
- package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
- package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
- package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
- package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
- package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
- package/docs/docs/cmd/todo/list/list-get.md +61 -0
- package/docs/docs/cmd/todo/task/task-add.md +32 -5
- package/docs/docs/cmd/todo/task/task-get.md +75 -0
- package/package.json +12 -6
|
@@ -77,12 +77,13 @@ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for
|
|
|
77
77
|
m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
-
Note, how the `clientSideComponentProperties` option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
|
|
81
|
-
|
|
82
80
|
The `--rights` option accepts **case-sensitive** values.
|
|
83
81
|
|
|
84
82
|
Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.
|
|
85
83
|
|
|
84
|
+
!!! warning "Escaping JSON in PowerShell"
|
|
85
|
+
When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
|
|
86
|
+
|
|
86
87
|
## Examples
|
|
87
88
|
|
|
88
89
|
Updates tenant-wide SharePoint Framework Application Customizer extension properties in site _https://contoso.sharepoint.com/sites/test_
|
|
@@ -14,7 +14,13 @@ m365 spo field add [options]
|
|
|
14
14
|
: Absolute URL of the site where the field should be created
|
|
15
15
|
|
|
16
16
|
`-l, --listTitle [listTitle]`
|
|
17
|
-
: Title of the list where the field should be created (if it should be created as a list column)
|
|
17
|
+
: Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
|
|
18
|
+
|
|
19
|
+
`--listId [listId]`
|
|
20
|
+
: ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
|
|
18
24
|
|
|
19
25
|
`-x, --xml <xml>`
|
|
20
26
|
: CAML field definition
|
|
@@ -36,7 +42,7 @@ Create a date time site column
|
|
|
36
42
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
|
|
37
43
|
```
|
|
38
44
|
|
|
39
|
-
Create a URL list column
|
|
45
|
+
Create a URL list column to a list retrieved by Title
|
|
40
46
|
|
|
41
47
|
```sh
|
|
42
48
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
|
|
@@ -48,6 +54,18 @@ Create a URL list column and add it to all content types
|
|
|
48
54
|
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
|
|
49
55
|
```
|
|
50
56
|
|
|
57
|
+
Create a URL list column to a list retrieved by ID
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Create a date time list column to a list retrieved by URL
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
|
|
67
|
+
```
|
|
68
|
+
|
|
51
69
|
## More information
|
|
52
70
|
|
|
53
71
|
- AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)
|
|
@@ -14,10 +14,13 @@ m365 spo field set [options]
|
|
|
14
14
|
: Absolute URL of the site where the field is located
|
|
15
15
|
|
|
16
16
|
`--listId [listId]`
|
|
17
|
-
: ID of the list where the field is located (if list column). Specify `listTitle` or `
|
|
17
|
+
: ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
|
|
18
18
|
|
|
19
19
|
`--listTitle [listTitle]`
|
|
20
|
-
: Title of the list where the field is located (if list column). Specify `listTitle` or `
|
|
20
|
+
: Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
|
|
21
24
|
|
|
22
25
|
`-i, --id [id]`
|
|
23
26
|
: ID of the field to update. Specify `id` or `title` but not both
|
|
@@ -34,6 +37,9 @@ m365 spo field set [options]
|
|
|
34
37
|
|
|
35
38
|
Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
|
|
36
39
|
|
|
40
|
+
!!! warning "Escaping JSON in PowerShell"
|
|
41
|
+
When updating column formatting for a field with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
|
|
42
|
+
|
|
37
43
|
## Examples
|
|
38
44
|
|
|
39
45
|
Update the title of the site column specified by its internal name and push changes to existing lists
|
|
@@ -48,8 +54,14 @@ Update the title of the list column specified by its ID
|
|
|
48
54
|
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
|
|
49
55
|
```
|
|
50
56
|
|
|
57
|
+
Update the description of a column specified by the ID on a list retrieved by the URL
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
|
|
61
|
+
```
|
|
62
|
+
|
|
51
63
|
Update column formatting of the specified list column
|
|
52
64
|
|
|
53
65
|
```sh
|
|
54
|
-
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '
|
|
66
|
+
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
|
|
55
67
|
```
|
|
@@ -16,6 +16,9 @@ m365 spo folder list [options]
|
|
|
16
16
|
`-p, --parentFolderUrl <parentFolderUrl>`
|
|
17
17
|
: Site-relative URL of the parent folder
|
|
18
18
|
|
|
19
|
+
`-r, --recursive`
|
|
20
|
+
: Set to retrieve nested folders
|
|
21
|
+
|
|
19
22
|
--8<-- "docs/cmd/_global.md"
|
|
20
23
|
|
|
21
24
|
## Examples
|
|
@@ -25,3 +28,45 @@ Gets list of folders under a parent folder with site-relative url _/Shared Docum
|
|
|
25
28
|
```sh
|
|
26
29
|
m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
|
|
27
30
|
```
|
|
31
|
+
|
|
32
|
+
Gets recursive list of folders under a specific folder on a specific site
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Response
|
|
39
|
+
|
|
40
|
+
=== "JSON"
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
[
|
|
44
|
+
{
|
|
45
|
+
"Exists": true,
|
|
46
|
+
"IsWOPIEnabled": false,
|
|
47
|
+
"ItemCount": 9,
|
|
48
|
+
"Name": "Folder A",
|
|
49
|
+
"ProgID": null,
|
|
50
|
+
"ServerRelativeUrl": "/Shared Documents/Folder A",
|
|
51
|
+
"TimeCreated": "2022-04-26T12:30:56Z",
|
|
52
|
+
"TimeLastModified": "2022-04-26T12:50:14Z",
|
|
53
|
+
"UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
|
|
54
|
+
"WelcomePage": ""
|
|
55
|
+
}
|
|
56
|
+
]
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
=== "Text"
|
|
60
|
+
|
|
61
|
+
```text
|
|
62
|
+
Name ServerRelativeUrl
|
|
63
|
+
------- -------------------------
|
|
64
|
+
Folder A /Shared Documents/Folder A
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
=== "CSV"
|
|
68
|
+
|
|
69
|
+
```csv
|
|
70
|
+
Name,ServerRelativeUrl
|
|
71
|
+
Folder A,/Shared Documents/Folder A
|
|
72
|
+
```
|
|
@@ -37,3 +37,9 @@ Break the inheritance of a folder with a specified server-relative URL. It will
|
|
|
37
37
|
```sh
|
|
38
38
|
m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --clearExistingPermissions --confirm
|
|
39
39
|
```
|
|
40
|
+
|
|
41
|
+
Break the inheritance of the specified root folder for the library with a specified server-relative URL. It will clear the existing permissions of the root folder. It will **not** prompt for confirmation before breaking the inheritance.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --clearExistingPermissions --confirm
|
|
45
|
+
```
|
|
@@ -34,3 +34,9 @@ Reset inheritance of folder with server-relative url _/sites/project-x/Shared Do
|
|
|
34
34
|
```sh
|
|
35
35
|
m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
|
|
36
36
|
```
|
|
37
|
+
|
|
38
|
+
Reset inheritance of the specified root folder for the library with the server-relative url _/sites/project-x/Shared Documents located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --confirm
|
|
42
|
+
```
|
|
@@ -17,8 +17,8 @@ m365 spo hubsite register [options]
|
|
|
17
17
|
|
|
18
18
|
## Remarks
|
|
19
19
|
|
|
20
|
-
!!!
|
|
21
|
-
|
|
20
|
+
!!! important
|
|
21
|
+
To use this command you must be a Global or SharePoint administrator.
|
|
22
22
|
|
|
23
23
|
If the specified site collection is already registered as a hub site, you will get a `This site is already a HubSite.` error.
|
|
24
24
|
|
|
@@ -20,8 +20,8 @@ m365 spo hubsite unregister [options]
|
|
|
20
20
|
|
|
21
21
|
## Remarks
|
|
22
22
|
|
|
23
|
-
!!!
|
|
24
|
-
|
|
23
|
+
!!! important
|
|
24
|
+
To use this command you must be a Global or SharePoint administrator.
|
|
25
25
|
|
|
26
26
|
If the specified site collection is not registered as a hub site, you will get a `hubSiteId` error.
|
|
27
27
|
|
|
@@ -33,6 +33,9 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
|
|
|
33
33
|
|
|
34
34
|
When updating list formatting, the value of the CustomFormatter property must be XML-escaped, eg. `<` instead of `<`.
|
|
35
35
|
|
|
36
|
+
!!! warning "Escaping JSON in PowerShell"
|
|
37
|
+
When updating list view formatting for a view with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
|
|
38
|
+
|
|
36
39
|
## Examples
|
|
37
40
|
|
|
38
41
|
Update the title of the list view specified by its name
|
|
@@ -49,6 +52,14 @@ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x -
|
|
|
49
52
|
|
|
50
53
|
Update view formatting of the specified list view
|
|
51
54
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
+
=== "PowerShell"
|
|
56
|
+
|
|
57
|
+
```sh
|
|
58
|
+
m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter '{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] <= @now, ''sp-field-severity--severeWarning'', '''')\"}'
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
=== "Bash"
|
|
62
|
+
|
|
63
|
+
```sh
|
|
64
|
+
m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter "{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] <= @now, 'sp-field-severity--severeWarning', '')\"}"
|
|
65
|
+
```
|
|
@@ -14,19 +14,13 @@ m365 spo list webhook list [options]
|
|
|
14
14
|
: URL of the site where the list is located.
|
|
15
15
|
|
|
16
16
|
`-i, --listId [listId]`
|
|
17
|
-
: ID of the list. Specify either `
|
|
17
|
+
: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
|
|
18
18
|
|
|
19
19
|
`-t, --listTitle [listTitle]`
|
|
20
|
-
: Title of the list. Specify either `
|
|
20
|
+
: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
|
|
21
21
|
|
|
22
22
|
`--listUrl [listUrl]`
|
|
23
|
-
: Server- or site-relative URL of the list. Specify either `
|
|
24
|
-
|
|
25
|
-
`--id [id]`
|
|
26
|
-
: (deprecated. Use `listId` instead) ID of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
|
|
27
|
-
|
|
28
|
-
`--title [title]`
|
|
29
|
-
: (deprecated. Use `listTitle` instead) Title of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
|
|
23
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
|
|
30
24
|
|
|
31
25
|
--8<-- "docs/cmd/_global.md"
|
|
32
26
|
|
|
@@ -22,14 +22,17 @@ m365 spo list webhook set [options]
|
|
|
22
22
|
`--listUrl [listUrl]`
|
|
23
23
|
: Server- or site-relative URL of the list. Specify either `listId`, `listTitle` or `listUrl`.
|
|
24
24
|
|
|
25
|
-
`-i, --id
|
|
25
|
+
`-i, --id <id>`
|
|
26
26
|
: ID of the webhook to update.
|
|
27
27
|
|
|
28
28
|
`-n, --notificationUrl [notificationUrl]`
|
|
29
29
|
: The new notification url.
|
|
30
30
|
|
|
31
31
|
`-e, --expirationDateTime [expirationDateTime]`
|
|
32
|
-
: The new expiration date.
|
|
32
|
+
: The new expiration date. _Note: Expiration Time cannot be more than 6 months in future_
|
|
33
|
+
|
|
34
|
+
`-c, --clientState [clientState]`
|
|
35
|
+
: A client state information that will be passed through notifications.
|
|
33
36
|
|
|
34
37
|
--8<-- "docs/cmd/_global.md"
|
|
35
38
|
|
|
@@ -51,8 +54,12 @@ Update the expiration date of a webhook with a specific ID attached to a list wi
|
|
|
51
54
|
m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --expirationDateTime 2018-10-09T18:15
|
|
52
55
|
```
|
|
53
56
|
|
|
54
|
-
Update the notification url of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
|
|
57
|
+
Update the notification url and clientState of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
|
|
55
58
|
|
|
56
59
|
```sh
|
|
57
|
-
m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02
|
|
60
|
+
m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02 --clientState 'My client state'
|
|
58
61
|
```
|
|
62
|
+
|
|
63
|
+
## Respone
|
|
64
|
+
|
|
65
|
+
The command won't return a response on success.
|
|
@@ -14,10 +14,13 @@ m365 spo listitem add [options]
|
|
|
14
14
|
: URL of the site where the item should be added
|
|
15
15
|
|
|
16
16
|
`-l, --listId [listId]`
|
|
17
|
-
: ID of the list where the item should be added. Specify `listId` or `
|
|
17
|
+
: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
18
18
|
|
|
19
19
|
`-t, --listTitle [listTitle]`
|
|
20
|
-
: Title of the list where the item should be added. Specify `listId` or `
|
|
20
|
+
: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
24
|
|
|
22
25
|
`-c, --contentType [contentType]`
|
|
23
26
|
: The name or the ID of the content type to associate with the new item
|
|
@@ -64,3 +67,9 @@ Add an item with Title _Demo Hyperlink Field_ and a hyperlink field named _Custo
|
|
|
64
67
|
```sh
|
|
65
68
|
m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --CustomHyperlink "https://www.bing.com, Bing"
|
|
66
69
|
```
|
|
70
|
+
|
|
71
|
+
Add an item with a specific title to a list retrieved by server-relative URL in a specific site
|
|
72
|
+
|
|
73
|
+
```sh
|
|
74
|
+
m365 spo listitem add --contentType Item --listUrl /sites/project-x/Documents --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Item"
|
|
75
|
+
```
|
|
@@ -14,10 +14,13 @@ m365 spo listitem attachment list [options]
|
|
|
14
14
|
URL of the site from which the item should be retrieved
|
|
15
15
|
|
|
16
16
|
`--listId [listId]`
|
|
17
|
-
: ID of the list
|
|
17
|
+
: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
18
18
|
|
|
19
19
|
`--listTitle [listTitle]`
|
|
20
|
-
: Title of the list
|
|
20
|
+
: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
24
|
|
|
22
25
|
`--itemId <itemId>`
|
|
23
26
|
ID of the list item to in question
|
|
@@ -37,3 +40,9 @@ Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-
|
|
|
37
40
|
```sh
|
|
38
41
|
m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
|
|
39
42
|
```
|
|
43
|
+
|
|
44
|
+
Gets the attachments from a specific list item in a specific list obtained by server-relative URL in a specific site
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --itemId 147
|
|
48
|
+
```
|
|
@@ -17,10 +17,13 @@ m365 spo listitem get [options]
|
|
|
17
17
|
: ID of the item to retrieve.
|
|
18
18
|
|
|
19
19
|
`-l, --listId [listId]`
|
|
20
|
-
: ID of the list
|
|
20
|
+
: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
21
|
|
|
22
22
|
`-t, --listTitle [listTitle]`
|
|
23
|
-
: Title of the list
|
|
23
|
+
: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
27
|
|
|
25
28
|
`-p, --properties [properties]`
|
|
26
29
|
: Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested
|
|
@@ -50,3 +53,9 @@ Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_
|
|
|
50
53
|
```sh
|
|
51
54
|
m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
|
|
52
55
|
```
|
|
56
|
+
|
|
57
|
+
Get an item with specific properties from a list retrieved by server-relative URL in a specific site
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
|
|
61
|
+
```
|
|
@@ -17,10 +17,13 @@ m365 spo listitem isrecord [options]
|
|
|
17
17
|
: The ID of the list item to check if it is a record
|
|
18
18
|
|
|
19
19
|
`-l, --listId [listId]`
|
|
20
|
-
:
|
|
20
|
+
: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
21
|
|
|
22
22
|
`-t, --listTitle [listTitle]`
|
|
23
|
-
:
|
|
23
|
+
: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
27
|
|
|
25
28
|
--8<-- "docs/cmd/_global.md"
|
|
26
29
|
|
|
@@ -37,3 +40,10 @@ Check whether the document with id _1_ in list with id _0cd891ef-afce-4e55-b836-
|
|
|
37
40
|
```sh
|
|
38
41
|
m365 spo listitem isrecord --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
|
|
39
42
|
```
|
|
43
|
+
|
|
44
|
+
Check whether a document with a specific id in a list retrieved by server-relative URL in a specific site is a record
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo listitem isrecord --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/documents --id 1
|
|
48
|
+
```
|
|
49
|
+
|
|
@@ -16,8 +16,11 @@ m365 spo listitem list [options]
|
|
|
16
16
|
`-i, --listId [listId]`
|
|
17
17
|
: ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
|
|
18
18
|
|
|
19
|
+
`-l, --listId [listId]`
|
|
20
|
+
: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
19
22
|
`-t, --listTitle [listTitle]`
|
|
20
|
-
: Title of the list
|
|
23
|
+
: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
24
|
|
|
22
25
|
`-q, --camlQuery [camlQuery]`
|
|
23
26
|
: CAML query to use to query the list of items with
|
|
@@ -85,3 +88,9 @@ From a list named _Demo List_ get the second batch of 10 items
|
|
|
85
88
|
```sh
|
|
86
89
|
m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
|
|
87
90
|
```
|
|
91
|
+
|
|
92
|
+
Get all items from a list by server-relative URL
|
|
93
|
+
|
|
94
|
+
```sh
|
|
95
|
+
m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
|
|
96
|
+
```
|
|
@@ -14,10 +14,13 @@ m365 spo listitem record declare [options]
|
|
|
14
14
|
: URL of the site where the list is located
|
|
15
15
|
|
|
16
16
|
`-l, --listId [listId]`
|
|
17
|
-
: The ID of the list where the item is located. Specify `listId` or `
|
|
17
|
+
: The ID of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
|
|
18
18
|
|
|
19
19
|
`-t, --listTitle [listTitle]`
|
|
20
|
-
: The title of the list where the item is located. Specify `listId` or `
|
|
20
|
+
: The title of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
24
|
|
|
22
25
|
`-i, --listItemId <listItemId>`
|
|
23
26
|
: The ID of the list item to declare as record
|
|
@@ -47,8 +50,8 @@ Declare a document with id _1_ as a record with record declaration date _March 1
|
|
|
47
50
|
m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 1 --date 2012-03-14
|
|
48
51
|
```
|
|
49
52
|
|
|
50
|
-
Declare a document with id
|
|
53
|
+
Declare a document with a specific id as a record with a record declaration date a list retrieved by server-relative URL located in a specific site
|
|
51
54
|
|
|
52
55
|
```sh
|
|
53
|
-
m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --
|
|
56
|
+
m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Demo List' --listItemId 1 --date 2013-09-03
|
|
54
57
|
```
|
|
@@ -17,10 +17,13 @@ m365 spo listitem record undeclare [options]
|
|
|
17
17
|
: ID of the list item to be undeclared as a record.
|
|
18
18
|
|
|
19
19
|
`-l, --listId [listId]`
|
|
20
|
-
: The ID of the list where the item is located. Specify `listId` or `
|
|
20
|
+
: The ID of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
21
|
|
|
22
22
|
`-t, --listTitle [listTitle]`
|
|
23
|
-
: The title of the list where the item is located. Specify `listId` or `
|
|
23
|
+
: The title of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
27
|
|
|
25
28
|
--8<-- "docs/cmd/_global.md"
|
|
26
29
|
|
|
@@ -37,3 +40,9 @@ Undeclare the list item as a record with ID _1_ from list with title _List 1_ lo
|
|
|
37
40
|
```sh
|
|
38
41
|
m365 spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
|
|
39
42
|
```
|
|
43
|
+
|
|
44
|
+
Undeclare a list item with a specific id as a record from a list retrieved by server-relative URL located in a specific site
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Lists 1' --id 1
|
|
48
|
+
```
|
|
@@ -17,10 +17,13 @@ m365 spo listitem remove [options]
|
|
|
17
17
|
: The ID of the list item to remove.
|
|
18
18
|
|
|
19
19
|
`-l, --listId [listId]`
|
|
20
|
-
:
|
|
20
|
+
: ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
21
|
|
|
22
22
|
`-t, --listTitle [listTitle]`
|
|
23
|
-
: Title of the list
|
|
23
|
+
: Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
27
|
|
|
25
28
|
`--recycle`
|
|
26
29
|
: Recycle the list item
|
|
@@ -43,3 +46,9 @@ Remove the list item with ID _1_ from list with title _List 1_ located in site _
|
|
|
43
46
|
```sh
|
|
44
47
|
m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1
|
|
45
48
|
```
|
|
49
|
+
|
|
50
|
+
Remove the list item with a specific ID from a list retrieved by server-relative URL located in a specific site
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1
|
|
54
|
+
```
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# spo listitem roleassignment add
|
|
2
|
+
|
|
3
|
+
Adds a role assignment to a listitem.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem roleassignment add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the listitem is located
|
|
15
|
+
|
|
16
|
+
`--listId [listId]`
|
|
17
|
+
: ID of the list. Specify either listId, listTitle or listUrl but not multiple.
|
|
18
|
+
|
|
19
|
+
`--listTitle [listTitle]`
|
|
20
|
+
: Title of the list. Specify either listId, listTitle or listUrl but not multiple.
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Relative URL of the list. Specify either listId, listTitle or listUrl but not multiple.
|
|
24
|
+
|
|
25
|
+
`--listItemId <listItemId>`
|
|
26
|
+
: Id of the listitem to assign the role to.
|
|
27
|
+
|
|
28
|
+
`--principalId [principalId]`
|
|
29
|
+
: The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either upn, groupName or principalId.
|
|
30
|
+
|
|
31
|
+
`--upn [upn]`
|
|
32
|
+
: upn/email of user to assign role to. Specify either upn, groupName or principalId.
|
|
33
|
+
|
|
34
|
+
`--groupName [groupName]`
|
|
35
|
+
: The group name of Azure AD or SharePoint group. Specify either upn, groupName or principalId.
|
|
36
|
+
|
|
37
|
+
`--roleDefinitionId [roleDefinitionId]`
|
|
38
|
+
: ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
|
|
39
|
+
|
|
40
|
+
`--roleDefinitionName [roleDefinitionName]`
|
|
41
|
+
: Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
|
|
42
|
+
|
|
43
|
+
--8<-- "docs/cmd/_global.md"
|
|
44
|
+
|
|
45
|
+
## Examples
|
|
46
|
+
|
|
47
|
+
Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "0CD891EF-AFCE-4E55-B836-FCE03286CCCF" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl "sites/documents" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Add role assignment to specified listitem in specified list located in specified site for specified upn and specified role definition id.
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Add role assignment to specified listitem in specified list located in specified site for specified group and specified role definition id.
|
|
72
|
+
|
|
73
|
+
```sh
|
|
74
|
+
m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --groupName "someGroup" --roleDefinitionId 1073741829
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition name.
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --principalId 11 --roleDefinitionName "Full Control"
|
|
81
|
+
```
|
|
@@ -17,10 +17,13 @@ m365 spo listitem roleinheritance break [options]
|
|
|
17
17
|
: ID of the item for which to break role inheritance
|
|
18
18
|
|
|
19
19
|
`-l, --listId [listId]`
|
|
20
|
-
: ID of the list. Specify
|
|
20
|
+
: ID of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
21
21
|
|
|
22
22
|
`-t, --listTitle [listTitle]`
|
|
23
|
-
: Title of the list.
|
|
23
|
+
: Title of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
`--listUrl [listUrl]`
|
|
26
|
+
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
|
|
24
27
|
|
|
25
28
|
`-c, --clearExistingPermissions`
|
|
26
29
|
: Set to clear existing roles from the list item
|
|
@@ -54,10 +57,10 @@ Break inheritance of list item _1_ in list _someList_ located in site _https://c
|
|
|
54
57
|
m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --listItemId 1 --clearExistingPermissions
|
|
55
58
|
```
|
|
56
59
|
|
|
57
|
-
Break inheritance of list item
|
|
60
|
+
Break inheritance of a specific list item in a list retrieved by server-relative URL in a specific site and clear the existing permissions
|
|
58
61
|
|
|
59
62
|
```sh
|
|
60
|
-
m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --
|
|
63
|
+
m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --listItemId 1 --clearExistingPermissions
|
|
61
64
|
```
|
|
62
65
|
|
|
63
66
|
Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions without prompting for confirmation
|