@pnp/cli-microsoft365 6.4.0-beta.39e5130 → 6.4.0-beta.8c5ba0e

package/dist/m365/purview/commands/retentionevent/retentionevent-add.js

@@ -0,0 +1,138 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _PurviewRetentionEventAddCommand_instances, _PurviewRetentionEventAddCommand_initOptions, _PurviewRetentionEventAddCommand_initValidators, _PurviewRetentionEventAddCommand_initTelemetry, _PurviewRetentionEventAddCommand_initOptionSets;
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+const accessToken_1 = require("../../../../utils/accessToken");
+const Auth_1 = require("../../../../Auth");
+const request_1 = require("../../../../request");
+const validation_1 = require("../../../../utils/validation");
+const odata_1 = require("../../../../utils/odata");
+class PurviewRetentionEventAddCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.RETENTIONEVENT_ADD;
+    }
+    get description() {
+        return 'Create a retention event';
+    }
+    constructor() {
+        super();
+        _PurviewRetentionEventAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventAddCommand_instances, "m", _PurviewRetentionEventAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventAddCommand_instances, "m", _PurviewRetentionEventAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventAddCommand_instances, "m", _PurviewRetentionEventAddCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventAddCommand_instances, "m", _PurviewRetentionEventAddCommand_initOptionSets).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
+                this.handleError('This command does not support application permissions.');
+            }
+            if (this.verbose) {
+                logger.logToStderr(`Creating retention event...`);
+            }
+            const eventQueries = [];
+            if (args.options.assetIds) {
+                eventQueries.push({ queryType: "files", query: args.options.assetIds });
+            }
+            if (args.options.keywords) {
+                eventQueries.push({ queryType: "messages", query: args.options.keywords });
+            }
+            const eventTypeId = yield this.getEventTypeId(logger, args);
+            const data = {
+                'retentionEventType@odata.bind': `https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes/${eventTypeId}`,
+                displayName: args.options.displayName,
+                description: args.options.description,
+                eventQueries: eventQueries,
+                eventTriggerDateTime: args.options.triggerDateTime
+            };
+            try {
+                const requestOptions = {
+                    url: `${this.resource}/beta/security/triggers/retentionEvents`,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    },
+                    responseType: 'json',
+                    data: data
+                };
+                const res = yield request_1.default.post(requestOptions);
+                logger.log(res);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    getEventTypeId(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.eventTypeId) {
+                return args.options.eventTypeId;
+            }
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving the event type id for event type ${args.options.eventTypeName}`);
+            }
+            const items = yield odata_1.odata.getAllItems(`${this.resource}/beta/security/triggerTypes/retentionEventTypes`);
+            const eventTypes = items.filter((x) => x.displayName === args.options.eventTypeName);
+            if (eventTypes.length === 0) {
+                throw `The specified event type '${args.options.eventTypeName}' does not exist.`;
+            }
+            return eventTypes[0].id;
+        });
+    }
+}
+_PurviewRetentionEventAddCommand_instances = new WeakSet(), _PurviewRetentionEventAddCommand_initOptions = function _PurviewRetentionEventAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-n, --displayName <displayName>'
+    }, {
+        option: '-i, --eventTypeId [eventTypeId]'
+    }, {
+        option: '-e, --eventTypeName [eventTypeName]'
+    }, {
+        option: '-d, --description [description]'
+    }, {
+        option: '--triggerDateTime [triggerDateTime]'
+    }, {
+        option: '-a, --assetIds [assetIds]'
+    }, {
+        option: '-k, --keywords [keywords]'
+    });
+}, _PurviewRetentionEventAddCommand_initValidators = function _PurviewRetentionEventAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.triggerDateTime && !validation_1.validation.isValidISODateTime(args.options.triggerDateTime)) {
+            return 'The triggerDateTime is not a valid ISO date string';
+        }
+        if (!args.options.assetIds && !args.options.keywords) {
+            return 'Specify assetIds and/or keywords, but at least one.';
+        }
+        return true;
+    }));
+}, _PurviewRetentionEventAddCommand_initTelemetry = function _PurviewRetentionEventAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            description: typeof args.options.description !== 'undefined',
+            triggerDateTime: typeof args.options.triggerDateTime !== 'undefined',
+            eventTypeId: typeof args.options.eventTypeId !== 'undefined',
+            eventTypeName: typeof args.options.eventTypeName !== 'undefined',
+            assetIds: typeof args.options.assetIds !== 'undefined',
+            keywords: typeof args.options.keywords !== 'undefined'
+        });
+    });
+}, _PurviewRetentionEventAddCommand_initOptionSets = function _PurviewRetentionEventAddCommand_initOptionSets() {
+    this.optionSets.push({ options: ['eventTypeId', 'eventTypeName'] });
+};
+module.exports = new PurviewRetentionEventAddCommand();
+//# sourceMappingURL=retentionevent-add.js.map

package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js

@@ -13,13 +13,14 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _PurviewRetentionLabelAddCommand_instances, _PurviewRetentionLabelAddCommand_initTelemetry, _PurviewRetentionLabelAddCommand_initOptions, _PurviewRetentionLabelAddCommand_initValidators;
+var _PurviewRetentionLabelAddCommand_instances, _PurviewRetentionLabelAddCommand_initTelemetry, _PurviewRetentionLabelAddCommand_initOptions, _PurviewRetentionLabelAddCommand_initValidators, _PurviewRetentionLabelAddCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
 const Auth_1 = require("../../../../Auth");
 const request_1 = require("../../../../request");
 const accessToken_1 = require("../../../../utils/accessToken");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
+const odata_1 = require("../../../../utils/odata");
 class PurviewRetentionLabelAddCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.RETENTIONLABEL_ADD;
@@ -33,6 +34,7 @@ class PurviewRetentionLabelAddCommand extends GraphCommand_1.default {
         __classPrivateFieldGet(this, _PurviewRetentionLabelAddCommand_instances, "m", _PurviewRetentionLabelAddCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _PurviewRetentionLabelAddCommand_instances, "m", _PurviewRetentionLabelAddCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _PurviewRetentionLabelAddCommand_instances, "m", _PurviewRetentionLabelAddCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _PurviewRetentionLabelAddCommand_instances, "m", _PurviewRetentionLabelAddCommand_initOptionSets).call(this);
     }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -52,6 +54,10 @@ class PurviewRetentionLabelAddCommand extends GraphCommand_1.default {
                 },
                 defaultRecordBehavior: defaultRecordBehavior
             };
+            if (args.options.retentionTrigger === 'dateOfEvent') {
+                const eventTypeId = yield this.getEventTypeId(args, logger);
+                requestBody['retentionEventType@odata.bind'] = `https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes/${eventTypeId}`;
+            }
             if (args.options.descriptionForAdmins) {
                 if (this.verbose) {
                     logger.logToStderr(`Using '${args.options.descriptionForAdmins}' as descriptionForAdmins`);
@@ -87,6 +93,22 @@ class PurviewRetentionLabelAddCommand extends GraphCommand_1.default {
             }
         });
     }
+    getEventTypeId(args, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args.options.eventTypeId) {
+                return args.options.eventTypeId;
+            }
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving the event type id for event type ${args.options.eventTypeName}`);
+            }
+            const eventTypes = yield odata_1.odata.getAllItems(`${this.resource}/beta/security/triggerTypes/retentionEventTypes`);
+            const filteredEventTypes = eventTypes.filter((eventType) => eventType.displayName === args.options.eventTypeName);
+            if (filteredEventTypes.length === 0) {
+                throw `The specified retention event type '${args.options.eventTypeName}' does not exist.`;
+            }
+            return filteredEventTypes[0].id;
+        });
+    }
 }
 _PurviewRetentionLabelAddCommand_instances = new WeakSet(), _PurviewRetentionLabelAddCommand_initTelemetry = function _PurviewRetentionLabelAddCommand_initTelemetry() {
     this.telemetry.push((args) => {
@@ -95,7 +117,9 @@ _PurviewRetentionLabelAddCommand_instances = new WeakSet(), _PurviewRetentionLab
             defaultRecordBehavior: typeof args.options.defaultRecordBehavior !== 'undefined',
             descriptionForUsers: typeof args.options.descriptionForUsers !== 'undefined',
             descriptionForAdmins: typeof args.options.descriptionForAdmins !== 'undefined',
-            labelToBeApplied: typeof args.options.labelToBeApplied !== 'undefined'
+            labelToBeApplied: typeof args.options.labelToBeApplied !== 'undefined',
+            eventTypeId: typeof args.options.eventTypeId !== 'undefined',
+            eventTypeName: typeof args.options.eventTypeName !== 'undefined'
         });
     });
 }, _PurviewRetentionLabelAddCommand_initOptions = function _PurviewRetentionLabelAddCommand_initOptions() {
@@ -103,46 +127,56 @@ _PurviewRetentionLabelAddCommand_instances = new WeakSet(), _PurviewRetentionLab
         option: '-n, --displayName <displayName>'
     }, {
         option: '--behaviorDuringRetentionPeriod <behaviorDuringRetentionPeriod>',
-        autocomplete: ['doNotRetain', 'retain', 'retainAsRecord', 'retainAsRegulatoryRecord']
+        autocomplete: PurviewRetentionLabelAddCommand.behaviorDuringRetentionPeriods
     }, {
         option: '--actionAfterRetentionPeriod <actionAfterRetentionPeriod>',
-        autocomplete: ['none', 'delete', 'startDispositionReview']
+        autocomplete: PurviewRetentionLabelAddCommand.actionAfterRetentionPeriods
     }, {
         option: '--retentionDuration <retentionDuration>'
     }, {
         option: '-t, --retentionTrigger [retentionTrigger]',
-        autocomplete: ['dateLabeled', 'dateCreated', 'dateModified', 'dateOfEvent']
+        autocomplete: PurviewRetentionLabelAddCommand.retentionTriggers
     }, {
         option: '--defaultRecordBehavior [defaultRecordBehavior]',
-        autocomplete: ['startLocked', 'startUnlocked']
+        autocomplete: PurviewRetentionLabelAddCommand.defaultRecordBehavior
     }, {
         option: '--descriptionForUsers [descriptionForUsers]'
     }, {
         option: '--descriptionForAdmins [descriptionForAdmins]'
     }, {
         option: '--labelToBeApplied [labelToBeApplied]'
+    }, {
+        option: '--eventTypeId [eventTypeId]'
+    }, {
+        option: '--eventTypeName [eventTypeName]'
     });
 }, _PurviewRetentionLabelAddCommand_initValidators = function _PurviewRetentionLabelAddCommand_initValidators() {
     this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
         if (isNaN(args.options.retentionDuration)) {
             return `Specified retentionDuration ${args.options.retentionDuration} is not a number`;
         }
-        if (['doNotRetain', 'retain', 'retainAsRecord', 'retainAsRegulatoryRecord'].indexOf(args.options.behaviorDuringRetentionPeriod) === -1) {
-            return `${args.options.behaviorDuringRetentionPeriod} is not a valid behavior of a document with the label. Allowed values are doNotRetain|retain|retainAsRecord|retainAsRegulatoryRecord`;
+        if (PurviewRetentionLabelAddCommand.behaviorDuringRetentionPeriods.indexOf(args.options.behaviorDuringRetentionPeriod) === -1) {
+            return `${args.options.behaviorDuringRetentionPeriod} is not a valid behavior of a document with the label. Allowed values are ${PurviewRetentionLabelAddCommand.behaviorDuringRetentionPeriods.join(', ')}`;
         }
-        if (['none', 'delete', 'startDispositionReview'].indexOf(args.options.actionAfterRetentionPeriod) === -1) {
-            return `${args.options.actionAfterRetentionPeriod} is not a valid action to take on a document with the label. Allowed values are none|delete|startDispositionReview`;
+        if (PurviewRetentionLabelAddCommand.actionAfterRetentionPeriods.indexOf(args.options.actionAfterRetentionPeriod) === -1) {
+            return `${args.options.actionAfterRetentionPeriod} is not a valid action to take on a document with the label. Allowed values are ${PurviewRetentionLabelAddCommand.actionAfterRetentionPeriods.join(', ')}`;
         }
         if (args.options.retentionTrigger &&
-            ['dateLabeled', 'dateCreated', 'dateModified', 'dateOfEvent'].indexOf(args.options.retentionTrigger) === -1) {
-            return `${args.options.retentionTrigger} is not a valid action retention duration calculation. Allowed values are dateLabeled|dateCreated|dateModified|dateOfEvent`;
+            PurviewRetentionLabelAddCommand.retentionTriggers.indexOf(args.options.retentionTrigger) === -1) {
+            return `${args.options.retentionTrigger} is not a valid action retention duration calculation. Allowed values are ${PurviewRetentionLabelAddCommand.retentionTriggers.join(', ')}`;
         }
         if (args.options.defaultRecordBehavior &&
-            ['startLocked', 'startUnlocked'].indexOf(args.options.defaultRecordBehavior) === -1) {
-            return `${args.options.defaultRecordBehavior} is not a valid state of a record label. Allowed values are startLocked|startUnlocked`;
+            PurviewRetentionLabelAddCommand.defaultRecordBehavior.indexOf(args.options.defaultRecordBehavior) === -1) {
+            return `${args.options.defaultRecordBehavior} is not a valid state of a record label. Allowed values are ${PurviewRetentionLabelAddCommand.defaultRecordBehavior.join(', ')}`;
         }
         return true;
     }));
