@pnp/cli-microsoft365 5.2.0 → 5.3.0-beta.9caead4

package/dist/m365/spo/commands/roledefinition/roledefinition-list.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoRoleDefinitionListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.ROLEDEFINITION_LIST;
+    }
+    get description() {
+        return 'Gets list of role definitions for the specified site';
+    }
+    defaultProperties() {
+        return ['Id', 'Name'];
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Getting role definitions list from ${args.options.webUrl}...`);
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/roledefinitions`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            logger.log(response.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoRoleDefinitionListCommand();
+//# sourceMappingURL=roledefinition-list.js.map

package/dist/m365/spo/commands.js

@@ -41,6 +41,7 @@ exports.default = {
     FEATURE_LIST: `${prefix} feature list`,
     FIELD_ADD: `${prefix} field add`,
     FIELD_GET: `${prefix} field get`,
+    FIELD_LIST: `${prefix} field list`,
     FIELD_REMOVE: `${prefix} field remove`,
     FIELD_SET: `${prefix} field set`,
     FILE_ADD: `${prefix} file add`,
@@ -95,6 +96,8 @@ exports.default = {
     LIST_LABEL_SET: `${prefix} list label set`,
     LIST_LIST: `${prefix} list list`,
     LIST_REMOVE: `${prefix} list remove`,
+    LIST_ROLEINHERITANCE_BREAK: `${prefix} list roleinheritance break`,
+    LIST_ROLEINHERITANCE_RESET: `${prefix} list roleinheritance reset`,
     LIST_SET: `${prefix} list set`,
     LIST_SITESCRIPT_GET: `${prefix} list sitescript get`,
     LIST_VIEW_GET: `${prefix} list view get`,
@@ -159,6 +162,7 @@ exports.default = {
     REPORT_SITEUSAGEPAGES: `${prefix} report siteusagepages`,
     REPORT_SITEUSAGESITECOUNTS: `${prefix} report siteusagesitecounts`,
     REPORT_SITEUSAGESTORAGE: `${prefix} report siteusagestorage`,
+    ROLEDEFINITION_LIST: `${prefix} roledefinition list`,
     SEARCH: `${prefix} search`,
     SERVICEPRINCIPAL_GRANT_ADD: `${prefix} serviceprincipal grant add`,
     SERVICEPRINCIPAL_GRANT_LIST: `${prefix} serviceprincipal grant list`,

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.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/docs/docs/cmd/planner/bucket/bucket-remove.md

@@ -0,0 +1,60 @@
+# planner bucket remove
+
+Removes the Microsoft Planner bucket from a plan
+
+## Usage
+
+```sh
+m365 planner bucket remove [options]
+```
+
+## Options
+
+`--id [id]`
+: ID of the bucket to remove. Specify either `id` or `name` but not both.
+
+`--name [name]`
+: Name of the bucket to remove. Specify either `id` or `name` but not both.
+
+`--planId [planId]`
+: ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
+
+`--planName [planName]`
+: Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the Microsoft Planner bucket by ID
+
+```sh
+m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz"
+```
+
+Removes the Microsoft Planner bucket by ID without confirmation
+
+```sh
+m365 planner bucket remove --id "vncYUXCRBke28qMLB-d4xJcACtNz" --confirm
+```
+
+Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan with ID _oUHpnKBFekqfGE_PS6GGUZcAFY7b_
+
+```sh
+m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b"
+```
+
+Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
+
+```sh
+m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
+```

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/spo/field/field-list.md

@@ -0,0 +1,51 @@
+# spo field list
+
+Retrieves columns for the specified list or site
+
+## Usage
+
+```sh
+m365 spo field list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where fields are located
+
+`-t, --listTitle [listTitle]`
+: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`-i --listId [listId]`
+: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
+```
+
+Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
+```
+
+Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
+```
+
+Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
+```

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
+```

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

@@ -0,0 +1,36 @@
+# spo list roleinheritance reset
+
+Restores role inheritance on list or library
+
+## Usage
+
+```sh
+m365 spo list roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located
+
+`-i, --listId [listId]`
+: ID of the list. Specify either id or title but not both
+
+`-t, --listTitle [listTitle]`
+: Title of the list. Specify either id or title but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
+```
+
+Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
+```

package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md

@@ -0,0 +1,24 @@
+# spo roledefinition list
+
+Gets list of role definitions for the specified site
+
+## Usage
+
+```sh
+m365 spo roledefinition list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve role definitions
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Return list of role definitions for site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/project-x
+```

package/docs/docs/cmd/tenant/security/security-alerts-list.md

@@ -0,0 +1,30 @@
+# tenant security alerts list
+
+Gets the security alerts for a tenant
+
+## Usage
+
+```sh
+m365 tenant security alerts list [options]
+```
+
+## Options
+
+`--vendor [vendor]`
+: The vendor to return alerts for. Possible values `Azure Advanced Threat Protection`, `Azure Security Center`, `Microsoft Cloud App Security`, `Azure Active Directory Identity Protection`, `Azure Sentinel`, `Microsoft Defender ATP`. If omitted, all alerts are returned
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all security alerts for a tenant
+
+```sh
+m365 tenant security alerts list
+```
+
+Get security alerts for a vendor with name _Azure Sentinel_
+
+```sh
+m365 tenant security alerts list --vendor "Azure Sentinel"
+```