@pnp/cli-microsoft365 5.9.0-beta.1e08e6c → 5.9.0-beta.1f313f7

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.
Files changed (89) hide show
  1. package/dist/Command.js +16 -2
  2. package/dist/m365/commands/status.js +6 -1
  3. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  4. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  5. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  6. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  7. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  8. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  9. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  10. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  11. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  12. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  13. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  14. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  15. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  16. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  17. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  18. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  19. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  20. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  21. package/dist/m365/spo/commands/field/field-add.js +26 -1
  22. package/dist/m365/spo/commands/field/field-set.js +23 -13
  23. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  24. package/dist/m365/spo/commands/list/list-webhook-get.js +2 -3
  25. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  26. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  27. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  28. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  29. package/dist/m365/spo/commands/listitem/listitem-list.js +27 -11
  30. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  31. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  32. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  33. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  34. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  35. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +14 -6
  36. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  37. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  38. package/dist/m365/spo/commands.js +2 -0
  39. package/dist/m365/todo/commands/list/list-get.js +89 -0
  40. package/dist/m365/todo/commands/task/task-get.js +108 -0
  41. package/dist/m365/todo/commands.js +2 -0
  42. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  43. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  44. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  45. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  46. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  47. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  48. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  49. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  50. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  51. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  52. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  53. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  54. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  55. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  56. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  57. package/docs/docs/cmd/spo/field/field-set.md +11 -2
  58. package/docs/docs/cmd/spo/list/list-webhook-get.md +1 -1
  59. package/docs/docs/cmd/spo/list/list-webhook-set.md +2 -2
  60. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  61. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  62. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  63. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  64. package/docs/docs/cmd/spo/listitem/listitem-list.md +12 -3
  65. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  66. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  67. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  68. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  69. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  70. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +11 -2
  71. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  72. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  73. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  74. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  75. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  76. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  77. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  78. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  79. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  80. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  81. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  82. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  83. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  84. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  85. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  86. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  87. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  88. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  89. package/package.json +9 -6
@@ -31,3 +31,48 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
31
31
  ```sh
32
32
  m365 planner plan list --ownerGroupName "My Planner Group"
33
33
  ```
34
+
35
+ ## Response
36
+
37
+ === "JSON"
38
+
39
+ ```json
40
+ [
41
+ {
42
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
43
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
44
+ "title": "My Planner Plan",
45
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
46
+ "createdBy": {
47
+ "user": {
48
+ "displayName": null,
49
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
50
+ },
51
+ "application": {
52
+ "displayName": null,
53
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
54
+ }
55
+ },
56
+ "container": {
57
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
58
+ "type": "group",
59
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
60
+ }
61
+ }
62
+ ]
63
+ ```
64
+
65
+ === "Text"
66
+
67
+ ```text
68
+ id title createdDateTime owner
69
+ ---------------------------- --------------- ---------------------------- ------------------------------------
70
+ xqQg5FS2LkCp935s-FIFm2QAFkHM My Planner Plan 2015-03-30T18:36:49.2407981Z ebf3b108-5234-4e22-b93d-656d7dae5874
71
+ ```
72
+
73
+ === "CSV"
74
+
75
+ ```csv
76
+ id,title,createdDateTime,owner
77
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
78
+ ```
@@ -46,3 +46,7 @@ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My P
46
46
  ```sh
47
47
  m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
48
48
  ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success.
@@ -16,20 +16,7 @@ m365 spfx project rename [options]
16
16
  `--generateNewId`
17
17
  : Generate a new solution ID for the project
18
18
 
19
- `-h, --help`
20
- : output usage information
21
-
22
- `--query [query]`
23
- : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
24
-
25
- `-o, --output [output]`
26
- : Output type. `json,text,csv,md`. Default `json`
27
-
28
- `--verbose`
29
- : Runs command with verbose logging
30
-
31
- `--debug`
32
- : Runs command with debug logging
19
+ --8<-- "docs/cmd/_global.md"
33
20
 
34
21
  !!! important
35
22
  Run this command in the folder where the project that you want to rename is located.
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0-beta.1).
35
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0-beta.2).
36
36
 
37
37
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
38
 
@@ -14,7 +14,13 @@ m365 spo contenttype add [options]
14
14
  : Absolute URL of the site where the content type should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type should be created (if it should be created as a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id <id>`
20
26
  : The ID of the content type. Determines the parent content type
@@ -44,12 +50,24 @@ Create a site content type that inherits from the List item content type
44
50
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types'
45
51
  ```
46
52
 
47
- Create a list content type that inherits from the List item content type
53
+ Create a list (retrieved by Title) content type that inherits from the List item content type
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
51
57
  ```
52
58
 