+}, _PurviewRetentionLabelAddCommand_initOptionSets = function _PurviewRetentionLabelAddCommand_initOptionSets() {
+    this.optionSets.push({ options: ['eventTypeId', 'eventTypeName'], runsWhen(args) { return args.options.retentionTrigger === 'dateOfEvent'; } });
 };
+PurviewRetentionLabelAddCommand.behaviorDuringRetentionPeriods = ['doNotRetain', 'retain', 'retainAsRecord', 'retainAsRegulatoryRecord'];
+PurviewRetentionLabelAddCommand.actionAfterRetentionPeriods = ['none', 'delete', 'startDispositionReview'];
+PurviewRetentionLabelAddCommand.retentionTriggers = ['dateLabeled', 'dateCreated', 'dateModified', 'dateOfEvent'];
+PurviewRetentionLabelAddCommand.defaultRecordBehavior = ['startLocked', 'startUnlocked'];
 module.exports = new PurviewRetentionLabelAddCommand();
 //# sourceMappingURL=retentionlabel-add.js.map

package/dist/m365/purview/commands.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prefix = 'purview';
 exports.default = {
     AUDITLOG_LIST: `${prefix} auditlog list`,
+    RETENTIONEVENT_ADD: `${prefix} retentionevent add`,
     RETENTIONEVENT_GET: `${prefix} retentionevent get`,
     RETENTIONEVENT_LIST: `${prefix} retentionevent list`,
     RETENTIONEVENT_REMOVE: `${prefix} retentionevent remove`,

package/dist/m365/spo/commands/user/user-ensure.js

@@ -0,0 +1,105 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoUserEnsureCommand_instances, _SpoUserEnsureCommand_initTelemetry, _SpoUserEnsureCommand_initOptions, _SpoUserEnsureCommand_initValidators, _SpoUserEnsureCommand_initOptionSets;
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const aadUser_1 = require("../../../../utils/aadUser");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoUserEnsureCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.USER_ENSURE;
+    }
+    get description() {
+        return 'Ensures that a user is available on a specific site';
+    }
+    constructor() {
+        super();
+        _SpoUserEnsureCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoUserEnsureCommand_instances, "m", _SpoUserEnsureCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoUserEnsureCommand_instances, "m", _SpoUserEnsureCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoUserEnsureCommand_instances, "m", _SpoUserEnsureCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoUserEnsureCommand_instances, "m", _SpoUserEnsureCommand_initOptionSets).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Ensuring user ${args.options.aadId || args.options.userName} at site ${args.options.webUrl}`);
+            }
+            try {
+                const requestBody = {
+                    logonName: args.options.userName || (yield this.getUpnByUserId(args.options.aadId, logger))
+                };
+                const requestOptions = {
+                    url: `${args.options.webUrl}/_api/web/ensureuser`,
+                    headers: {
+                        accept: 'application/json;odata=nometadata'
+                    },
+                    data: requestBody,
+                    responseType: 'json'
+                };
+                const response = yield request_1.default.post(requestOptions);
+                logger.log(response);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    getUpnByUserId(aadId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving user principal name for user with id ${aadId}`);
+            }
+            return yield aadUser_1.aadUser.getUpnByUserId(aadId);
+        });
+    }
+}
+_SpoUserEnsureCommand_instances = new WeakSet(), _SpoUserEnsureCommand_initTelemetry = function _SpoUserEnsureCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            aadId: typeof args.options.aadId !== 'undefined',
+            userName: typeof args.options.userName !== 'undefined'
+        });
+    });
+}, _SpoUserEnsureCommand_initOptions = function _SpoUserEnsureCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '--aadId [aadId]'
+    }, {
+        option: '--userName [userName]'
+    });
+}, _SpoUserEnsureCommand_initValidators = function _SpoUserEnsureCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.aadId && !validation_1.validation.isValidGuid(args.options.aadId)) {
+            return `${args.options.aadId} is not a valid GUID.`;
+        }
+        if (args.options.userName && !validation_1.validation.isValidUserPrincipalName(args.options.userName)) {
+            return `${args.options.userName} is not a valid userName.`;
+        }
+        return true;
+    }));
+}, _SpoUserEnsureCommand_initOptionSets = function _SpoUserEnsureCommand_initOptionSets() {
+    this.optionSets.push({ options: ['aadId', 'userName'] });
+};
+module.exports = new SpoUserEnsureCommand();
+//# sourceMappingURL=user-ensure.js.map

