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

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 (61) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/m365/aad/commands/app/app-add.js +37 -13
  3. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  4. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  5. package/dist/m365/pp/commands/Environment.js +3 -0
  6. package/dist/m365/pp/commands/card/card-get.js +110 -0
  7. package/dist/m365/pp/commands/card/card-list.js +68 -0
  8. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +6 -12
  9. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  10. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  11. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  12. package/dist/m365/pp/commands.js +5 -0
  13. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  14. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  15. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  16. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +129 -0
  17. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +168 -0
  18. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  19. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  20. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  21. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  22. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  23. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  24. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  25. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -9
  26. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  27. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  28. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  29. package/dist/m365/spo/commands.js +2 -0
  30. package/dist/m365/teams/commands/channel/channel-add.js +9 -9
  31. package/dist/m365/todo/commands/task/task-add.js +55 -3
  32. package/dist/m365/todo/commands/task/task-set.js +53 -1
  33. package/docs/docs/_clisettings.md +19 -0
  34. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  35. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  36. package/docs/docs/cmd/pp/card/card-list.md +33 -0
  37. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  38. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  39. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  40. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  41. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  42. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  43. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  44. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  45. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +54 -0
  46. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  47. package/docs/docs/cmd/spo/list/list-contenttype-add.md +16 -7
  48. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  49. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  50. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +17 -8
  51. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  52. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  53. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  54. package/docs/docs/cmd/spo/list/list-webhook-get.md +15 -6
  55. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  56. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  57. package/docs/docs/cmd/spo/list/list-webhook-set.md +13 -11
  58. package/docs/docs/cmd/teams/channel/channel-add.md +4 -4
  59. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  60. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  61. package/package.json +6 -1
@@ -16,6 +16,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
16
16
  var _TodoTaskSetCommand_instances, _TodoTaskSetCommand_initTelemetry, _TodoTaskSetCommand_initOptions, _TodoTaskSetCommand_initValidators, _TodoTaskSetCommand_initOptionSets;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  const request_1 = require("../../../../request");
19
+ const validation_1 = require("../../../../utils/validation");
19
20
  const GraphCommand_1 = require("../../../base/GraphCommand");
20
21
  const commands_1 = require("../../commands");
21
22
  class TodoTaskSetCommand extends GraphCommand_1.default {
@@ -76,7 +77,14 @@ class TodoTaskSetCommand extends GraphCommand_1.default {
76
77
  return Promise.resolve(taskList.id);
77
78
  });
78
79
  }
80
+ getDateTimeTimeZone(dateTime) {
81
+ return {
82
+ dateTime: dateTime,
83
+ timeZone: 'Etc/GMT'
84
+ };
85
+ }
79
86
  mapRequestBody(options) {
87
+ var _a;
80
88
  const requestBody = {};
81
89
  if (options.status) {
82
90
  requestBody.status = options.status;
@@ -84,6 +92,21 @@ class TodoTaskSetCommand extends GraphCommand_1.default {
84
92
  if (options.title) {
85
93
  requestBody.title = options.title;
86
94
  }
95
+ if (options.importance) {
96
+ requestBody.importance = options.importance.toLowerCase();
97
+ }
98
+ if (options.bodyContentType || options.bodyContent) {
99
+ requestBody.body = {
100
+ content: options.bodyContent,
101
+ contentType: ((_a = options.bodyContentType) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || 'text'
102
+ };
103
+ }
104
+ if (options.dueDateTime) {
105
+ requestBody.dueDateTime = this.getDateTimeTimeZone(options.dueDateTime);
106
+ }
107
+ if (options.reminderDateTime) {
108
+ requestBody.reminderDateTime = this.getDateTimeTimeZone(options.reminderDateTime);
109
+ }
87
110
  return requestBody;
88
111
  }
89
112
  }
@@ -93,7 +116,12 @@ _TodoTaskSetCommand_instances = new WeakSet(), _TodoTaskSetCommand_initTelemetry
93
116
  listId: typeof args.options.listId !== 'undefined',
94
117
  listName: typeof args.options.listName !== 'undefined',
95
118
  status: typeof args.options.status !== 'undefined',
96
- title: typeof args.options.title !== 'undefined'
119
+ title: typeof args.options.title !== 'undefined',
120
+ bodyContent: typeof args.options.bodyContent !== 'undefined',
121
+ bodyContentType: args.options.bodyContentType,
122
+ dueDateTime: typeof args.options.dueDateTime !== 'undefined',
123
+ importance: args.options.importance,
124
+ reminderDateTime: typeof args.options.reminderDateTime !== 'undefined'
97
125
  });
98
126
  });
99
127
  }, _TodoTaskSetCommand_initOptions = function _TodoTaskSetCommand_initOptions() {
@@ -108,6 +136,18 @@ _TodoTaskSetCommand_instances = new WeakSet(), _TodoTaskSetCommand_initTelemetry
108
136
  option: '--listName [listName]'
109
137
  }, {
110
138
  option: '--listId [listId]'
139
+ }, {
140
+ option: '--bodyContent [bodyContent]'
141
+ }, {
142
+ option: '--bodyContentType [bodyContentType]',
143
+ autocomplete: ['text', 'html']
144
+ }, {
145
+ option: '--dueDateTime [dueDateTime]'
146
+ }, {
147
+ option: '--importance [importance]',
148
+ autocomplete: ['low', 'normal', 'high']
149
+ }, {
150
+ option: '--reminderDateTime [reminderDateTime]'
111
151
  });
112
152
  }, _TodoTaskSetCommand_initValidators = function _TodoTaskSetCommand_initValidators() {
113
153
  this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
@@ -119,6 +159,18 @@ _TodoTaskSetCommand_instances = new WeakSet(), _TodoTaskSetCommand_initTelemetry
119
159
  args.options.status !== 'deferred') {
120
160
  return `${args.options.status} is not a valid value. Allowed values are notStarted|inProgress|completed|waitingOnOthers|deferred`;
121
161
  }
162
+ if (args.options.bodyContentType && ['text', 'html'].indexOf(args.options.bodyContentType.toLowerCase()) === -1) {
163
+ return `'${args.options.bodyContentType}' is not a valid value for the bodyContentType option. Allowed values are text|html`;
164
+ }
165
+ if (args.options.importance && ['low', 'normal', 'high'].indexOf(args.options.importance.toLowerCase()) === -1) {
166
+ return `'${args.options.importance}' is not a valid value for the importance option. Allowed values are low|normal|high`;
167
+ }
168
+ if (args.options.dueDateTime && !validation_1.validation.isValidISODateTime(args.options.dueDateTime)) {
169
+ return `'${args.options.dueDateTime}' is not a valid ISO date string`;
170
+ }
171
+ if (args.options.reminderDateTime && !validation_1.validation.isValidISODateTime(args.options.reminderDateTime)) {
172
+ return `'${args.options.reminderDateTime}' is not a valid ISO date string`;
173
+ }
122
174
  return true;
123
175
  }));
124
176
  }, _TodoTaskSetCommand_initOptionSets = function _TodoTaskSetCommand_initOptionSets() {
@@ -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. 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,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
+ ```
@@ -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
+ ```
@@ -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
+ ```
@@ -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
+ ```