@pnp/cli-microsoft365 5.9.0-beta.60e454b → 5.9.0-beta.77d7f6b

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 (43) hide show
  1. package/dist/Command.js +16 -2
  2. package/dist/m365/aad/commands/app/app-add.js +37 -13
  3. package/dist/m365/commands/status.js +6 -1
  4. package/dist/m365/outlook/commands/mail/mail-send.js +54 -30
  5. package/dist/m365/pp/commands/card/card-get.js +110 -0
  6. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  7. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  8. package/dist/m365/pp/commands.js +3 -0
  9. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  10. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  11. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  12. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  13. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  14. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  15. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  16. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  17. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  18. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  19. package/dist/m365/spo/commands.js +1 -0
  20. package/dist/m365/todo/commands/task/task-add.js +55 -3
  21. package/docs/docs/_clisettings.md +19 -0
  22. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  23. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  24. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  25. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  26. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  27. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  28. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  29. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  30. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  31. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  32. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  33. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  34. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  35. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  36. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  37. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  38. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  39. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  40. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  41. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  42. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  43. package/package.json +3 -1
@@ -55,3 +55,78 @@ Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Gro
55
55
  ```sh
56
56
  m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ === "JSON"
62
+
63
+ ``` json
64
+ {
65
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
66
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
67
+ "title": "My Planner Plan",
68
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
69
+ "createdBy": {
70
+ "user": {
71
+ "displayName": null,
72
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
73
+ },
74
+ "application": {
75
+ "displayName": null,
76
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
77
+ }
78
+ },
79
+ "container": {
80
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
81
+ "type": "group",
82
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
83
+ },
84
+ "sharedWith": {
85
+ "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
86
+ "6463a5ce-2119-4198-9f2a-628761df4a62": true
87
+ },
88
+ "categoryDescriptions": {
89
+ "category1": null,
90
+ "category2": null,
91
+ "category3": null,
92
+ "category4": null,
93
+ "category5": null,
94
+ "category6": null,
95
+ "category7": null,
96
+ "category8": null,
97
+ "category9": null,
98
+ "category10": null,
99
+ "category11": null,
100
+ "category12": null,
101
+ "category13": null,
102
+ "category14": null,
103
+ "category15": null,
104
+ "category16": null,
105
+ "category17": null,
106
+ "category18": null,
107
+ "category19": null,
108
+ "category20": null,
109
+ "category21": null,
110
+ "category22": null,
111
+ "category23": null,
112
+ "category24": null,
113
+ "category25": null
114
+ }
115
+ }
116
+ ```
117
+
118
+ === "Text"
119
+
120
+ ``` text
121
+ createdDateTime: 2015-03-30T18:36:49.2407981Z
122
+ id : xqQg5FS2LkCp935s-FIFm2QAFkHM
123
+ owner : ebf3b108-5234-4e22-b93d-656d7dae5874
124
+ title : My Planner Plan
125
+ ```
126
+
127
+ === "CSV"
128
+
129
+ ``` text
130
+ id,title,createdDateTime,owner
131
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
132
+ ```
@@ -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
+ ``` text
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.
@@ -0,0 +1,51 @@
1
+ # pp card get
2
+
3
+ Gets a specific Microsoft Power Platform card in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ pp card get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i, --id [id]`
17
+ : The id of the card. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The name of the card. Specify either `id` or `name` but not both.
21
+
22
+ `-a, --asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Get a specific card in a specific environment based on name
30
+
31
+ ```sh
32
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card"
33
+ ```
34
+
35
+ Get a specific card in a specific environment based on name as admin
36
+
37
+ ```sh
38
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --asAdmin
39
+ ```
40
+
41
+ Get a specific card in a specific environment based on id
42
+
43
+ ```sh
44
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa"
45
+ ```
46
+
47
+ Get a specific card in a specific environment based on id as admin
48
+
49
+ ```sh
50
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --asAdmin
51
+ ```
@@ -0,0 +1,24 @@
1
+ # pp gateway get
2
+
3
+ Get information about the specified gateway
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp gateway get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the Gateway.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get information about the specified gateway.
21
+
22
+ ```sh
23
+ m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
24
+ ```
@@ -0,0 +1,51 @@
1
+ # pp solution get
2
+
3
+ Gets a specific solution in a given environment.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp solution get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i --id [id]`
17
+ : The ID of the solution. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
21
+
22
+ `-a, --asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Gets a specific solution in a specific environment based on name
30
+
31
+ ```sh
32
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default"
33
+ ```
34
+
35
+ Gets a specific solution in a specific environment based on name as Admin
36
+
37
+ ```sh
38
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default" --asAdmin
39
+ ```
40
+
41
+ Gets a specific solution in a specific environment based on id
42
+
43
+ ```sh
44
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
45
+ ```
46
+
47
+ Gets a specific solution in a specific environment based on id as Admin
48
+
49
+ ```sh
50
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
51
+ ```
@@ -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.
@@ -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
+ ```
@@ -11,13 +11,16 @@ m365 spo list roleinheritance break [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve information for. Specify either id or title but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve information for. Specify either id or title but not both
20
+ : Title of the list. 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, --clearExistingPermissions`
23
26
  : Flag if used clears all roles from the list
