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

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/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/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/listitem/listitem-roleinheritance-break.md

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

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

@@ -0,0 +1,39 @@
+# spo listitem roleinheritance reset
+
+Restores the role inheritance of list item, file, or folder
+
+## Usage
+
+```sh
+m365 spo listitem roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the item for which to reset role inheritance is located
+
+`--listItemId <listItemId>`
+: ID of the item for which to reset role inheritance
+
+`--listId [listId]`
+: ID of the list. Specify listId or listTitle but not both
+
+`--listTitle [listTitle]`
+: Title of the list. Specify listId or listTitle but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Restore role inheritance of list item with id 8 from list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listId 0cd891ef-afce-4e55-b836-fce03286cccf
+```
+
+Restore role inheritance of list item with id 8 from list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --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/teams/channel/channel-member-list.md

@@ -35,10 +35,10 @@ m365 teams conversationmember list [options]
 
 ## Examples
   
-List the members of a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+List the members of a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype
+m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype
 ```
 
 List the members of a specified Microsoft Teams team with name _Team Name_ and channel with name _Channel Name_
@@ -47,8 +47,8 @@ List the members of a specified Microsoft Teams team with name _Team Name_ and c
 m365 teams channel member list --teamName "Team Name" --channelName "Channel Name"
 ```
 
-List all owners of the specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+List all owners of the specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype --role owner
+m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --role owner
 ```

package/docs/docs/cmd/teams/channel/channel-member-remove.md

@@ -44,10 +44,10 @@ m365 teams conversationmember remove [options]
 
 ## Examples
   
-Remove the user _johndoe@example.com_ from the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+Remove the user _johndoe@example.com_ from the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member remove --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com"
+m365 teams channel member remove --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com"
 ```
 
 Remove the user with id 00000000-0000-0000-0000-000000000000 from the Microsoft Teams team with name _Team Name_ and channel with name _Channel Name_

package/docs/docs/cmd/teams/channel/channel-member-set.md

@@ -38,10 +38,10 @@ m365 teams channel member set [options]
 
 ## Examples
   
-Updates the role of the user _johndoe@example.com_ to owner in the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 00:00000000000000000000000000000000@thread.skype
+Updates the role of the user _johndoe@example.com_ to owner in the Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype
 
 ```sh
-m365 teams channel member set --teamId 00000000-0000-0000-0000-000000000000 --channelId 00:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com" --role owner
+m365 teams channel member set --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --userName "johndoe@example.com" --role owner
 ```
 
 Updates the role of the user with id 00000000-0000-0000-0000-000000000000 to member in the Microsoft Teams team with name _Team Name_ and channel with name _Channel Name_

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

package/package.json

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