@pnp/cli-microsoft365 5.9.0-beta.06d9445 → 5.9.0-beta.09bf387

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 (74) hide show
  1. package/.eslintrc.js +15 -2
  2. package/README.md +5 -0
  3. package/dist/m365/aad/commands/app/app-add.js +37 -13
  4. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  5. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  6. package/dist/m365/pp/commands/Environment.js +3 -0
  7. package/dist/m365/pp/commands/card/card-get.js +110 -0
  8. package/dist/m365/pp/commands/card/card-list.js +68 -0
  9. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +6 -12
  10. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  11. package/dist/m365/pp/commands/solution/Solution.js +3 -0
  12. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  13. package/dist/m365/pp/commands/solution/solution-list.js +87 -0
  14. package/dist/m365/pp/commands.js +5 -0
  15. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.14.0.js +0 -2
  16. package/dist/m365/spfx/commands/spfx-doctor.js +37 -7
  17. package/dist/m365/spo/commands/eventreceiver/EventReceiver.js +3 -0
  18. package/dist/m365/spo/commands/eventreceiver/eventreceiver-remove.js +182 -0
  19. package/dist/m365/spo/commands/file/file-copy.js +25 -39
  20. package/dist/m365/spo/commands/file/file-move.js +24 -37
  21. package/dist/m365/spo/commands/file/file-rename.js +19 -16
  22. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +129 -0
  23. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +168 -0
  24. package/dist/m365/spo/commands/group/AssociatedGroupPropertiesCollection.js +3 -0
  25. package/dist/m365/spo/commands/group/group-list.js +49 -10
  26. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  27. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  28. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  29. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  30. package/dist/m365/spo/commands/list/list-roleassignment-add.js +10 -10
  31. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +8 -8
  32. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  33. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  34. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  35. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -9
  36. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  37. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  38. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  39. package/dist/m365/spo/commands/listitem/listitem-roleassignment-remove.js +8 -8
  40. package/dist/m365/spo/commands/web/web-roleassignment-add.js +10 -10
  41. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +8 -8
  42. package/dist/m365/spo/commands.js +3 -0
  43. package/dist/m365/teams/commands/channel/channel-add.js +9 -9
  44. package/dist/m365/todo/commands/task/task-set.js +53 -1
  45. package/docs/docs/_clisettings.md +19 -0
  46. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  47. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  48. package/docs/docs/cmd/pp/card/card-list.md +33 -0
  49. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +2 -2
  50. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  51. package/docs/docs/cmd/pp/environment/environment-list.md +1 -1
  52. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  53. package/docs/docs/cmd/pp/solution/solution-list.md +33 -0
  54. package/docs/docs/cmd/spfx/spfx-doctor.md +10 -1
  55. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  56. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +69 -0
  57. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +54 -0
  58. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  59. package/docs/docs/cmd/spo/group/group-list.md +10 -1
  60. package/docs/docs/cmd/spo/list/list-contenttype-add.md +16 -7
  61. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  62. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  63. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +17 -8
  64. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  65. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  66. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  67. package/docs/docs/cmd/spo/list/list-webhook-get.md +15 -6
  68. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  69. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  70. package/docs/docs/cmd/spo/list/list-webhook-set.md +13 -11
  71. package/docs/docs/cmd/teams/channel/channel-add.md +4 -4
  72. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  73. package/package.json +6 -1
  74. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js +0 -60