package/dist/m365/spo/commands.js

@@ -299,6 +299,7 @@ exports.default = {
     THEME_LIST: `${prefix} theme list`,
     THEME_REMOVE: `${prefix} theme remove`,
     THEME_SET: `${prefix} theme set`,
+    USER_ENSURE: `${prefix} user ensure`,
     USER_GET: `${prefix} user get`,
     USER_LIST: `${prefix} user list`,
     USER_REMOVE: `${prefix} user remove`,

package/dist/utils/aadUser.js

@@ -53,6 +53,23 @@ exports.aadUser = {
             }
             return res.value[0].id;
         });
+    },
+    /**
+     * Retrieve the UPN of a user by its ID.
+     * @param id User ID.
+     */
+    getUpnByUserId(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = {
+                url: `${graphResource}/v1.0/users/${id}?$select=userPrincipalName`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const res = yield request_1.default.get(requestOptions);
+            return res.userPrincipalName;
+        });
     }
 };
 //# sourceMappingURL=aadUser.js.map

package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md

@@ -0,0 +1,149 @@
+# purview retentionevent add
+
+Create a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent add [options]
+```
+
+## Options
+
+`-n, --displayName <displayName>`
+: The display name of the event
+
+`-e, --eventTypeName [eventTypeName]`
+: Name of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
+
+`-i, --eventTypeId [eventTypeId]`
+: Id of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
+
+`-d, --description [description]`
+: A description for the event
+
+`--triggerDateTime [triggerDateTime]`
+: Optional time when the event should be triggered.
+
+`-a, --assetIds [assetIds]`
+: The Asset IDs for items in SharePoint and OneDrive that are related to this event. Only items that have labels associated with the event type you chose will be retained. Specify `assetIds` and/or `keywords`, but at least one.
+
+`-k, --keywords [keywords]`
+: The keywords for items in Exchange that are related to this event. Only items that have labels associated with the event type you chose will be retained. Specify `assetIds` and/or `keywords`, but at least one.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## Examples
+
+Create a retention event to start retention at the end of 2022 for all employee documents that have been labeled and have the Asset ID _EmployeeNr1234_
+
+```sh
+m365 purview retentionevent add --displayName 'Employee information expiration' --description 'Employee documents expired due to offboarding' --eventTypeName 'CustomRetentionTime' --triggerDateTime '2022-12-31' --assetIds 'ComplianceAssetId:EmployeeNr1234'
+```
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
+
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "displayName": "Event display name",
+      "description": "Event description",
+      "eventTriggerDateTime": "2023-04-02T15:47:54Z",
+      "lastStatusUpdateDateTime": "0001-01-01T00:00:00Z",
+      "createdDateTime": "2023-02-20T18:53:05Z",
+      "lastModifiedDateTime": "2023-02-20T18:53:05Z",
+      "id": "9f5c1a04-8f7a-4bff-e400-08db1373b324",
+      "eventQueries": [
+        {
+          "queryType": "files",
+          "query": "filesQuery,filesQuery1"
+        },
+        {
+          "queryType": "messages",
+          "query": "messagesQuery,messagesQuery1"
+        }
+      ],
+      "eventStatus": {
+        "error": null,
+        "status": "pending"
+      },
+      "eventPropagationResults": [],
+      "createdBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "lastModifiedBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdBy               : {"user":{"id":null,"displayName":"John Doe"}}
+    createdDateTime         : 2023-02-20T18:53:05Z
+    description             : Event description
+    displayName             : Event display name
+    eventPropagationResults : []
+    eventQueries            : [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
+    eventStatus             : {"error":null,"status":"pending"}
+    eventTriggerDateTime    : 2023-04-02T15:47:54Z
+    id                      : 9f5c1a04-8f7a-4bff-e400-08db1373b324
+    lastModifiedBy          : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime    : 2023-02-20T18:53:05Z
+    lastStatusUpdateDateTime: 0001-01-01T00:00:00Z 
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,eventQueries,eventStatus,eventPropagationResults,createdBy,lastModifiedBy
+    Event display name,Event description,2023-04-02T15:47:54Z,0001-01-01T00:00:00Z,2023-02-20T18:53:05Z,2023-02-20T18:53:05Z,9f5c1a04-8f7a-4bff-e400-08db1373b324,"[{""queryType"":""files"",""query"":""filesQuery,filesQuery1""},{""queryType"":""messages"",""query"":""messagesQuery,messagesQuery1""}]","{""error"":null,""status"":""pending""}",[],"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentionevent add --displayName "Event display name" --eventType "Event Type" --description "Event description" --triggerDateTime "2023-04-02T15:47:54Z" --assetIds "filesQuery,filesQuery1" --keywords "messagesQuery,messagesQuery1"
+
+    Date: 20/2/2023
+
+    ## Event display name (9f5c1a04-8f7a-4bff-e400-08db1373b324)
+
+    Property | Value
+    ---------|-------
+    displayName | Event display name
+    description | Event description
+    eventTriggerDateTime | 2023-04-02T15:47:54Z
+    lastStatusUpdateDateTime | 0001-01-01T00:00:00Z
+    createdDateTime | 2023-02-20T18:53:05Z
+    lastModifiedDateTime | 2023-02-20T18:53:05Z
+    id | 9f5c1a04-8f7a-4bff-e400-08db1373b324
+    eventQueries | [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
+    eventStatus | {"error":null,"status":"pending"}
+    eventPropagationResults | []
+    createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+    ```

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md

