@pnp/cli-microsoft365 5.9.0-beta.86c5624 → 5.9.0-beta.8773bb6

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 (111) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/Command.js +16 -2
  3. package/dist/m365/aad/commands/app/app-add.js +37 -13
  4. package/dist/m365/commands/status.js +6 -1
  5. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  6. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  7. package/dist/m365/pp/commands/Environment.js +3 -0
  8. package/dist/m365/pp/commands/card/card-get.js +110 -0
  9. package/dist/m365/pp/commands/card/card-list.js +68 -0
  10. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +6 -12
  11. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  12. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  13. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  14. package/dist/m365/pp/commands.js +5 -0
  15. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  16. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  17. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  18. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  22. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  23. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  26. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  27. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  28. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  29. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  30. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  31. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  32. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  33. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +129 -0
  34. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +168 -0
  35. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  36. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  37. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  38. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  39. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  40. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  41. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  42. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  43. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  44. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  45. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  46. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  47. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  48. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  49. package/dist/m365/spo/commands.js +4 -0
  50. package/dist/m365/teams/commands/channel/channel-add.js +9 -9
  51. package/dist/m365/todo/commands/list/list-get.js +89 -0
  52. package/dist/m365/todo/commands/task/task-add.js +55 -3
  53. package/dist/m365/todo/commands/task/task-set.js +53 -1
  54. package/dist/m365/todo/commands.js +1 -0
  55. package/docs/docs/_clisettings.md +19 -0
  56. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  57. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  58. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  59. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  60. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  61. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  62. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  63. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  64. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  65. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  66. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  67. package/docs/docs/cmd/pp/card/card-list.md +33 -0
  68. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  69. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  70. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  71. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  72. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  73. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  74. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  75. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  76. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  77. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  78. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +54 -0
  79. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  80. package/docs/docs/cmd/spo/list/list-contenttype-add.md +16 -7
  81. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  82. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  83. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +17 -8
  84. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  85. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  86. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  87. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  88. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  89. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  90. package/docs/docs/cmd/spo/list/list-webhook-set.md +14 -12
  91. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  92. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  93. package/docs/docs/cmd/teams/channel/channel-add.md +4 -4
  94. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  95. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  96. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  97. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  98. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  99. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  100. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  101. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  102. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  103. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  104. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  105. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  106. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  107. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  108. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  109. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  110. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  111. package/package.json +12 -4
@@ -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.
@@ -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
+ ```
@@ -26,10 +26,10 @@ Specify either `listTitle`, `listId` or `listUrl`.
26
26
  Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-n, --name [name]`
29
- The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
29
+ : The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-i, --id [id]`
32
- The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
32
+ : The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
33
33
 
34
34
  `-s, --scope [scope]`
35
35
  : The scope of which to retrieve the Event Receivers.
@@ -23,10 +23,10 @@ m365 spo eventreceiver remove [options]
23
23
  : The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
25
  `-n, --name [name]`
26
- The name. Specify either `name` or `id` but not both.
26
+ : The name. Specify either `name` or `id` but not both.
27
27
 
28
28
  `-i, --id [id]`
29
- The id. Specify either `name` or `id` but not both.
29
+ : The id. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-s, --scope [scope]`
32
32
  : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