@@ -0,0 +1,19 @@
1
+ ## Available settings
2
+
3
+ Following is the list of configuration settings available in CLI for Microsoft 365.
4
+
5
+ Setting name|Definition|Default value
6
+ ------------|----------|-------------
7
+ `autoOpenBrowserOnLogin`|Automatically open the browser to the Azure AD login page after running `m365 login` command in device code mode. This setting will be replaced by `autoOpenLinksInBrowser` in the next major release.|`false`
8
+ `autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode. This setting will replace `autoOpenBrowserOnLogin` in the next major release.|`false`
9
+ `copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
10
+ `csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
11
+ `csvHeader`|Display the column names on the first line|`true`
12
+ `csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
13
+ `csvQuoted`|Quote all the non-empty fields even if not required|`false`
14
+ `csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
15
+ `errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
16
+ `output`|Defines the default output when issuing a command|`json`
17
+ `printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
18
+ `prompt`|Prompts for missing values in required options|`false`
19
+ `showHelpOnFailure`|Automatically display help when executing a command failed|`true`
@@ -43,6 +43,9 @@ m365 outlook sendmail [options]
43
43
  `--importance [importance]`
44
44
  : The importance of the message. Available options: `low`, `normal` or `high`. Default is `normal`.
45
45
 
46
+ `--attachment [attachment]`
47
+ : Path to the file that will be added as attachment to the email. This option can be used multiple times to attach multiple attachments.
48
+
46
49
  `--saveToSentItems [saveToSentItems]`
47
50
  : Save email in the sent items folder. Default `true`.
48
51
 
@@ -50,6 +53,10 @@ m365 outlook sendmail [options]
50
53
 
51
54
  ## Remarks
52
55
 
56
+ ### Attachments
57
+
58
+ When using the `attachment` option, note that the total size of all attachment files cannot exceed 3 MB.
59
+
53
60
  ### If you are connected using app only authentication
54
61
 
55
62
  - Always specify a user id or upn in the `--sender` option. The email will be sent as if it came from the specified user, and can optionally be saved in the sent folder of that user account.
@@ -116,3 +123,9 @@ Send an email with cc and bcc recipients marked as important
116
123
  ```sh
117
124
  m365 outlook mail send --to chris@contoso.com --cc claire@contoso.com --bcc randy@contoso.com --subject "DG2000 Data Sheets" --bodyContents "The latest data sheets are in the team site" --importance high
118
125
  ```
126
+
127
+ Send an email with multiple attachments
128
+
129
+ ```sh
130
+ m365 outlook mail send --to chris@contoso.com --subject "Monthly reports" --bodyContents "Here are the reports of this month." --attachment "C:/Reports/File1.jpg" --attachment "C:/Reports/File2.docx" --attachment "C:/Reports/File3.xlsx"
131
+ ```
@@ -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.
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,33 @@
1
+ # pp card list
2
+
3
+ Lists Microsoft Power Platform cards in the specified Power Platform environment.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ pp card list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-a, --asAdmin`
17
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ List cards in a specific environment.
24
+
25
+ ```sh
26
+ m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
27
+ ```
28
+
29
+ List cards in a specific environment as admin.
30
+
31
+ ```sh
32
+ m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
33
+ ```
@@ -11,10 +11,10 @@ pp dataverse table list [options]
11
11
  ## Options
12
12
 
13
13
  `-e, --environment <environment>`
14
- The name of the environment to list all tables for
14
+ : The name of the environment to list all tables for
15
15
 
16
16
  `-a, --asAdmin`
17
- Set, to retrieve the dataverse tables as admin for environments you are not a member of.
17
+ : Set, to retrieve the dataverse tables as admin for environments you are not a member of.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -0,0 +1,38 @@
1
+ # pp environment get
2
+
3
+ Gets information about the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp environment get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --name <name>`
14
+ : The name of the environment to get information about
15
+
16
+ `-a, --asAdmin`
17
+ : Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
18
+
19
+ ## Remarks
20
+
21
+ !!! attention
22
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
23
+ Register CLI for Microsoft 365 or Azure AD application as a management application for the Power Platform using
24
+ m365 pp managementapp add [options]
25
+
26
+ ## Examples
27
+
28
+ Get information about the Power Platform environment by name
29
+
30
+ ```sh
31
+ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
32
+ ```
33
+
34
+ Get information as admin about the Power Platform environment by name
35
+
36
+ ```sh
37
+ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
38
+ ```
@@ -11,7 +11,7 @@ m365 pp environment list [options]
11
11
  ## Options
12
12
 
13
13
  `-a, --asAdmin`
14
- Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
14
+ : Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -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
+ ```
@@ -0,0 +1,33 @@
1
+ # pp solution list
2
+
3
+ Lists solutions in a given environment.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp solution list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment
15
+
16
+ `-a, --asAdmin`
17
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ List all solutions in a specific environment
24
+
25
+ ```sh
26
+ m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
27
+ ```
28
+
29
+ List all solutions in a specific environment as Admin
30
+
31
+ ```sh
32
+ m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
33
+ ```
@@ -13,6 +13,9 @@ m365 spfx doctor [options]
13
13
  `-e, --env [env]`