@@ -37,6 +37,12 @@ m365 purview retentionlabel add [options]
 `--labelToBeApplied [labelToBeApplied]`
 : Specifies the replacement label to be applied automatically after the retention period of the current label ends.
 
+`--eventTypeId [eventTypeId]`
+: The Id of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
+
+`--eventTypeName [eventTypeName]`
+:	The display name of the event type that is used to in case of an event-based label. Specify when using retentionTrigger with the value `dateOfEvent`. Specify either `eventTypeId` or `eventTypeName`, but not both.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -53,6 +59,12 @@ Create a retention label that retains documents as records and does not take any
 m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod none --retentionDuration 365 --retentionTrigger dateModified
 ```
 
+Create an event-based retention label that retains documents as records and deletes them one year after a _Contract Expiry_ event date.
+
+```sh
+m365 purview retentionlabel add --displayName 'some label' --behaviorDuringRetentionPeriod retain --actionAfterRetentionPeriod delete --retentionDuration 365 --retentionTrigger dateOfEvent --eventTypeName "Contract Expiry"
+```
+
 ## Remarks
 
 !!! attention

package/docs/docs/cmd/spfx/project/project-permissions-grant.md

@@ -63,3 +63,24 @@ m365 spfx project permissions grant
     ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
     6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
     ```