@@ -30,26 +33,26 @@ By default, when breaking permissions inheritance, the list will retain existing
30
33
 
31
34
  ## Examples
32
35
 
33
- Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Break inheritance of list by title in a specific site
34
37
 
35
38
  ```sh
36
39
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
37
40
  ```
38
41
 
39
- Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Break inheritance of list by id in a specific site
40
43
 
41
44
  ```sh
42
45
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
43
46
  ```
44
47
 
45
- Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
48
+ Break inheritance of list by title located in a specific site and clearing the existing permissions
46
49
 
47
50
  ```sh
48
51
  m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
49
52
  ```
50
53
 
51
- Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
54
+ Break inheritance of list by url in a specific site and clearing the existing permissions
52
55
 
53
56
  ```sh
54
- m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
57
+ m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl '/sites/project-x/lists/events' --clearExistingPermissions
55
58
  ```
@@ -11,26 +11,35 @@ m365 spo list roleinheritance reset [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either id or title but not both
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 id or title but not both
20
+ : Title of the list. 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
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
25
28
 
26
- Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
29
+ Restores role inheritance of a specific list by id in a specific site
27
30
 
28
31
  ```sh
29
32
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
30
33
  ```
31
34
 
32
- Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ Restores role inheritance of a specific list by title in a specific site
33
36
 
34
37
  ```sh
35
38
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
36
39
  ```
40
+
41
+ Restores role inheritance of a specific list by url in a specific site
42
+
43
+ ```sh
44
+ m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/events'
45
+ ```
@@ -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
+ ```
@@ -11,26 +11,53 @@ m365 todo task add [options]
11
11
  ## Options
12
12
 
13
13
  `-t, --title <title>`
14
- : The title of the task
14
+ : The title of the task.
15
15
 
16
16
  `--listName [listName]`
17
- : The name of the list in which to create the task. Specify either `listName` or `listId` but not both
17
+ : The name of the list in which to create the task. Specify either `listName` or `listId` but not both.
18
18
 
19
19
  `--listId [listId]`
20
- : The id of the list in which to create the task. Specify either `listName` or `listId` but not both
20
+ : The id of the list in which to create the task. Specify either `listName` or `listId` but not both.
21
+
22
+ `--bodyContent [bodyContent]`
23
+ : The body content of the task. In the UI this is called 'notes'.
24
+
25
+ `--bodyContentType [bodyContentType]`
26
+ : The type of the body content. Possible values are `text` and `html`. Default is `text`.
27
+
28
+ `--dueDateTime [dueDateTime]`
29
+ : The date when the task is due. This should be defined as a valid ISO 8601 string in the UTC time zone. Only date value is needed, time value is always ignored.
30
+
31
+ `--importance [importance]`
32
+ : The importance of the task. Possible values are: `low`, `normal`, `high`. Default is `normal`.
33
+
34
+ `--reminderDateTime [reminderDateTime]`
35
+ : The date and time for a reminder alert of the task to occur. This should be defined as a valid ISO 8601 string in the UTC time zone.
21
36
 
22
37
  --8<-- "docs/cmd/_global.md"
23
38
 
24
39
  ## Examples
25
40
 
26
- Add a task with title _New task_ to Microsoft To Do tasks list with the name _My task list_
41
+ Add a task to Microsoft To Do tasks list with with a specific name
27
42
 
28
43
  ```sh
29
44
  m365 todo task add --title "New task" --listName "My task list"
30
45
  ```
31
46
 
32
- Add a task with title _New task_ to Microsoft To Do tasks list with the id `AQMkADlhMTRkOGEzLWQ1M2QtNGVkNS04NjdmLWU0NzJhMjZmZWNmMwAuAAADKvwNgAMNPE_zFNRJXVrU1wEAhHKQZHItDEOVCn8U3xuA2AABmQeVPwAAAA==`
47
+ Add a task to a Microsoft To Do tasks list with a specific id
33
48
 
34
49
  ```sh
35
50
  m365 todo task add --title "New task" --listId "AQMkADlhMTRkOGEzLWQ1M2QtNGVkNS04NjdmLWU0NzJhMjZmZWNmMwAuAAADKvwNgAMNPE_zFNRJXVrU1wEAhHKQZHItDEOVCn8U3xuA2AABmQeVPwAAAA=="
36
51
  ```
52
+
53
+ Create a new task with bodyContent and reminder and flag it as important
54
+
55
+ ```sh
56
+ m365 todo task add --title "New task" --listName "My task list" --bodyContent "I should not forget this" --reminderDateTime 2023-01-01T12:00:00Z --importance high
57
+ ```
58
+
59
+ Create a new task with a specific due date
60
+
61
+ ```sh
62
+ m365 todo task add --title "New task" --listId "AQMkADlhMTRkOGEzLWQ1M2QtNGVkNS04NjdmLWU0NzJhMjZmZWNmMwAuAAADKvwNgAMNPE_zFNRJXVrU1wEAhHKQZHItDEOVCn8U3xuA2AABmQeVPwAAAA==" --dueDateTime 2023-01-01
63
+ ```