@pnp/cli-microsoft365 6.1.0 → 6.2.0-beta.0ce0a85

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 (41) hide show
  1. package/.eslintrc.js +6 -0
  2. package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
  3. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
  4. package/dist/m365/pp/commands.js +1 -0
  5. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +70 -0
  6. package/dist/m365/purview/commands.js +1 -0
  7. package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
  8. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
  9. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  10. package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
  11. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  12. package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
  13. package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
  14. package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
  15. package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
  16. package/dist/m365/spo/commands/listitem/listitem-record-lock.js +129 -0
  17. package/dist/m365/spo/commands/listitem/listitem-record-unlock.js +129 -0
  18. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
  19. package/dist/m365/spo/commands.js +6 -0
  20. package/dist/m365/teams/commands/chat/chat-list.js +29 -7
  21. package/dist/request.js +2 -2
  22. package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
  23. package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
  24. package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
  25. package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
  26. package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
  27. package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
  28. package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
  29. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
  30. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +95 -0
  31. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  32. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
  33. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  34. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
  35. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
  36. package/docs/docs/cmd/spo/listitem/listitem-record-lock.md +52 -0
  37. package/docs/docs/cmd/spo/listitem/listitem-record-unlock.md +52 -0
  38. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
  39. package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
  40. package/npm-shrinkwrap.json +184 -204
  41. package/package.json +13 -12