+
+=== "Markdown"
+
+    ```md
+    # spfx project permissions grant
+
+    Date: 2/17/2023
+
+    ## QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+
+    Property | Value
+    ---------|-------
+    ClientId | 6004a642-185c-479a-992a-15d1c23e2229
+    ConsentType | AllPrincipals
+    IsDomainIsolated | false
+    ObjectId | QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+    PackageName | null
+    Resource | Microsoft Graph
+    ResourceId | a46b0017-21e2-4db1-bc69-ca63576a38d6
+    Scope | Mail.Read
+    ```

package/docs/docs/cmd/spo/user/user-ensure.md

@@ -0,0 +1,109 @@
+# spo user ensure
+
+Ensures that a user is available on a specific site
+
+## Usage
+
+```sh
+m365 spo user ensure [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site.
+
+`--aadId [--aadId]`
+: Id of the user in Azure AD. Specify either `aadId` or `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. john@contoso.com). Specify either `aadId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Ensures a user by its Azure AD Id
+
+```sh
+m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --aadId e254750a-eaa4-44f6-9517-b74f65cdb747
+```
+
+Ensures a user by its user principal name
+
+```sh
+m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --userName john@contoso.com
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "Id": 35,
+      "IsHiddenInUI": false,
+      "LoginName": "i:0#.f|membership|john@contoso.com",
+      "Title": "John Doe",
+      "PrincipalType": 1,
+      "Email": "john@contoso.com",
+      "Expiration": "",
+      "IsEmailAuthenticationGuestUser": false,
+      "IsShareByEmailGuestUser": false,
+      "IsSiteAdmin": false,
+      "UserId": {
+        "NameId": "1003200274f51d2d",
+        "NameIdIssuer": "urn:federation:microsoftonline"
+      },
+      "UserPrincipalName": "john@contoso.com"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    Email                         : john@contoso.com
+    Expiration                    :
+    Id                            : 35
+    IsEmailAuthenticationGuestUser: false
+    IsHiddenInUI                  : false
+    IsShareByEmailGuestUser       : false
+    IsSiteAdmin                   : false
+    LoginName                     : i:0#.f|membership|john@contoso.com
+    PrincipalType                 : 1
+    Title                         : John Doe
+    UserId                        : {"NameId":"1003200274f51d2d","NameIdIssuer":"urn:federation:microsoftonline"}
+    UserPrincipalName             : john@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    Id,IsHiddenInUI,LoginName,Title,PrincipalType,Email,Expiration,IsEmailAuthenticationGuestUser,IsShareByEmailGuestUser,IsSiteAdmin,UserId,UserPrincipalName
+    35,,i:0#.f|membership|john@contoso.com,John Doe,1,john@contoso.com,,,,,"{""NameId"":""100320009d80e5de"",""NameIdIssuer"":""urn:federation:microsoftonline""}",john@contoso.com
+    ```
+
+=== "Markdown"
+
+    ```md
+    # spo user ensure --webUrl "https://mathijsdev2.sharepoint.com" --userName "john@contoso.com"
+
+    Date: 18/02/2023
+
+    ## John Doe (35)
+
+    Property | Value
+    ---------|-------
+    Id | 35
+    IsHiddenInUI | false
+    LoginName | i:0#.f\|membership\|john@contoso.com
+    Title | John Doe
+    PrincipalType | 1
+    Email | john@contoso.com
+    Expiration |
+    IsEmailAuthenticationGuestUser | false
+    IsShareByEmailGuestUser | false
+    IsSiteAdmin | false
+    UserId | {"NameId":"100320009d80e5de","NameIdIssuer":"urn:federation:microsoftonline"}
+    UserPrincipalName | john@contoso.com
+    ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.4.0-beta.39e5130",
+  "version": "6.4.0-beta.8c5ba0e",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",