@pnp/cli-microsoft365 5.3.0-beta.24cd8e4 → 5.3.0-beta.2a76d05

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/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/search/externalconnection/externalconnection-list.md

@@ -0,0 +1,21 @@
+# search externalconnection list
+
+Lists external connections defined in Microsoft Search
+
+## Usage
+
+```sh
+m365 search externalconnection list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List external connections defined in Microsoft Search
+
+```sh
+m365 search externalconnection list
+```

package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md

@@ -0,0 +1,70 @@
+# spo eventreceiver get
+
+Retrieves specific event receiver for the specified web, site or list by event receiver name or id.
+
+## Usage
+
+```sh
+m365 spo eventreceiver get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the web for which to retrieve the event receivers.
+
+`--listTitle [listTitle]`
+: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
+Specify either `listTitle`, `listId` or `listUrl`.
+
+`-n, --name [name]`
+The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
+
+`-i, --id [id]`
+The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
+
+`-s, --scope [scope]`
+: The scope of which to retrieve the Event Receivers.
+Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
+```
+
+Retrieve event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Retrieve event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
+```
+
+Retrieve event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
+
+```sh
+m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
+```

package/docs/docs/cmd/spo/list/list-view-add.md

@@ -0,0 +1,67 @@
+# spo list view add
+
+Adds a new view to a SharePoint list
+
+## Usage
+
+```sh
+m365 spo list view add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located.
+
+`--listId [listId]`
+: ID of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--listTitle [listTitle]`
+: Title of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Relative URL of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--title <title>`
+: Title of the view to be created for the list.
+
+`--fields <fields>`
+: Comma-separated list of **case-sensitive** internal names of the fields to add to the view. 
+
+`--personal`
+: View will be created as personal view, if specified.
+
+`--default`
+: View will be set as default view, if specified.
+
+`--paged`
+: View supports paging, if specified (recommended to use this).
+
+`--rowLimit [rowLimit]`
+: Sets the number of items to display for the view. Default value is 30.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+We recommend using the `paged` option. When specified, the view supports displaying more items page by page (default behavior). When not specified, the `rowLimit` is absolute, and there is no link to see more items.
+
+## Examples
+
+Add a view called _All events_ to a list with specific title.
+
+```sh
+spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "My List" --title "All events" --fields "FieldName1,FieldName2,Created,Author,Modified,Editor" --paged
+```
+
+Add a view as default view with title _All events_ to a list with a specific URL.
+
+```sh
+spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/Lists/MyList" --title "All events" --fields "FieldName1,Created" --paged --default
+```
+
+Add a personal view called _All events_ to a list with a specific ID.
+
+```sh
+spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listId 00000000-0000-0000-0000-000000000000 --title "All events" --fields "FieldName1,Created" --paged --personal
+```

package/docs/docs/cmd/spo/userprofile/userprofile-get.md

@@ -1,4 +1,4 @@
-# spo userprofile set
+# spo userprofile get
 
 Get SharePoint user profile properties for the specified user
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.3.0-beta.24cd8e4",
+  "version": "5.3.0-beta.2a76d05",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -131,6 +131,7 @@
     "Lingstuyl, Martin <martin@i4-you.com>",
     "Maillot, Michaël <battosaimykle@gmail.com>",
     "Mastykarz, Waldek <waldek@mastykarz.nl>",
+    "Mathijs Verbeeck <verbeeckmathijs@gmail.com>",
     "McDonnell, Kevin <kevin@mcd79.com>",
     "Menon, Arjun <arjun.umenon@gmail.com>",
     "Moujahid, Abderahman <rags_place@hotmail.com>",