14
14
  : Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
15
15
 
16
+ `-v, --spfxVersion [spfxVersion]`
17
+ : Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
18
+
16
19
  `-h, --help`
17
20
  : output usage information
18
21
 
@@ -48,7 +51,7 @@ Next to verifying the readiness of your environment to use a particular version
48
51
 
49
52
  ## Examples
50
53
 
51
- Verify if your environment meets the requirements to work with the SharePoint Framework
54
+ Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
52
55
 
53
56
  ```sh
54
57
  m365 spfx doctor --output text
@@ -59,3 +62,9 @@ Verify if your environment meets the requirements to work with the SharePoint Fr
59
62
  ```sh
60
63
  m365 spfx doctor --env sp2019 --output text
61
64
  ```
65
+
66
+ Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
67
+
68
+ ```sh
69
+ m365 spfx doctor --spfxVersion 1.11.0 --output text
70
+ ```
@@ -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.
@@ -0,0 +1,69 @@
1
+ # spo eventreceiver remove
2
+
3
+ Removes event receivers for the specified web, site, or list.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo eventreceiver remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the web.
15
+
16
+ `--listTitle [listTitle]`
17
+ : The title of the list, _if the event receiver should be removed from a list_. Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : The id of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
24
+
25
+ `-n, --name [name]`
26
+ : The name. Specify either `name` or `id` but not both.
27
+
28
+ `-i, --id [id]`
29
+ : The id. Specify either `name` or `id` but not both.
30
+
31
+ `-s, --scope [scope]`
32
+ : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
33
+
34
+ `--confirm`
35
+ : Don't prompt for confirming removing the event receiver
36
+
37
+ --8<-- "docs/cmd/_global.md"
38
+
39
+ ## Examples
40
+
41
+ Remove event receiver in a specific web by name.
42
+
43
+ ```sh
44
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
45
+ ```
46
+
47
+ Remove event receiver in a specific site by id.
48
+
49
+ ```sh
50
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
51
+ ```
52
+
53
+ Remove event receiver in a specific list retrieved by title by name.
54
+
55
+ ```sh
56
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
57
+ ```
58
+
59
+ Remove event receiver in a specific list retrieved by list id by id.
60
+
61
+ ```sh
62
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
63
+ ```
64
+
65
+ Remove event receiver in a specific list retrieved by list url by name.
66
+
67
+ ```sh
68
+ m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
69
+ ```
@@ -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
+ ```
@@ -13,12 +13,21 @@ m365 spo group list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : Url of the web to list the group within
15
15
 
16
+ `--associatedGroupsOnly`
17
+ : Get only the associated visitor, member and owner groups of the site.
18
+
16
19
  --8<-- "docs/cmd/_global.md"
17
20
 
18
21
  ## Examples
19
22
 
20
- Lists all the groups within specific web _https://contoso.sharepoint.com/sites/contoso_
23
+ Lists all the groups within a specific web
21
24
 
22
25
  ```sh
23
26
  m365 spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso"
24
27
  ```
28
+
29
+ Lists the associated groups within a specific web
30
+
31
+ ```sh
32
+ m365 spo group list --webUrl "https://contoso.sharepoint.com/sites/contoso" --associatedGroupsOnly
33
+ ```
@@ -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
+ ```