@@ -0,0 +1,161 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
13
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
14
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
15
+ };
16
+ var _SpoListItemRetentionLabelEnsureCommand_instances, _SpoListItemRetentionLabelEnsureCommand_initTelemetry, _SpoListItemRetentionLabelEnsureCommand_initOptions, _SpoListItemRetentionLabelEnsureCommand_initValidators, _SpoListItemRetentionLabelEnsureCommand_initOptionSets;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const request_1 = require("../../../../request");
19
+ const formatting_1 = require("../../../../utils/formatting");
20
+ const urlUtil_1 = require("../../../../utils/urlUtil");
21
+ const validation_1 = require("../../../../utils/validation");
22
+ const SpoCommand_1 = require("../../../base/SpoCommand");
23
+ const commands_1 = require("../../commands");
24
+ const SpoWebRetentionLabelListCommand = require("../web/web-retentionlabel-list");
25
+ const Cli_1 = require("../../../../cli/Cli");
26
+ class SpoListItemRetentionLabelEnsureCommand extends SpoCommand_1.default {
27
+ get name() {
28
+ return commands_1.default.LISTITEM_RETENTIONLABEL_ENSURE;
29
+ }
30
+ get description() {
31
+ return 'Apply a retention label to a list item';
32
+ }
33
+ constructor() {
34
+ super();
35
+ _SpoListItemRetentionLabelEnsureCommand_instances.add(this);
36
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initTelemetry).call(this);
37
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initOptions).call(this);
38
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initValidators).call(this);
39
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initOptionSets).call(this);
40
+ }
41
+ commandAction(logger, args) {
42
+ return __awaiter(this, void 0, void 0, function* () {
43
+ try {
44
+ const labelInformation = yield this.getLabelInformation(args.options, logger);
45
+ yield this.applyLabel(args.options, labelInformation, logger);
46
+ }
47
+ catch (err) {
48
+ this.handleRejectedODataJsonPromise(err);
49
+ }
50
+ });
51
+ }
52
+ getLabelInformation(options, logger) {
53
+ return __awaiter(this, void 0, void 0, function* () {
54
+ const cmdOptions = {
55
+ webUrl: options.webUrl,
56
+ output: 'json',
57
+ debug: options.debug,
58
+ verbose: options.verbose
59
+ };
60
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoWebRetentionLabelListCommand, { options: Object.assign(Object.assign({}, cmdOptions), { _: [] }) });
61
+ if (this.verbose) {
62
+ logger.logToStderr(output.stderr);
63
+ }
64
+ const labels = JSON.parse(output.stdout);
65
+ const label = labels.find(l => l.TagName === options.name || l.TagId === options.id);
66
+ if (this.verbose && label !== undefined) {
67
+ logger.logToStderr(`Retention label found in the list of available labels: '${label.TagName}' / '${label.TagId}'...`);
68
+ }
69
+ if (label === undefined) {
70
+ throw new Error(`The specified retention label does not exist`);
71
+ }
72
+ return {
73
+ complianceTag: label.TagName,
74
+ isTagPolicyHold: label.BlockDelete,
75
+ isTagPolicyRecord: label.BlockEdit,
76
+ isEventBasedTag: label.IsEventTag,
77
+ isTagSuperLock: label.SuperLock,
78
+ isUnlockedAsDefault: label.UnlockedAsDefault
79
+ };
80
+ });
81
+ }
82
+ applyLabel(options, labelInformation, logger) {
83
+ return __awaiter(this, void 0, void 0, function* () {
84
+ if (this.verbose) {
85
+ logger.logToStderr(`Applying retention label to item in list '${options.listId || options.listTitle || options.listUrl}' in site at ${options.webUrl}...`);
86
+ }
87
+ let requestUrl = `${options.webUrl}/_api/web`;
88
+ if (options.listId) {
89
+ requestUrl += `/lists(guid'${formatting_1.formatting.encodeQueryParameter(options.listId)}')/items(${options.listItemId})/SetComplianceTag()`;
90
+ }
91
+ else if (options.listTitle) {
92
+ requestUrl += `/lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(options.listTitle)}')/items(${options.listItemId})/SetComplianceTag()`;
93
+ }
94
+ else if (options.listUrl) {
95
+ const listServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
96
+ requestUrl += `/GetList(@listUrl)/items(${options.listItemId})/SetComplianceTag()?@listUrl='${formatting_1.formatting.encodeQueryParameter(listServerRelativeUrl)}'`;
97
+ }
98
+ const requestOptions = {
99
+ url: requestUrl,
100
+ headers: {
101
+ 'accept': 'application/json;odata=nometadata'
102
+ },
103
+ data: labelInformation,
104
+ responseType: 'json'
105
+ };
106
+ yield request_1.default.post(requestOptions);
107
+ });
108
+ }
109
+ }
110
+ _SpoListItemRetentionLabelEnsureCommand_instances = new WeakSet(), _SpoListItemRetentionLabelEnsureCommand_initTelemetry = function _SpoListItemRetentionLabelEnsureCommand_initTelemetry() {
111
+ this.telemetry.push((args) => {
112
+ Object.assign(this.telemetryProperties, {
113
+ listId: typeof args.options.listId !== 'undefined',
114
+ listTitle: typeof args.options.listTitle !== 'undefined',
115
+ listUrl: typeof args.options.listUrl !== 'undefined',
116
+ name: typeof args.options.name !== 'undefined',
117
+ id: typeof args.options.id !== 'undefined'
118
+ });
119
+ });
120
+ }, _SpoListItemRetentionLabelEnsureCommand_initOptions = function _SpoListItemRetentionLabelEnsureCommand_initOptions() {
121
+ this.options.unshift({
122
+ option: '-u, --webUrl <webUrl>'
123
+ }, {
124
+ option: '--listItemId <listItemId>'
125
+ }, {
126
+ option: '--listId [listId]'
127
+ }, {
128
+ option: '--listTitle [listTitle]'
129
+ }, {
130
+ option: '--listUrl [listUrl]'
131
+ }, {
132
+ option: '-n, --name [name]'
133
+ }, {
134
+ option: '-i, --id [id]'
135
+ });
136
+ }, _SpoListItemRetentionLabelEnsureCommand_initValidators = function _SpoListItemRetentionLabelEnsureCommand_initValidators() {
137
+ this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
138
+ const id = parseInt(args.options.listItemId);
139
+ if (isNaN(id)) {
140
+ return `${args.options.listItemId} is not a valid list item ID`;
141
+ }
142
+ const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
143
+ if (isValidSharePointUrl !== true) {
144
+ return isValidSharePointUrl;
145
+ }
146
+ if (args.options.listId &&
147
+ !validation_1.validation.isValidGuid(args.options.listId)) {
148
+ return `${args.options.listId} is not a valid GUID`;
149
+ }
150
+ if (args.options.id &&
151
+ !validation_1.validation.isValidGuid(args.options.id)) {
152
+ return `${args.options.id} is not a valid GUID`;
153
+ }
154
+ return true;
155
+ }));
156
+ }, _SpoListItemRetentionLabelEnsureCommand_initOptionSets = function _SpoListItemRetentionLabelEnsureCommand_initOptionSets() {
157
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
158
+ this.optionSets.push({ options: ['name', 'id'] });
159
+ };
160
+ module.exports = new SpoListItemRetentionLabelEnsureCommand();
161
+ //# sourceMappingURL=listitem-retentionlabel-ensure.js.map
@@ -62,6 +62,9 @@ exports.default = {
62
62
  FILE_ROLEINHERITANCE_BREAK: `${prefix} file roleinheritance break`,
63
63
  FILE_ROLEINHERITANCE_RESET: `${prefix} file roleinheritance reset`,
64
64
  FILE_SHARINGINFO_GET: `${prefix} file sharinginfo get`,
65
+ FILE_SHARINGLINK_GET: `${prefix} file sharinglink get`,
66
+ FILE_SHARINGLINK_LIST: `${prefix} file sharinglink list`,
67
+ FILE_SHARINGLINK_REMOVE: `${prefix} file sharinglink remove`,
65
68
  FILE_VERSION_CLEAR: `${prefix} file version clear`,
66
69
  FILE_VERSION_GET: `${prefix} file version get`,
67
70
  FILE_VERSION_LIST: `${prefix} file version list`,
@@ -143,8 +146,11 @@ exports.default = {
143
146
  LISTITEM_ISRECORD: `${prefix} listitem isrecord`,
144
147
  LISTITEM_LIST: `${prefix} listitem list`,
145
148
  LISTITEM_RECORD_DECLARE: `${prefix} listitem record declare`,
149
+ LISTITEM_RECORD_LOCK: `${prefix} listitem record lock`,
146
150
  LISTITEM_RECORD_UNDECLARE: `${prefix} listitem record undeclare`,
151
+ LISTITEM_RECORD_UNLOCK: `${prefix} listitem record unlock`,
147
152
  LISTITEM_REMOVE: `${prefix} listitem remove`,
153
+ LISTITEM_RETENTIONLABEL_ENSURE: `${prefix} listitem retentionlabel ensure`,
148
154
  LISTITEM_RETENTIONLABEL_REMOVE: `${prefix} listitem retentionlabel remove`,
149
155
  LISTITEM_ROLEASSIGNMENT_ADD: `${prefix} listitem roleassignment add`,
150
156
  LISTITEM_ROLEASSIGNMENT_REMOVE: `${prefix} listitem roleassignment remove`,
@@ -15,9 +15,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
15
15
  };
16
16
  var _TeamsChatListCommand_instances, _TeamsChatListCommand_initTelemetry, _TeamsChatListCommand_initOptions, _TeamsChatListCommand_initValidators;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
+ const Auth_1 = require("../../../../Auth");
19
+ const accessToken_1 = require("../../../../utils/accessToken");
18
20
  const odata_1 = require("../../../../utils/odata");
19
21
  const GraphCommand_1 = require("../../../base/GraphCommand");
20
22
  const commands_1 = require("../../commands");
23
+ const validation_1 = require("../../../../utils/validation");
21
24
  class TeamsChatListCommand extends GraphCommand_1.default {
22
25
  get name() {
23
26
  return commands_1.default.CHAT_LIST;
@@ -31,16 +34,26 @@ class TeamsChatListCommand extends GraphCommand_1.default {
31
34
  constructor() {
32
35
  super();
33
36
  _TeamsChatListCommand_instances.add(this);
37
+ this.supportedTypes = ['oneOnOne', 'group', 'meeting'];
34
38
  __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initTelemetry).call(this);
35
39
  __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initOptions).call(this);
36
40
  __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initValidators).call(this);
37
41
  }
38
42
  commandAction(logger, args) {
39
43
  return __awaiter(this, void 0, void 0, function* () {
40
- const filter = args.options.type !== undefined ? `?$filter=chatType eq '${args.options.type}'` : '';
41
- const endpoint = `${this.resource}/v1.0/chats${filter}`;
44
+ const isAppOnlyAuth = accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken);
45
+ if (isAppOnlyAuth && !args.options.userId && !args.options.userName) {
46
+ throw `The option 'userId' or 'userName' is required when obtaining chats using app only permissions`;
47
+ }
48
+ else if (!isAppOnlyAuth && (args.options.userId || args.options.userName)) {
49
+ throw `The options 'userId' or 'userName' cannot be used when obtaining chats using delegated permissions`;
50
+ }
51
+ let requestUrl = `${this.resource}/v1.0/${!isAppOnlyAuth ? 'me' : `users/${args.options.userId || args.options.userName}`}/chats`;
52
+ if (args.options.type) {
53
+ requestUrl += `?$filter=chatType eq '${args.options.type}'`;
54
+ }
42
55
  try {
43
- const items = yield odata_1.odata.getAllItems(endpoint);
56
+ const items = yield odata_1.odata.getAllItems(requestUrl);
44
57
  logger.log(items);
45
58
  }
46
59
  catch (err) {
@@ -58,13 +71,22 @@ _TeamsChatListCommand_instances = new WeakSet(), _TeamsChatListCommand_initTelem
58
71
  }, _TeamsChatListCommand_initOptions = function _TeamsChatListCommand_initOptions() {
59
72
  this.options.unshift({
60
73
  option: '-t, --type [type]',
61
- autocomplete: ['oneOnOne', 'group', 'meeting']
74
+ autocomplete: this.supportedTypes
75
+ }, {
76
+ option: '--userId [userId]'
77
+ }, {
78
+ option: '--userName [userName]'
62
79
  });
63
80
  }, _TeamsChatListCommand_initValidators = function _TeamsChatListCommand_initValidators() {
64
81
  this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
65
- const supportedTypes = ['oneOnOne', 'group', 'meeting'];
66
- if (args.options.type !== undefined && supportedTypes.indexOf(args.options.type) === -1) {
67
- return `${args.options.type} is not a valid chatType. Accepted values are ${supportedTypes.join(', ')}`;
82
+ if (args.options.type !== undefined && this.supportedTypes.indexOf(args.options.type) === -1) {
83
+ return `${args.options.type} is not a valid chatType. Accepted values are ${this.supportedTypes.join(', ')}`;
84
+ }
85
+ if (args.options.userId && args.options.userName) {
86
+ return `You can only specify either 'userId' or 'userName'`;
87
+ }
88
+ if (args.options.userId && !validation_1.validation.isValidGuid(args.options.userId)) {
89
+ return `${args.options.userId} is not a valid GUID`;
68
90
  }
69
91
  return true;
70
92
  }));
package/dist/request.js CHANGED
@@ -150,10 +150,10 @@ class Request {
150
150
  })
151
151
  .then((res) => {
152
152
  if (resolve) {
153
- resolve(options.responseType === 'stream' ? res : res.data);
153
+ resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
154
154
  }
155
155
  else {
156
- _resolve(options.responseType === 'stream' ? res : res.data);
156
+ _resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
157
157
  }
158
158
  }, (error) => {
159
159
  if (error && error.response &&
@@ -72,3 +72,20 @@ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan"
72
72
  id,name,planId,orderHint
73
73
  ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
74
74
  ```
75
+
76
+ === "Markdown"
77
+
78
+ ```md
79
+ # planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
80
+
81
+ Date: 27/12/2022
82
+
83
+ ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
84
+
85
+ Property | Value
86
+ ---------|-------
87
+ name | My Planner Bucket
88
+ planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
89
+ orderHint | 8585363889524958496
90
+ id | ttEB_Uj690STdR3GC1MIDZgANq1U
91
+ ```
@@ -84,3 +84,20 @@ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerG
84
84
  id,name,planId,orderHint
85
85
  ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
86
86
  ```
87
+
88
+ === "Markdown"
89
+
90
+ ```md
91
+ # planner bucket get --id "ttEB_Uj690STdR3GC1MIDZgANq1U"
92
+
93
+ Date: 27/12/2022
94
+
95
+ ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
96
+
97
+ Property | Value
98
+ ---------|-------
99
+ name | My Planner Bucket
100
+ planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
101
+ orderHint | 8585363889524958496
102
+ id | ttEB_Uj690STdR3GC1MIDZgANq1U
103
+ ```
@@ -67,3 +67,20 @@ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
67
67
  id,name,planId,orderHint
68
68
  ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
69
69
  ```
70
+
71
+ === "Markdown"
72
+
73
+ ```md
74
+ # planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
75
+
76
+ Date: 27/12/2022
77
+
78
+ ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
79
+
80
+ Property | Value
81
+ ---------|-------
82
+ name | My Planner Bucket
83
+ planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
84
+ orderHint | 8585363889524958496
85
+ id | ttEB_Uj690STdR3GC1MIDZgANq1U
86
+ ```
@@ -97,6 +97,25 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
97
97
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
98
98
  ```
99
99
 
100
+ === "Markdown"
101
+
102
+ ```md
103
+ # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
104
+
105
+ Date: 30/03/2015
106
+
107
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
108
+
109
+ Property | Value
110
+ ---------|-------
111
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
112
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
113
+ title | My Planner Plan
114
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
115
+ createdBy | {"user":{"displayName":null,"id":"95e27074-6c4a-447a-aa24-9d718a0b86fa"},"application":{"displayName":null,"id":"ebf3b108-5234-4e22-b93d-656d7dae5874"}}
116
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
117
+ ```
118
+
100
119
  ### `shareWithUserIds`, `shareWithUserNames` response
101
120
 
102
121
  When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ.
@@ -173,3 +192,24 @@ When we make use of the option `shareWithUserIds` or `shareWithUserNames` the re
173
192
  id,title,createdDateTime,owner
174
193
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
175
194
  ```
195
+
196
+ === "Markdown"
197
+
198
+ ```md
199
+ # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
200
+
201
+ Date: 30/03/2015
202
+
203
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
204
+
205
+ Property | Value
206
+ ---------|-------
207
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
208
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
209
+ title | My Planner Plan
210
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
211
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
212
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
213
+ sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
214
+ categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
215
+ ```
@@ -118,3 +118,24 @@ m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
118
118
  id,title,createdDateTime,owner
119
119
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
120
120
  ```
121
+
122
+ === "Markdown"
123
+
124
+ ```md
125
+ # planner plan get --id "xqQg5FS2LkCp935s-FIFm2QAFkHM"
126
+
127
+ Date: 27/12/2022
128
+
129
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
130
+
131
+ Property | Value
132
+ ---------|-------
133
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
134
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
135
+ title | My Planner Plan
136
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
137
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
138
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
139
+ sharedWith | {"aa089c1a-0ca8-4b36-ae2e-c5d60f054a2c":true,"ebf3b108-5234-4e22-b93d-656d7dae5874":true}
140
+ categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
141
+ ```
@@ -76,3 +76,22 @@ m365 planner plan list --ownerGroupName "My Planner Group"
76
76
  id,title,createdDateTime,owner
77
77
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
78
78
  ```
79
+
80
+ === "Markdown"
81
+
82
+ ```md
83
+ # planner plan list --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
84
+
85
+ Date: 27/12/2022
86
+
87
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
88
+
89
+ Property | Value
90
+ ---------|-------
91
+ createdDateTime | 2021-12-12T14:00:50.4522129Z
92
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
93
+ title | My Planner Plan
94
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
95
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"}}
96
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
97
+ ```
@@ -142,3 +142,23 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
142
142
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
143
143
  ```
144
144
 
145
+ === "Markdown"
146
+
147
+ ```md
148
+ # planner plan set --id "xqQg5FS2LkCp935s-FIFm2QAFkHM" --newTitle "My Planner Plan"
149
+
150
+ Date: 27/12/2022
151
+
152
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
153
+
154
+ Property | Value
155
+ ---------|-------
156
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
157
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
158
+ title | My Planner Plan
159
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
160
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
161
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
162
+ sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
163
+ categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
164
+ ```
@@ -0,0 +1,95 @@
1
+ # pp aibuildermodel list
2
+
3
+ List available AI builder models in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ pp aibuildermodel list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment
15
+
16
+ `--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 AI Builder models in a specific environment
24
+
25
+ ```sh
26
+ m365 pp aibuildermodel list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
27
+ ```
28
+
29
+ List all AI Builder models in a specific environment as admin
30
+
31
+ ```sh
32
+ m365 pp aibuildermodel list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
33
+ ```
34
+
35
+ ## Response
36
+
37
+ === "JSON"
38
+
39
+ ```json
40
+ [
41
+ {
42
+ "statecode": 0,
43
+ "_msdyn_templateid_value": "10707e4e-1d56-e911-8194-000d3a6cd5a5",
44
+ "msdyn_modelcreationcontext": "{}",
45
+ "createdon": "2022-11-29T11:58:45Z",
46
+ "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
47
+ "modifiedon": "2022-11-29T11:58:45Z",
48
+ "msdyn_sharewithorganizationoncreate": false,
49
+ "msdyn_aimodelidunique": "b0328b67-47e2-4202-8189-e617ec9a88bd",
50
+ "solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
51
+ "ismanaged": false,
52
+ "versionnumber": 1458121,
53
+ "msdyn_name": "Document Processing 11/29/2022, 12:58:43 PM",
54
+ "introducedversion": "1.0",
55
+ "statuscode": 0,
56
+ "_modifiedby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
57
+ "overwritetime": "1900-01-01T00:00:00Z",
58
+ "componentstate": 0,
59
+ "_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
60
+ "_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
61
+ "_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
62
+ "msdyn_aimodelid": "08ffffbe-ec1c-4e64-b64b-dd1db926c613",
63
+ "_msdyn_activerunconfigurationid_value": null,
64
+ "overriddencreatedon": null,
65
+ "_msdyn_retrainworkflowid_value": null,
66
+ "importsequencenumber": null,
67
+ "_msdyn_scheduleinferenceworkflowid_value": null,
68
+ "_modifiedonbehalfby_value": null,
69
+ "utcconversiontimezonecode": null,
70
+ "_createdonbehalfby_value": null,
71
+ "_owningteam_value": null,
72
+ "timezoneruleversionnumber": null,
73
+ "iscustomizable": {
74
+ "Value": true,
75
+ "CanBeChanged": true,
76
+ "ManagedPropertyLogicalName": "iscustomizableanddeletable"
77
+ }
78
+ }
79
+ ]
80
+ ```
81
+
82
+ === "Text"
83
+
84
+ ```text
85
+ createdon modifiedon msdyn_aimodelid msdyn_name
86
+ -------------------- -------------------- ------------------------------------ -------------------------------------------
87
+ 2022-10-25T14:44:48Z 2022-10-25T14:44:48Z 08ffffbe-ec1c-4e64-b64b-dd1db926c613 Document Processing 11/29/2022, 12:58:43 PM
88
+ ```
89
+
90
+ === "CSV"
91
+
92
+ ```csv
93
+ msdyn_name,msdyn_aimodelid,createdon,modifiedon
94
+ "Document Processing 11/29/2022, 12:58:43 PM",08ffffbe-ec1c-4e64-b64b-dd1db926c613,2022-11-29T11:58:45Z,2022-11-29T11:58:45Z
95
+ ```
@@ -0,0 +1,95 @@
1
+ # purview retentionlabel get
2
+
3
+ Get a retention label
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionlabel get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the retention label.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get a retention label
21
+
22
+ ```sh
23
+ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
24
+ ```
25
+
26
+ ## Remarks
27
+
28
+ !!! attention
29
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
30
+
31
+ ## Response
32
+
33
+
34
+ === "JSON"
35
+
36
+ ```json
37
+ {
38
+ "displayName": "TEST LABEL",
39
+ "descriptionForAdmins": "",
40
+ "descriptionForUsers": "",
41
+ "isInUse": false,
42
+ "retentionTrigger": "dateCreated",
43
+ "behaviorDuringRetentionPeriod": "retain",
44
+ "actionAfterRetentionPeriod": "delete",
45
+ "createdDateTime": "2022-12-12T15:14:53Z",
46
+ "lastModifiedDateTime": "2022-12-12T15:43:06Z",
47
+ "labelToBeApplied": "",
48
+ "defaultRecordBehavior": "startLocked",
49
+ "id": "5c8af2e2-b489-4fa0-9c16-180180245ac8",
50
+ "retentionDuration": {
51
+ "days": 100
52
+ },
53
+ "createdBy": {
54
+ "user": {
55
+ "id": null,
56
+ "displayName": "John Doe"
57
+ }
58
+ },
59
+ "lastModifiedBy": {
60
+ "user": {
61
+ "id": null,
62
+ "displayName": "John Doe"
63
+ }
64
+ },
65
+ "dispositionReviewStages": []
66
+ }
67
+ ```
68
+
69
+ === "Text"
70
+
71
+ ```text
72
+ actionAfterRetentionPeriod : delete
73
+ behaviorDuringRetentionPeriod: retain
74
+ createdBy : {"user":{"id":null,"displayName":"John Doe"}}
75
+ createdDateTime : 2022-12-12T15:14:53Z
76
+ defaultRecordBehavior : startLocked
77
+ descriptionForAdmins :
78
+ descriptionForUsers :
79
+ displayName : TEST LABEL
80
+ dispositionReviewStages : []
81
+ id : 5c8af2e2-b489-4fa0-9c16-180180245ac8
82
+ isInUse : false
83
+ labelToBeApplied :
84
+ lastModifiedBy : {"user":{"id":null,"displayName":"John Doe"}}
85
+ lastModifiedDateTime : 2022-12-12T15:43:06Z
86
+ retentionDuration : {"days":100}
87
+ retentionTrigger : dateCreated
88
+ ```
89
+
90
+ === "CSV"
91
+
92
+ ```csv
93
+ displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
94
+ TEST LABEL,,,,dateCreated,retain,delete,2022-12-12T15:14:53Z,2022-12-12T15:43:06Z,,startLocked,5c8af2e2-b489-4fa0-9c16-180180245ac8,"{""days"":100}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
95
+ ```