@pnp/cli-microsoft365 5.3.0-beta.d2ec1f4 → 5.3.0-beta.ebb13d0

package/dist/m365/teams/commands/user/user-app-list.js

@@ -24,7 +24,7 @@ class TeamsUserAppListCommand extends GraphCommand_1.default {
             .then((_userId) => {
             userId = _userId.value;
             const endpoint = `${this.resource}/v1.0/users/${encodeURIComponent(userId)}/teamwork/installedApps?$expand=teamsAppDefinition`;
-            return utils_1.odata.getAllItems(endpoint, logger);
+            return utils_1.odata.getAllItems(endpoint);
         })
             .then((items) => {
             items.forEach(i => {

package/dist/m365/teams/commands/user/user-list.js

@@ -42,7 +42,7 @@ class TeamsUserListCommand extends GraphCommand_1.default {
     }
     getOwners(logger, groupId) {
         const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners?$select=id,displayName,userPrincipalName,userType`;
-        return utils_1.odata.getAllItems(endpoint, logger).then((items) => {
+        return utils_1.odata.getAllItems(endpoint).then((items) => {
             this.items = this.items.concat(items);
             // Currently there is a bug in the Microsoft Graph that returns Owners as
             // userType 'member'. We therefore update all returned user as owner
@@ -53,7 +53,7 @@ class TeamsUserListCommand extends GraphCommand_1.default {
     }
     getMembersAndGuests(logger, groupId) {
         const endpoint = `${this.resource}/v1.0/groups/${groupId}/members?$select=id,displayName,userPrincipalName,userType`;
-        return utils_1.odata.getAllItems(endpoint, logger);
+        return utils_1.odata.getAllItems(endpoint);
     }
     options() {
         const options = [

package/dist/m365/tenant/commands/security/security-alerts-list.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const request_1 = require("../../../../request");
+const commands_1 = require("../../commands");
+class TenantSecurityAlertsListCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SECURITY_ALERTS_LIST;
+    }
+    get description() {
+        return 'Gets the security alerts for a tenant';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.vendor = typeof args.options.vendor !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'title', 'severity'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .listAlert(args.options)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    listAlert(options) {
+        let queryFilter = '';
+        if (options.vendor) {
+            let vendorName = options.vendor;
+            switch (options.vendor.toLowerCase()) {
+                case 'azure security center':
+                    vendorName = 'ASC';
+                    break;
+                case 'microsoft cloud app security':
+                    vendorName = 'MCAS';
+                    break;
+                case 'azure active directory identity protection':
+                    vendorName = 'IPC';
+            }
+            queryFilter = `?$filter=vendorInformation/provider eq '${encodeURIComponent(vendorName)}'`;
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/security/alerts${queryFilter}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const alertList = response.value;
+            if (!alertList) {
+                return Promise.reject(`Error fetching security alerts`);
+            }
+            return Promise.resolve(alertList);
+        });
+    }
+    options() {
+        const options = [
+            { option: '--vendor [vendor]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantSecurityAlertsListCommand();
+//# sourceMappingURL=security-alerts-list.js.map

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js

@@ -19,7 +19,7 @@ class TenantServiceAnnouncementHealthIssueListCommand extends GraphCommand_1.def
             endpoint += `?$filter=service eq '${encodeURIComponent(args.options.service)}'`;
         }
         utils_1.odata
-            .getAllItems(endpoint, logger)
+            .getAllItems(endpoint)
             .then((items) => {
             logger.log(items);
             cb();

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js

@@ -19,7 +19,7 @@ class TenantServiceAnnouncementMessageListCommand extends GraphCommand_1.default
             endpoint += `?$filter=services/any(c:c+eq+'${encodeURIComponent(args.options.service)}')`;
         }
         utils_1.odata
-            .getAllItems(endpoint, logger)
+            .getAllItems(endpoint)
             .then((items) => {
             logger.log(items);
             cb();

package/dist/m365/tenant/commands.js

@@ -9,6 +9,7 @@ exports.default = {
     REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
     REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
     REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
+    SECURITY_ALERTS_LIST: `${prefix} security alerts list`,
     SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
     SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
     SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,

package/dist/m365/todo/commands/list/list-list.js

@@ -15,7 +15,7 @@ class TodoListListCommand extends GraphCommand_1.default {
     }
     commandAction(logger, args, cb) {
         utils_1.odata
-            .getAllItems(`${this.resource}/v1.0/me/todo/lists`, logger)
+            .getAllItems(`${this.resource}/v1.0/me/todo/lists`)
             .then((items) => {
             logger.log(items);
             cb();

package/dist/m365/todo/commands/task/task-list.js

@@ -45,7 +45,7 @@ class TodoTaskListCommand extends GraphCommand_1.default {
             .getTodoListId(args)
             .then((listId) => {
             const endpoint = `${this.resource}/v1.0/me/todo/lists/${listId}/tasks`;
-            return utils_1.odata.getAllItems(endpoint, logger);
+            return utils_1.odata.getAllItems(endpoint);
         })
             .then((items) => {
             if (args.options.output === 'json') {

package/dist/utils/accessToken.js

@@ -2,6 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.accessToken = void 0;
 exports.accessToken = {
+    isAppOnlyAccessToken(accessToken) {
+        let isAppOnlyAccessToken = false;
+        if (!accessToken || accessToken.length === 0) {
+            return isAppOnlyAccessToken;
+        }
+        const chunks = accessToken.split('.');
+        if (chunks.length !== 3) {
+            return isAppOnlyAccessToken;
+        }
+        const tokenString = Buffer.from(chunks[1], 'base64').toString();
+        try {
+            const token = JSON.parse(tokenString);
+            isAppOnlyAccessToken = token.idtyp === 'app';
+        }
+        catch (_a) {
+        }
+        return isAppOnlyAccessToken;
+    },
     getTenantIdFromAccessToken(accessToken) {
         let tenantId = '';
         if (!accessToken || accessToken.length === 0) {

package/dist/utils/formatting.js

@@ -30,8 +30,9 @@ exports.formatting = {
         return JSON.parse(s.replace(/^\uFEFF/, ''));
     },
     filterObject(obj, propertiesToInclude) {
-        return Object.keys(obj)
-            .filter(key => propertiesToInclude.includes(key))
+        const objKeys = Object.keys(obj);
+        return propertiesToInclude
+            .filter(prop => objKeys.includes(prop))
             .reduce((filtered, key) => {
             filtered[key] = obj[key];
             return filtered;
@@ -64,6 +65,14 @@ exports.formatting = {
     },
     splitAndTrim(s) {
         return s.split(',').map(c => c.trim());
+    },
+    openTypesEncoder(value) {
+        return value
+            .replace(/\%/g, '%25')
+            .replace(/\./g, '%2E')
+            .replace(/:/g, '%3A')
+            .replace(/@/g, '%40')
+            .replace(/#/g, '%23');
     }
 };
 //# sourceMappingURL=formatting.js.map

package/dist/utils/odata.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.odata = void 0;
 const request_1 = require("../request");
 exports.odata = {
-    getAllItems(url, logger, metadata) {
+    getAllItems(url, metadata) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             let items = [];
@@ -27,7 +27,7 @@ exports.odata = {
             items = res.value;
             const nextLink = (_a = res['@odata.nextLink']) !== null && _a !== void 0 ? _a : res.nextLink;
             if (nextLink) {
-                const nextPageItems = yield exports.odata.getAllItems(nextLink, logger, metadata);
+                const nextPageItems = yield exports.odata.getAllItems(nextLink, metadata);
                 items = items.concat(nextPageItems);
             }
             return items;

package/dist/utils/planner.js

@@ -0,0 +1,65 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.planner = void 0;
+const request_1 = require("../request");
+const odata_1 = require("./odata");
+const graphResource = 'https://graph.microsoft.com';
+const getRequestOptions = (url, metadata) => ({
+    url: url,
+    headers: {
+        accept: `application/json;odata.metadata=${metadata}`
+    },
+    responseType: 'json'
+});
+exports.planner = {
+    /**
+     * Get Planner plan by ID.
+     * @param id Planner ID.
+     */
+    getPlanById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = getRequestOptions(`${graphResource}/v1.0/planner/plans/${id}`, 'none');
+            try {
+                return yield request_1.default.get(requestOptions);
+            }
+            catch (ex) {
+                throw Error(`Planner plan with id '${id}' was not found.`);
+            }
+        });
+    },
+    /**
+     * Get all Planner plans for a specific group.
+     * @param groupId Group ID.
+     */
+    getPlansByGroupId(groupId) {
+        return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
+    },
+    /**
+     * Get Planner plan by name in a specific group.
+     * @param name Name of the Planner plan. Case insensitive.
+     * @param groupId Owner group ID .
+     */
+    getPlanByName(name, groupId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const plans = yield this.getPlansByGroupId(groupId);
+            const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === name.toLowerCase());
+            if (!filteredPlans.length) {
+                throw Error(`The specified plan '${name}' does not exist.`);
+            }
+            if (filteredPlans.length > 1) {
+                throw Error(`Multiple plans with name '${name}' found: ${filteredPlans.map(x => x.id)}.`);
+            }
+            return filteredPlans[0];
+        });
+    }
+};
+//# sourceMappingURL=planner.js.map

package/docs/docs/cmd/aad/app/app-add.md

@@ -49,6 +49,15 @@ m365 aad app add [options]
 `--scopeAdminConsentDescription [scopeAdminConsentDescription]`
 : Scope admin consent description
 
+`--certificateFile [certificateFile]`
+: Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateBase64Encoded [certificateBase64Encoded]`
+: Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateDisplayName [certificateDisplayName]`
+: Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
+
 `--manifest [manifest]`
 : Azure AD app manifest as retrieved from the Azure Portal to create the app registration from
 
@@ -152,3 +161,9 @@ Create new Azure AD app registration with the specified name. Store information
 ```sh
 m365 aad app add --name 'My AAD app' --save
 ```
+
+Create new Azure AD app registration with a certificate
+
+```sh
+m365 aad app add --name 'My AAD app' --certificateDisplayName "Some certificate name" --certificateFile c:\temp\some-certificate.cer
+```

package/docs/docs/cmd/aad/app/app-set.md

@@ -31,6 +31,15 @@ m365 aad app set [options]
 `--redirectUrisToRemove [redirectUrisToRemove]`
 : Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
 
+`--certificateFile [certificateFile]`
+: Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateBase64Encoded [certificateBase64Encoded]`
+: Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
+
+`--certificateDisplayName [certificateDisplayName]`
+: Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -39,6 +48,8 @@ For best performance use the `objectId` option to reference the Azure AD applica
 
 If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
 
+When a certificate is specified it will be added to the list of certificates of the app without changing existing certificates.
+
 ## Examples
 
 Update the app URI of the Azure AD application registration specified by its object ID
@@ -70,3 +81,9 @@ Replace one redirect URI with another for SPA authentication
 ```sh
 m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
 ```
+
+Add a certificate to the app
+
+```sh
+m365 aad app set --certificateDisplayName "Some certificate name" --certificateFile c:\temp\some-certificate.cer
+```

package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md

@@ -1,4 +1,4 @@
-# aad approleassignment add
+# aad approleassignment remove
 
 Deletes an app role assignment for the specified Azure AD Application Registration
 

package/docs/docs/cmd/app/app-open.md

@@ -0,0 +1,45 @@
+# aad app open
+
+Returns deep link of the current AD app to open the Azure portal on the Azure AD app registration management page.
+
+## Usage
+
+```sh
+m365 app open [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Optional Application (client) ID of the Azure AD application registration to open. Uses the app from the `.m365rc.json` file corresponding to the `appId`. If multiple apps are available, this will evade the prompt to choose an app. If the `appId` is not available in the list of apps, an error is thrown.
+
+`--preview`
+: Use to open the url of the Azure AD preview portal.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If config setting `autoOpenLinksInBrowser` is configured to true, the command will automatically open the link to the Azure Portal in the browser.
+
+Gets the app from the `.m365rc.json` file in the current directory. If the `--appId` option is not used and multiple apps are available, it will prompt the user to choose one.
+
+## Examples
+
+Prints the URL to the Azure AD application registration management page on the Azure Portal. 
+
+```sh
+m365 app open
+```
+
+Prints the url of the Azure AD application registration management page on the preview Azure Portal.
+
+```sh
+m365 app open --preview
+```
+
+Prints the URL to the Azure AD application registration management page on the Azure Portal, evading a possible choice prompt in the case of multiple saved apps in the `.m365rc.json` file. 
+
+```sh
+m365 app open --appId d75be2e1-0204-4f95-857d-51a37cf40be8 
+```

package/docs/docs/cmd/planner/bucket/bucket-get.md

@@ -0,0 +1,57 @@
+# planner bucket get
+
+Gets the Microsoft Planner bucket in a plan
+
+## Usage
+
+```sh
+m365 planner bucket get [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the bucket to retrieve details. Specify either `id` or `name` but not both.
+
+`-name, --name [name]`
+: Name of the bucket to retrieve details. Specify either `id` or `name` but not both. 
+
+`--planId [planId]`
+: Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
+
+`--planName [planName]`
+: Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets the specified Microsoft Planner bucket 
+
+```sh
+m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"
+```
+
+Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
+```
+
+Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
+```
+
+Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
+
+```sh
+m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
+```

package/docs/docs/cmd/planner/task/task-get.md

@@ -10,8 +10,29 @@ m365 planner task get [options]
 
 ## Options
 
-`-i, --id <id>`
-: ID of the task to retrieve details from
+`-i, --id  [id]`
+: ID of the task. Specify either `id` or `title` but not both. When you specify the task ID, you no longer need to provide the information for `bucket`, `plan`, and `ownerGroup`.
+
+`-t, --title [title]`
+: Title of the task. Specify either `id` or `title` but not both.
+
+`--bucketId [bucketId]`
+: Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
+
+`--bucketName [bucketName]`
+: Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
+
+`--planId [planId]`
+: Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
+
+`--planName [planName]`
+: Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -22,8 +43,14 @@ m365 planner task get [options]
 
 ## Examples
 
-Retrieve the the specified planner task
+Retrieve the the specified planner task by id.
 
 ```sh
 m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
 ```
+
+Retrieve the the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_.
+
+```sh
+m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+```

package/docs/docs/cmd/planner/task/task-reference-add.md

@@ -0,0 +1,45 @@
+# planner task reference add
+
+Adds a new reference to a Planner task.
+
+## Usage
+
+```sh
+m365 planner task reference add [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task.
+
+`-u, --url <url>`
+: URL location of the reference.
+
+`--alias [alias]`
+: A name alias to describe the reference.
+
+`--type [type]`
+: Used to describe the type of the reference. Types include: `PowerPoint`, `Word`, `Excel`, `Other`.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Add a new reference with the url _https://www.microsoft.com_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
+
+```sh
+m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com"
+```
+
+Add a new reference with the url _https://www.microsoft.com_ and with the alias _Parker_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
+
+```sh
+m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --alias "Parker"
+```
+
+Add a new reference with the url _https://www.microsoft.com_ and with the type Excel to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
+
+```sh
+m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
+```

package/docs/docs/cmd/planner/task/task-reference-list.md

@@ -0,0 +1,24 @@
+# planner task reference list
+
+Retrieve the references associated to a Planner task.
+
+## Usage
+
+```sh
+m365 planner task reference list [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task to retrieve references from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the references of the specified planner task
+
+```sh
+m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM
+```

package/docs/docs/cmd/pp/gateway/gateway-list.md

@@ -0,0 +1,21 @@
+# pp gateway list
+
+Returns a list of gateways for which the user is an admin
+
+## Usage
+
+```sh
+m365 pp gateway list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List gateways for which the user is an admin
+
+```sh
+m365 pp gateway list
+```

package/docs/docs/cmd/spo/list/list-roleinheritance-break.md

@@ -0,0 +1,55 @@
+# spo list roleinheritance break
+
+Breaks role inheritance on list or library
+
+## Usage
+
+```sh
+m365 spo list roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list to retrieve is located
+
+`-i, --listId [listId]`
+: ID of the list to retrieve information for. Specify either id or title but not both
+
+`-t, --listTitle [listTitle]`
+: Title of the list to retrieve information for. Specify either id or title but not both
+
+`-c, --clearExistingPermissions`
+: Flag if used clears all roles from the list
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+By default, when breaking permissions inheritance, the list will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
+
+## Examples
+
+Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
+```
+
+Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
+```
+
+Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
+```
+
+Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
+```