@pnp/cli-microsoft365 5.0.0-beta.a1bb50f → 5.0.0-beta.a6d30c1

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

@@ -0,0 +1,56 @@
+"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 TenantServiceAnnouncementHealthListCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_LIST;
+    }
+    get description() {
+        return 'This operation provides the health report of all subscribed services for a tenant';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.issues = typeof args.options.issues !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'status', 'service'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .listServiceHealth(args.options)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    listServiceHealth(options) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const serviceHealthList = response.value;
+            if (!serviceHealthList) {
+                return Promise.reject(`Error fetching service health`);
+            }
+            return Promise.resolve(serviceHealthList);
+        });
+    }
+    options() {
+        const options = [
+            { option: '-i, --issues' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthListCommand();
+//# sourceMappingURL=serviceannouncement-health-list.js.map

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

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthIssueGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTHISSUE_GET;
+    }
+    get description() {
+        return 'Gets a specified service health issue for tenant';
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/issues/${encodeURIComponent(args.options.id)}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --id <id>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthIssueGetCommand();
+//# sourceMappingURL=serviceannouncement-healthissue-get.js.map

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthIssueListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTHISSUE_LIST;
+    }
+    get description() {
+        return 'Gets all service health issues for the tenant';
+    }
+    defaultProperties() {
+        return ['id', 'title'];
+    }
+    commandAction(logger, args, cb) {
+        let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/issues`;
+        if (args.options.service) {
+            endpoint += `?$filter=service eq '${encodeURIComponent(args.options.service)}'`;
+        }
+        this
+            .getAllItems(endpoint, logger, true)
+            .then(() => {
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-s, --service [service]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthIssueListCommand();
+//# sourceMappingURL=serviceannouncement-healthissue-list.js.map

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementMessageGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_GET;
+    }
+    get description() {
+        return 'Retrieves a specified service update message for the tenant';
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving service update message ${args.options.id}`);
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/messages/${args.options.id}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --id <id>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    isValidId(id) {
+        return (/MC\d{6}/).test(id);
+    }
+    validate(args) {
+        if (!this.isValidId(args.options.id)) {
+            return `${args.options.id} is not a valid message ID`;
+        }
+        return true;
+    }
+}
+module.exports = new TenantServiceAnnouncementMessageGetCommand();
+//# sourceMappingURL=serviceannouncement-message-get.js.map

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementMessageListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_LIST;
+    }
+    get description() {
+        return 'Gets all service update messages for the tenant';
+    }
+    defaultProperties() {
+        return ['id', 'title'];
+    }
+    commandAction(logger, args, cb) {
+        let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/messages`;
+        if (args.options.service) {
+            endpoint += `?$filter=services/any(c:c+eq+'${encodeURIComponent(args.options.service)}')`;
+        }
+        this
+            .getAllItems(endpoint, logger, true)
+            .then(() => {
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-s, --service [service]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementMessageListCommand();
+//# sourceMappingURL=serviceannouncement-message-list.js.map

package/dist/m365/tenant/commands.js

@@ -10,9 +10,15 @@ exports.default = {
     REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
     REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
     REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
+    SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
     SERVICE_LIST: `${prefix} service list`,
     SERVICE_MESSAGE_LIST: `${prefix} service message list`,
     SERVICE_REPORT_HISTORICALSERVICESTATUS: `${prefix} service report historicalservicestatus`,
+    SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
+    SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,
+    SERVICEANNOUNCEMENT_HEALTHISSUE_LIST: `${prefix} serviceannouncement healthissue list`,
+    SERVICEANNOUNCEMENT_MESSAGE_GET: `${prefix} serviceannouncement message get`,
+    SERVICEANNOUNCEMENT_MESSAGE_LIST: `${prefix} serviceannouncement message list`,
     STATUS_LIST: `${prefix} status list`
 };
 //# sourceMappingURL=commands.js.map

package/dist/settingsNames.js

@@ -5,7 +5,12 @@ const settingsNames = {
     errorOutput: 'errorOutput',
     output: 'output',
     printErrorsAsPlainText: 'printErrorsAsPlainText',
-    showHelpOnFailure: 'showHelpOnFailure'
+    showHelpOnFailure: 'showHelpOnFailure',
+    csvHeader: 'csvHeader',
+    csvEscape: 'csvEscape',
+    csvQuote: 'csvQuote',
+    csvQuoted: 'csvQuoted',
+    csvQuotedEmpty: 'csvQuotedEmpty'
 };
 exports.settingsNames = settingsNames;
 //# sourceMappingURL=settingsNames.js.map

package/docs/docs/cmd/aad/user/user-hibp.md

@@ -0,0 +1,46 @@
+# aad user hibp
+
+Allows you to retrieve all accounts that have been pwned with the specified username
+
+## Usage
+
+```sh
+m365 aad user hibp [options]
+```
+
+## Options
+
+`-n, --userName <userName>`
+: The name of the user to retrieve information for.
+
+`--apiKey, <apiKey>`
+: Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
+
+`--domain, [domain]`
+: Limit the returned breaches only contain results with the domain specified.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
+
+If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
+
+## Examples
+
+Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
+```
+
+Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
+```
+
+## More information
+
+- Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)

package/docs/docs/cmd/aad/user/user-list.md

@@ -13,6 +13,9 @@ m365 aad user list [options]
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve
 
+`-d, --deleted`
+: Use to retrieve deleted users
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -31,6 +34,12 @@ List all users in the tenant
 m365 aad user list
 ```
 
+List all recently deleted users in the tenant
+
+```sh
+m365 aad user list --deleted
+```
+
 List all users in the tenant. For each one return the display name and e-mail address
 
 ```sh

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

@@ -0,0 +1,24 @@
+# planner task details get
+
+Retrieve the details of the specified planner task
+
+## Usage
+
+```sh
+m365 planner task details get [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the details of the specified planner task
+
+```sh
+m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

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

@@ -0,0 +1,24 @@
+# planner task get
+
+Retrieve the the specified planner task
+
+## Usage
+
+```sh
+m365 planner task get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the the specified planner task
+
+```sh
+m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

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

@@ -0,0 +1,99 @@
+# planner task set
+
+Updates a Microsoft Planner task
+
+## Usage
+
+```sh
+m365 planner task set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task.
+
+`-t, --title [title]`
+: New title of the task.
+
+`--bucketId [bucketId]`
+: ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
+
+`--bucketName [bucketName]`
+: Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+
+`--planId [planId]`
+: ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
+
+`--planName [planName]`
+: Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
+
+`--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`.
+
+`--startDateTime [startDateTime]`
+: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--dueDateTime [dueDateTime]`
+: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--percentComplete [percentComplete]`
+: Percentage of task completion. Number between 0 and 100.
+
+`--assignedToUserIds [assignedToUserIds]`
+: Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--assignedToUserNames [assignedToUserNames]`
+: Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--description [description]`
+: Description of the task
+
+`--orderHint [orderHint]`
+: Hint used to order items of this type in a list view
+
+`--assigneePriority [assigneePriority]`
+: Hint used to order items of this type in a list view
+
+`--appliedCategories [appliedCategories]`
+: Comma-separated categories that should be added to the task
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When you specify the value for `percentageComplete`, consider the following:
+
+- when set to 0, the task is considered _Not started_
+- when set between 1 and 99, the task is considered _In progress_
+- when set to 100, the task is considered _Completed_
+
+You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
+
+## Examples
+
+Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
+
+```sh
+m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
+```
+
+Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to 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 set  --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+```
+
+Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
+
+```sh
+m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"  --percentComplete 50 --appliedCategories "category1,category3"
+```
+
+## Additional information
+
+- Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
+- Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)

package/docs/docs/cmd/spo/group/group-user-add.md

@@ -13,24 +13,42 @@ m365 spo group user add [options]
 `-u, --webUrl <webUrl>`
 : URL of the site where the SharePoint group is available
 
-`--groupId <groupId>`
-: Id of the SharePoint Group to which user needs to be added
+`--groupId [groupId]`
+: Id of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
 
-`--userName <userName>`
-: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com)
+`--groupName [groupName]`
+: Name of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
+
+`--userName [userName]`
+: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
+
+`--email [email]`
+: User's email (eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Add a user to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
 
 ```sh
 m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
 ```
 
-Add multiple users to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
 
 ```sh
 m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
 ```
+
+Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
+```
+
+Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+
+```sh
+m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
+```

package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md

@@ -0,0 +1,40 @@
+# spo site recyclebinitem list
+
+Lists items from recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem list [options]
+```
+
+## Options
+
+`-u, --siteUrl <siteUrl>`
+: URL of the site for which to retrieve the recycle bin items
+
+`--type [type]`
+: Type of items which should be retrieved (listItems, folders, files)
+
+`--secondary`
+: Use this switch to retrieve items from secondary recycle bin
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When type is not specified then the command will return all items in the recycle bin
+
+## Examples
+
+Lists all files, items and folders from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site
+```
+
+Lists only files from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files
+```

package/docs/docs/cmd/teams/chat/chat-list.md

@@ -0,0 +1,30 @@
+# teams chat list
+
+Lists all Microsoft Teams chat conversations for the current user.
+
+## Usage
+
+```sh
+m365 teams chat list [options]
+```
+
+## Options
+
+`-t, --type [chatType]`
+: The chat type to optionally filter chat conversations by type. The value can be `oneOnOne`, `group` or `meeting`.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all the Microsoft Teams chat conversations of the current user.
+
+```sh
+m365 teams chat list
+```
+
+List only the one on one Microsoft Teams chat conversations.
+
+```sh
+m365 teams chat list --type oneOnOne
+```

package/docs/docs/cmd/teams/chat/chat-member-list.md

@@ -0,0 +1,24 @@
+# teams chat member list
+
+Lists all members from a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat member list [options]
+```
+
+## Options
+
+`-i, --chatId <chatId>`
+: The ID of the chat conversation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List the members from a Microsoft Teams chat conversation
+
+```sh
+m365 teams chat member list --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces
+```

package/docs/docs/cmd/teams/chat/chat-message-list.md

@@ -0,0 +1,24 @@
+# teams chat message list
+
+Lists all messages from a Microsoft Teams chat conversation.
+
+## Usage
+
+```sh
+m365 teams chat message list [options]
+```
+
+## Options
+
+`-i, --chatId <chatId>`
+: The ID of the chat conversation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List the messages from a Microsoft Teams chat conversation
+
+```sh
+m365 teams chat message list --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```