@pnp/cli-microsoft365 6.3.0-beta.4c3b2c9 → 6.3.0-beta.861847a

package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js

@@ -0,0 +1,179 @@
+"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 _SpoTenantApplicationCustomizerAddCommand_instances, _SpoTenantApplicationCustomizerAddCommand_initTelemetry, _SpoTenantApplicationCustomizerAddCommand_initOptions, _SpoTenantApplicationCustomizerAddCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const Cli_1 = require("../../../../cli/Cli");
+const spoTenantAppCatalogUrlGetCommand = require("../tenant/tenant-appcatalogurl-get");
+const spoListItemAddCommand = require("../listitem/listitem-add");
+const spoListItemListCommand = require("../listitem/listitem-list");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+class SpoTenantApplicationCustomizerAddCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.TENANT_APPLICATIONCUSTOMIZER_ADD;
+    }
+    get description() {
+        return 'Add an application customizer as a tenant wide extension.';
+    }
+    constructor() {
+        super();
+        _SpoTenantApplicationCustomizerAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerAddCommand_instances, "m", _SpoTenantApplicationCustomizerAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerAddCommand_instances, "m", _SpoTenantApplicationCustomizerAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerAddCommand_instances, "m", _SpoTenantApplicationCustomizerAddCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const appCatalogUrl = yield this.getAppCatalogUrl(logger);
+                const componentManifest = yield this.getComponentManifest(appCatalogUrl, args.options.clientSideComponentId, logger);
+                const clientComponentManifest = JSON.parse(componentManifest.ClientComponentManifest);
+                if (clientComponentManifest.extensionType !== "ApplicationCustomizer") {
+                    throw `The extension type of this component is not of type 'ApplicationCustomizer' but of type '${clientComponentManifest.extensionType}'`;
+                }
+                const solution = yield this.getSolutionFromAppCatalog(appCatalogUrl, componentManifest.SolutionId, logger);
+                if (!solution.ContainsTenantWideExtension) {
+                    throw `The solution does not contain an extension that can be deployed to all sites. Make sure that you've entered the correct component Id.`;
+                }
+                else if (!solution.SkipFeatureDeployment) {
+                    throw 'The solution has not been deployed to all sites. Make sure to deploy this solution to all sites.';
+                }
+                yield this.addTenantWideExtension(appCatalogUrl, args.options, logger);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    getAppCatalogUrl(logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const spoTenantAppCatalogUrlGetCommandOutput = yield Cli_1.Cli.executeCommandWithOutput(spoTenantAppCatalogUrlGetCommand, { options: { output: 'text', _: [] } });
+            if (this.verbose) {
+                logger.logToStderr(spoTenantAppCatalogUrlGetCommandOutput.stderr);
+            }
+            const appCatalogUrl = spoTenantAppCatalogUrlGetCommandOutput.stdout;
+            if (!appCatalogUrl) {
+                throw 'Cannot add tenant-wide application customizer as app catalog cannot be found';
+            }
+            if (this.verbose) {
+                logger.logToStderr(`Got tenant app catalog url: ${appCatalogUrl}`);
+            }
+            return appCatalogUrl;
+        });
+    }
+    getComponentManifest(appCatalogUrl, clientSideComponentId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr('Retrieving component manifest item from the ComponentManifests list on the app catalog site so that we get the solution id');
+            }
+            const camlQuery = `<View><ViewFields><FieldRef Name='ClientComponentId'></FieldRef><FieldRef Name='SolutionId'></FieldRef><FieldRef Name='ClientComponentManifest'></FieldRef></ViewFields><Query><Where><Eq><FieldRef Name='ClientComponentId' /><Value Type='Guid'>${clientSideComponentId}</Value></Eq></Where></Query></View>`;
+            const commandOptions = {
+                webUrl: appCatalogUrl,
+                listUrl: `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(appCatalogUrl)}/Lists/ComponentManifests`,
+                camlQuery: camlQuery,
+                verbose: this.verbose,
+                debug: this.debug,
+                output: 'json'
+            };
+            const output = yield Cli_1.Cli.executeCommandWithOutput(spoListItemListCommand, { options: Object.assign(Object.assign({}, commandOptions), { _: [] }) });
+            if (this.verbose) {
+                logger.logToStderr(output.stderr);
+            }
+            const outputParsed = JSON.parse(output.stdout);
+            if (outputParsed.length === 0) {
+                throw 'No component found with the specified clientSideComponentId found in the component manifest list. Make sure that the application is added to the application catalog';
+            }
+            return outputParsed[0];
+        });
+    }
+    getSolutionFromAppCatalog(appCatalogUrl, solutionId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving solution with id ${solutionId} from the application catalog`);
+            }
+            const camlQuery = `<View><ViewFields><FieldRef Name='SkipFeatureDeployment'></FieldRef><FieldRef Name='ContainsTenantWideExtension'></FieldRef></ViewFields><Query><Where><Eq><FieldRef Name='AppProductID' /><Value Type='Guid'>${solutionId}</Value></Eq></Where></Query></View>`;
+            const commandOptions = {
+                webUrl: appCatalogUrl,
+                listUrl: `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(appCatalogUrl)}/AppCatalog`,
+                camlQuery: camlQuery,
+                verbose: this.verbose,
+                debug: this.debug,
+                output: 'json'
+            };
+            const output = yield Cli_1.Cli.executeCommandWithOutput(spoListItemListCommand, { options: Object.assign(Object.assign({}, commandOptions), { _: [] }) });
+            if (this.verbose) {
+                logger.logToStderr(output.stderr);
+            }
+            const outputParsed = JSON.parse(output.stdout);
+            if (outputParsed.length === 0) {
+                throw `No component found with the solution id ${solutionId}. Make sure that the solution is available in the app catalog`;
+            }
+            return outputParsed[0];
+        });
+    }
+    addTenantWideExtension(appCatalogUrl, options, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr('Pre-checks finished. Adding tenant wide extension to the TenantWideExtensions list');
+            }
+            const commandOptions = {
+                webUrl: appCatalogUrl,
+                listUrl: `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(appCatalogUrl)}/Lists/TenantWideExtensions`,
+                Title: options.title,
+                TenantWideExtensionComponentId: options.clientSideComponentId,
+                TenantWideExtensionLocation: 'ClientSideExtension.ApplicationCustomizer',
+                TenantWideExtensionSequence: 0,
+                TenantWideExtensionListTemplate: 0,
+                TenantWideExtensionComponentProperties: options.clientSideComponentProperties || '',
+                TenantWideExtensionWebTemplate: options.webTemplate || '',
+                TenantWideExtensionDisabled: false,
+                verbose: this.verbose,
+                debug: this.debug,
+                output: options.output
+            };
+            yield Cli_1.Cli.executeCommand(spoListItemAddCommand, { options: Object.assign(Object.assign({}, commandOptions), { _: [] }) });
+        });
+    }
+}
+_SpoTenantApplicationCustomizerAddCommand_instances = new WeakSet(), _SpoTenantApplicationCustomizerAddCommand_initTelemetry = function _SpoTenantApplicationCustomizerAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            clientSideComponentProperties: typeof args.options.clientSideComponentProperties !== 'undefined',
+            webTemplate: typeof args.options.webTemplate !== 'undefined'
+        });
+    });
+}, _SpoTenantApplicationCustomizerAddCommand_initOptions = function _SpoTenantApplicationCustomizerAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-t, --title <title>'
+    }, {
+        option: '-i, --clientSideComponentId <clientSideComponentId>'
+    }, {
+        option: '-p, --clientSideComponentProperties [clientSideComponentProperties]'
+    }, {
+        option: '-w, --webTemplate [webTemplate]'
+    });
+}, _SpoTenantApplicationCustomizerAddCommand_initValidators = function _SpoTenantApplicationCustomizerAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (!validation_1.validation.isValidGuid(args.options.clientSideComponentId)) {
+            return `${args.options.clientSideComponentId} is not a valid GUID`;
+        }
+        return true;
+    }));
+};
+module.exports = new SpoTenantApplicationCustomizerAddCommand();
+//# sourceMappingURL=tenant-applicationcustomizer-add.js.map

package/dist/m365/spo/commands.js

@@ -277,6 +277,7 @@ exports.default = {
     STORAGEENTITY_REMOVE: `${prefix} storageentity remove`,
     TENANT_APPCATALOG_ADD: `${prefix} tenant appcatalog add`,
     TENANT_APPCATALOGURL_GET: `${prefix} tenant appcatalogurl get`,
+    TENANT_APPLICATIONCUSTOMIZER_ADD: `${prefix} tenant applicationcustomizer add`,
     TENANT_RECYCLEBINITEM_LIST: `${prefix} tenant recyclebinitem list`,
     TENANT_RECYCLEBINITEM_REMOVE: `${prefix} tenant recyclebinitem remove`,
     TENANT_RECYCLEBINITEM_RESTORE: `${prefix} tenant recyclebinitem restore`,

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

@@ -0,0 +1,132 @@
+# purview retentionevent get
+
+Get a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a retention event by id
+
+```sh
+m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## 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.
+
+## 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": "Contract xyz expired",
+        "description": "The retention period for documents related to Contract xyz started because the contract expired.",
+        "eventTriggerDateTime": "2023-02-01T09:16:37Z",
+        "lastStatusUpdateDateTime": "2023-02-01T09:21:15Z",
+        "createdDateTime": "2023-02-01T09:17:40Z",
+        "lastModifiedDateTime": "2023-02-01T09:17:40Z",
+        "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
+        "eventQueries": [
+            {
+                "queryType": "files",
+                "query": "1234"
+            },
+            {
+                "queryType": "messages",
+                "query": "Terminate"
+            }
+        ],
+        "eventStatus": {
+            "error": null,
+            "status": "success"
+        },
+        "eventPropagationResults": [
+            {
+                "serviceName": "SharePoint",
+                "location": null,
+                "status": "none",
+                "statusInformation": null
+            }
+        ],
+        "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-01T09:17:40Z
+    description             : The retention period for documents related to Contract xyz started because the contract expired.
+    displayName             : Contract xyz expired    
+    eventTriggerDateTime    : 2023-02-01T09:16:37Z
+    id                      : c37d695e-d581-4ae9-82a0-9364eba4291e
+    lastModifiedBy          : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime    : 2023-02-01T09:17:40Z
+    lastStatusUpdateDateTime: 2023-02-01T09:21:15Z    
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+    Contract xyz expired,The retention period for documents related to Contract xyz started because the contract expired.,2023-02-01T09:16:37Z,2023-02-01T09:21:15Z,2023-02-01T09:17:40Z,2023-02-01T09:17:40Z,c37d695e-d581-4ae9-82a0-9364eba4291e,{"user":{"id":null,"displayName":"John Doe"}},{"user":{"id":null,"displayName":"John Doe"}}
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentionevent get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
+
+    Date: 2/1/2023
+
+    ## Contract xyz expired (c37d695e-d581-4ae9-82a0-9364eba4291e)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract xyz expired
+    description | The retention period for documents related to Contract xyz started because the contract expired.
+    eventTriggerDateTime | 2023-02-01T09:16:37Z
+    lastStatusUpdateDateTime: 2023-02-01T09:21:15Z
+    createdDateTime | 2023-02-01T09:17:40Z
+    lastModifiedDateTime | 2023-02-01T09:17:40Z
+    id | c37d695e-d581-4ae9-82a0-9364eba4291e
+    createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+    ```

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

@@ -0,0 +1,107 @@
+# purview retentionevent list
+
+Get a list of retention events
+
+## Usage
+
+```sh
+m365 purview retentionevent list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention events
+
+```sh
+m365 purview retentionevent list
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently does not support app only permissions.
+
+## 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.
+
+## Response
+
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "displayName": "Contract xyz expired",
+        "description": null,
+        "eventTriggerDateTime": "2023-02-03T13:51:40Z",
+        "eventStatus": null,
+        "lastStatusUpdateDateTime": null,
+        "createdDateTime": "2023-02-03T13:51:40Z",
+        "lastModifiedDateTime": "2023-02-03T13:51:40Z",
+        "id": "7248cfa8-c03a-4ec1-49a4-08db05edc686",
+        "eventQueries": [],
+        "eventPropagationResults": [],
+        "createdBy": {
+          "user": {
+            "id": null,
+            "displayName": "John Doe"
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": null,
+            "displayName": "John Doe"
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName            eventTriggerDateTime
+    ------------------------------------  ---------------------  --------------------
+    7248cfa8-c03a-4ec1-49a4-08db05edc686  Contract xyz expired  2023-02-03T13:51:40Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,isInUse
+    7248cfa8-c03a-4ec1-49a4-08db05edc686,Contract xyz expired,2023-02-03T13:51:40Z
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentionevent list
+
+    Date: 3/2/2023
+
+    ## Contract xyz expired (7248cfa8-c03a-4ec1-49a4-08db05edc686)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract xyz expired
+    description | null
+    eventTriggerDateTime | 2023-02-03T13:51:40Z
+    eventStatus | null
+    lastStatusUpdateDateTime | null
+    createdDateTime | 2023-02-03T13:51:40Z
+    lastModifiedDateTime | 2023-02-03T13:51:40Z
+    id | 7248cfa8-c03a-4ec1-49a4-08db05edc686
+    eventQueries | []
+    eventPropagationResults | []
+    createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+    ```

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