@@ -0,0 +1,54 @@
1
+ # spo file roleinheritance break
2
+
3
+ Breaks inheritance of a file. Keeping existing permissions is the default behavior.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file roleinheritance break [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the file is located
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
18
+
19
+ `i, --fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
21
+
22
+ `-c, --clearExistingPermissions`
23
+ : Clear all existing permissions from the file
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Break the inheritance of a file with a specific id (UniqueId).
33
+
34
+ ```sh
35
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
36
+ ```
37
+
38
+ Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
39
+
40
+ ```sh
41
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
42
+ ```
43
+
44
+ Break the inheritance of a file with a specific server-relative URL.
45
+
46
+ ```sh
47
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx"
48
+ ```
49
+
50
+ Break the inheritance of a file with a specific server-relative URL and clear all existing permissions.
51
+
52
+ ```sh
53
+ m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --clearExistingPermissions
54
+ ```
@@ -0,0 +1,57 @@
1
+ # spo folder roleassignment remove
2
+
3
+ Removes a role assignment from the specified folder.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo folder roleassignment remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the folder is located.
15
+
16
+ `-f, --folderUrl <folderUrl>`
17
+ : The server- or site-relative URL of the folder.
18
+
19
+ `--principalId [principalId]`
20
+ : The SharePoint principal id. It may be either an user id or group id for which the role assignment will be removed. Specify either upn, groupName or principalId but not multiple.
21
+
22
+ `--upn [upn]`
23
+ : The upn/email of the user. Specify either upn, groupName or principalId but not multiple.
24
+
25
+ `--groupName [groupName]`
26
+ : The Azure AD or SharePoint group name. Specify either upn, groupName or principalId but not multiple.
27
+
28
+ `--confirm`
29
+ : Don't prompt for confirmation when removing the role assignment.
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Examples
34
+
35
+ Remove roleassignment from folder based on group name
36
+
37
+ ```sh
38
+ m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --groupName "saleGroup"
39
+ ```
40
+
41
+ Remove the role assignment from the specified folder based on the principal id.
42
+
43
+ ```sh
44
+ m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2
45
+ ```
46
+
47
+ Remove the role assignment from the specified folder based on the principal id without prompting for removal confirmation.
48
+
49
+ ```sh
50
+ m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2 --confirm
51
+ ```
52
+
53
+ Remove the role assignment from the specified folder based on the upn.
54
+
55
+ ```sh
56
+ m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com"
57
+ ```
@@ -11,29 +11,38 @@ m365 spo list contenttype add [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
- `-l, --listId [listId]`
17
- : ID of the list to which to add the content type. Specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to which to add the content type. Specify `listId` or `listTitle` 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, --contentTypeId <contentTypeId>`
23
- : ID of the content type to add to the list
26
+ : ID of the content type
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Examples
28
31
 
29
- Add existing content type with ID _0x0120_ to the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
32
+ Adds a specific existing content type to a list retrieved by id in a specific site.
30
33
 
31
34
  ```sh
32
35
  m365 spo list contenttype add --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --contentTypeId 0x0120
33
36
  ```
34
37
 
35
- Add existing content type with ID _0x0120_ to the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Adds a specific existing content type to a list retrieved by title in a specific site.
36
39
 
37
40
  ```sh
38
41
  m365 spo list contenttype add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --contentTypeId 0x0120
39
42
  ```
43
+
44
+ Adds a specific existing content type to a list retrieved by server relative URL in a specific site.
45
+
46
+ ```sh
47
+ m365 spo list contenttype add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'sites/project-x/Documents' --contentTypeId 0x0120
48
+ ```
@@ -11,29 +11,38 @@ m365 spo list contenttype default set [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
- `-l, --listId [listId]`
17
- : ID of the list on which to set default content type, specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list on which to set default content type, specify `listId` or `listTitle` 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, --contentTypeId <contentTypeId>`
23
- : ID of the content type to set as default on the list
26
+ : ID of the content type
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Examples
28
31
 
29
- Set content type with ID _0x0120_ as default in the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
32
+ Set a content type with a specific id as default a list retrieved by id located in a specific site.
30
33
 
31
34
  ```sh
32
35
  m365 spo list contenttype default set --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --contentTypeId 0x0120
33
36
  ```
34
37
 
35
- Set content type with ID _0x0120_ as default in the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Set a content type with a specific id as default a list retrieved by title located in a specific site.
36
39
 
37
40
  ```sh
38
41
  m365 spo list contenttype default set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --contentTypeId 0x0120
39
42
  ```
43
+
44
+ Set a content type with a specific id as default a list retrieved by server relative URL located in a specific site.
45
+
46
+ ```sh
47
+ m365 spo list contenttype default set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'sites/project-x/Documents' --contentTypeId 0x0120
48
+ ```
@@ -11,26 +11,35 @@ m365 spo list contenttype list [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
- `-l, --listId [listId]`
17
- : ID of the list for which to list configured content types. Specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list for which to list configured content types. Specify `listId` or `listTitle` 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
- List all content types configured on the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
29
+ List all content types configured on a specific list retrieved by id in a specific site.
27
30
 
28
31
  ```sh
29
32
  m365 spo list contenttype list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
30
33
  ```
31
34
 
32
- List all content types configured on the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ List all content types configured on a specific list retrieved by title in a specific site.
33
36
 
34
37
  ```sh
35
38
  m365 spo list contenttype list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents
36
39
  ```
40
+
41
+ List all content types configured on a specific list retrieved by server relative URL in a specific site.
42
+
43
+ ```sh
44
+ m365 spo list contenttype list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'sites/project-x/Documents'
45
+ ```
@@ -11,32 +11,41 @@ m365 spo list contenttype remove [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
- `-l, --listId [listId]`
17
- : ID of the list from which to remove the content type, specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list from which to remove the content type, specify `listId` or `listTitle` 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, --contentTypeId <contentTypeId>`
23
- : ID of the content type to remove from the list
26
+ : ID of the content type
24
27
 
25
28
  `--confirm`
26
- : Don't prompt for confirming removing the content type from the list
29
+ : Don't prompt for confirmation
27
30
 
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
30
33
  ## Examples
31
34
 
32
- Remove content type with ID _0x010109010053EE7AEB1FC54A41B4D9F66ADBDC312A_ from the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ Remove content type with a specific id from the list retrieved by id in a specific site.
33
36
 
34
37
  ```sh
35
38
  m365 spo list contenttype remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --contentTypeId 0x010109010053EE7AEB1FC54A41B4D9F66ADBDC312A
36
39
  ```
37
40
 
38
- Remove content type with ID _0x010109010053EE7AEB1FC54A41B4D9F66ADBDC312A_ from the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
41
+ Remove content type with a specific id from the list retrieved by title in a specific site.
39
42
 
40
43
  ```sh
41
44
  m365 spo list contenttype remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --contentTypeId 0x010109010053EE7AEB1FC54A41B4D9F66ADBDC312A
42
45
  ```
46
+
47
+ Remove content type with a specific id from the list retrieved by server relative URL in a specific site. This will not prompt for confirmation.
48
+
49
+ ```sh
50
+ m365 spo list contenttype remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'sites/project-x/Documents' --contentTypeId 0x010109010053EE7AEB1FC54A41B4D9F66ADBDC312A --confirm
51
+ ```
@@ -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
  ```