59
+ Create a list (retrieved by ID) content type that inherits from the List item content type
60
+
61
+ ```sh
62
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
63
+ ```
64
+
65
+ Create a list (retrieved by URL) content type that inherits from the List item content type
66
+
67
+ ```sh
68
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
69
+ ```
70
+
53
71
  ## More information
54
72
 
55
73
  - Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14))
@@ -14,7 +14,13 @@ m365 spo contenttype field remove [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --contentTypeId <contentTypeId>`
20
26
  : The ID of the content type to remove the column from
@@ -32,20 +38,32 @@ m365 spo contenttype field remove [options]
32
38
 
33
39
  ## Examples
34
40
 
35
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
41
+ Remove column with a specific ID from a content type with a specific ID from a specific site.
36
42
 
37
43
  ```sh
38
44
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --confirm
39
45
  ```
40
46
 
41
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_ updating child content types
47
+ Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types
42
48
 
43
49
  ```sh
44
50
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
45
51
  ```
46
52
 
47
- Remove fieldLink with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from list content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
53
+ Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site.
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
51
57
  ```
58
+
59
+ Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site.
60
+
61
+ ```sh
62
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
63
+ ```
64
+
65
+ Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site.
66
+
67
+ ```sh
68
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
69
+ ```
@@ -14,7 +14,13 @@ m365 spo contenttype get [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id [id]`
20
26
  : The ID of the content type to retrieve. Specify either id or name but not both
@@ -39,11 +45,23 @@ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-s
39
45
  Retrieve site content type by name
40
46
 
41
47
  ```sh
42
- m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name "Document"
48
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document'
43
49
  ```
44
50
 
45
- Retrieve list content type
51
+ Retrieve list (retrieved by Title) content type
46
52
 
47
53
  ```sh
48
54
  m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F
49
55
  ```
56
+
57
+ Retrieve list (retrieved by ID) content type
58
+
59
+ ```sh
60
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
61
+ ```
62
+
63
+ Retrieve list (retrieved by URL) content type
64
+
65
+ ```sh
66
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
67
+ ```
@@ -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 `listId` but not both
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 `listId` but not both
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
@@ -51,6 +54,12 @@ Update the title of the list column specified by its ID
51
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'
52
55
  ```
53
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
+
54
63
  Update column formatting of the specified list column
55
64
 
56
65
  ```sh
@@ -22,7 +22,7 @@ m365 spo list webhook get [options]
22
22
  `--listUrl [listUrl]`
23
23
  : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
- `-i, --id [id]`
25
+ `-i, --id <id>`
26
26
  : ID of the webhook.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
@@ -22,14 +22,14 @@ 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 [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
33
 
34
34
  --8<-- "docs/cmd/_global.md"
35
35
 
@@ -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 `listTitle` but not both
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 `listTitle` but not both
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 from which to retrieve the item. Specify listId or listTitle but not both
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 from which to retrieve the item. Specify listId or listTitle but not both
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 from which to retrieve the item. Specify `listId` or `listTitle` but not both
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 from which to retrieve the item. Specify `listId` or `listTitle` but not both
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
- : The ID of the list where the item is located. Specify `listId` or `listTitle` but not both
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
- : The title of the list where the item is located. Specify `listId` or `listTitle` but not both
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
+
@@ -19,11 +19,14 @@ m365 spo listitem list [options]
19
19
  `--id [id]`
20
20
  : (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
21
21
 
22
+ `-l, --listId [listId]`
23
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
22
25
  `-t, --listTitle [listTitle]`
23
- : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
26
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
- `--title [title]`
26
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
28
+ `--listUrl [listUrl]`
29
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
27
30
 
28
31
  `-q, --camlQuery [camlQuery]`
29
32
  : CAML query to use to query the list of items with
@@ -91,3 +94,9 @@ From a list named _Demo List_ get the second batch of 10 items
91
94
  ```sh
92
95
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
93
96
  ```
97
+
98
+ Get all items from a list by server-relative URL
99
+
100
+ ```sh
101
+ m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
102
+ ```
@@ -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 `listTitle` but not both
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 `listTitle` but not both
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, --id <id>`
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" --id 1 --date 2012-03-14
48
51
  ```
49
52
 
50
- Declare a document with id _1_ as a record with record declaration date _September 3, 2013_ in list with id _ea8e1356-5910-abc9-bc05-2408198057fc_ located in site _https://contoso.sharepoint.com/sites/project-x_
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 --listId ea8e1356-5910-abc9-bc05-2408198057fc --id 1 --date 2013-09-03
56
+ m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Demo List' --id 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 `listTitle` but not both
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 `listTitle` but not both
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' --id 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
- : List id of the list to remove. Specify either `listId` or `listTitle` but not both
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 to remove. Specify either `listId` or `listTitle` but not both
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
+ ```