@@ -0,0 +1,106 @@
+# purview retentioneventtype add
+
+Create a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype add [options]
+```
+
+## Options
+
+`-n, --displayName <displayName>`
+: The display name of the event type.
+
+`-d, --description [description]`
+: A description for the event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Create a retention event type *Contract Expiry*.
+
+```sh
+m365 purview retentioneventtype add --displayName 'Contract Expiry' --description 'A retention event type to start a retention period based on the date that a contract expired.'
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## 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 about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      {
+        "displayName": "Contract Expiry",
+        "description": "A retention event type to start a retention period based on the date that a contract expired.",
+        "createdDateTime": "2023-01-31T20:33:33Z",
+        "lastModifiedDateTime": "2023-01-31T20:33:33Z",
+        "id": "f15d2493-7ad2-4185-a3f6-9580542490a0",
+        "createdBy": {
+          "user": {
+            "id": null,
+            "displayName": "Mathijs Verbeeck"
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": null,
+            "displayName": "Mathijs Verbeeck"
+          }
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdBy           : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    createdDateTime     : 2023-01-31T20:40:40Z
+    description         : A retention event type to start a retention period based on the date that a contract expired.
+    displayName         : Contract Expiry
+    id                  : 806cb481-4cc6-47c3-af26-26d64f6e7aab
+    lastModifiedBy      : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    lastModifiedDateTime: 2023-01-31T20:40:40Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+    Contract Expiry,A retention event type to start a retention period based on the date that a contract expired.,2023-01-31T20:53:23Z,2023-01-31T20:53:23Z,b430ae4c-1e26-422f-9544-67df3abfb200,"{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}","{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype add --displayName "Contract Expiry" --description "A retention event type to start a retention period based on the date that a contract expired."
+
+    Date: 31/01/2023
+
+    ## Contract Expiry (ca0e1f8d-4e42-4a81-be85-022502d70c4e)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract Expiry
+    description | A retention event type to start a retention period based on the date that a contract expired.
+    createdDateTime | 2023-01-31T20:55:35Z
+    lastModifiedDateTime | 2023-01-31T20:55:35Z
+    id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
+    createdBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    ```

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md

@@ -0,0 +1,97 @@
+# purview retentioneventtype list
+
+Get a list of retention event types
+
+## Usage
+
+```sh
+m365 purview retentioneventtype list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention event types
+
+```sh
+m365 purview retentioneventtype list
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently does not support app only permissions.
+
+## 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.
+
+## Response
+
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "displayName": "Contract Expiry",
+        "description": "",
+        "createdDateTime": "2023-02-02T15:47:54Z",
+        "lastModifiedDateTime": "2023-02-02T15:47:54Z",
+        "id": "81fa91bd-66cd-4c6c-b0cb-71f37210dc74",
+        "createdBy": {
+          "user": {
+            "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
+            "displayName": null
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
+            "displayName": null
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName            createdDateTime
+    ------------------------------------  ---------------------  --------------------
+    81fa91bd-66cd-4c6c-b0cb-71f37210dc74  Contract Expiry  2023-02-02T15:47:54Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,createdDateTime
+    81fa91bd-66cd-4c6c-b0cb-71f37210dc74,Contract Expiry,2023-02-02T15:47:54Z
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype list
+
+    Date: 8/2/2023
+
+    ## Contract Expiry (81fa91bd-66cd-4c6c-b0cb-71f37210dc74)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract Expiry
+    description | null
+    createdDateTime | 2023-02-02T15:47:54Z
+    lastModifiedDateTime | 2023-02-02T15:47:54Z
+    id | 81fa91bd-66cd-4c6c-b0cb-71f37210dc74
+    createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
+    lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
+    ```

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md

@@ -0,0 +1,43 @@
+# purview retentioneventtype remove
+
+Delete a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event type.
+
+`--confirm`
+: Don't prompt for confirmation to remove the retention event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention event type by id
+
+```sh
+m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## 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 about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
+
+## Response
+
+The command won't return a response on success.