@pnp/cli-microsoft365 10.10.0-beta.bd186ba → 10.10.0

package/dist/utils/spo.js

@@ -1403,13 +1403,13 @@ export const spo = {
         await request.post(requestOptions);
     },
     /**
-     * Retrieves the site ID for a given web URL.
+     * Retrieves the site ID for a given web URL by the MS Graph.
      * @param webUrl The web URL for which to retrieve the site ID.
      * @param logger The logger object.
      * @param verbose Set for verbose logging
-     * @returns A promise that resolves to the site ID.
+     * @returns The site ID as a string.
      */
-    async getSiteId(webUrl, logger, verbose) {
+    async getSiteIdByMSGraph(webUrl, logger, verbose) {
         if (verbose && logger) {
             await logger.logToStderr(`Getting site id for URL: ${webUrl}...`);
         }
@@ -1424,6 +1424,90 @@ export const spo = {
         const site = await request.get(requestOptions);
         return site.id;
     },
+    /**
+     * Retrieves the SharePoint Online site ID for the specified web URL by the SharePoint REST API.
+     * @param webUrl The web URL of the SharePoint Online site to retrieve the site ID for.
+     * @param logger The logger object.
+     * @param verbose Set for verbose logging
+     * @returns The site ID as a string.
+     */
+    async getSiteIdBySPApi(webUrl, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Getting site id for URL: ${webUrl}...`);
+        }
+        const requestOptions = {
+            url: `${webUrl}/_api/site?$select=Id`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const siteResponse = await request.get(requestOptions);
+        return siteResponse.Id;
+    },
+    /**
+     * Retrieves the id of a SharePoint web for the specified web URL.
+     * @param webUrl The web URL for which to retrieve the web ID.
+     * @param logger The logger object for logging messages.
+     * @param verbose Set to true for verbose logging.
+     * @returns The web ID as a string.
+     */
+    async getWebId(webUrl, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Getting web id for URL: ${webUrl}...`);
+        }
+        const requestOptions = {
+            url: `${webUrl}/_api/web?$select=Id`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const webResponse = await request.get(requestOptions);
+        return webResponse.Id;
+    },
+    /**
+     * Retrieves the ID of a SharePoint list by its title or URL.
+     * @param webUrl The base URL of the SharePoint site.
+     * @param listTitle The title of the list (optional).
+     * @param listUrl The server-relative URL of the list (optional).
+     * @param logger The logger object for logging messages (optional).
+     * @param verbose Set to true for verbose logging (optional).
+     * @returns The list ID as a string.
+     */
+    async getListId(webUrl, listTitle, listUrl, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Retrieving list id...`);
+        }
+        if (!listTitle && !listUrl) {
+            throw new Error('Either listTitle or listUrl must be provided.');
+        }
+        let listId = '';
+        if (listTitle) {
+            const requestOptions = {
+                url: `${webUrl}/_api/web/lists/getByTitle('${formatting.encodeQueryParameter(listTitle)}')?$select=Id`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const listResponse = await request.get(requestOptions);
+            listId = listResponse.Id;
+        }
+        else if (listUrl) {
+            const listServerRelativeUrl = urlUtil.getServerRelativePath(webUrl, listUrl);
+            const requestOptions = {
+                url: `${webUrl}/_api/web/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')?$select=Id`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const listResponse = await request.get(requestOptions);
+            listId = listResponse.Id;
+        }
+        return listId;
+    },
     /**
      * Retrieves the server-relative URL of a folder.
      * @param webUrl Web URL

package/docs/docs/cmd/_global.mdx

@@ -1,6 +1,6 @@
 ```md definition-list
 `-h, --help [help]`
-: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `response`, `full`. Default is `options`.
+: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `permissions`, `response`, `full`. Default is `options`.
 
 `--query [query]`
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.

package/docs/docs/cmd/entra/organization/organization-set.mdx

@@ -0,0 +1,84 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# entra organization set
+
+Updates info about the organization
+
+## Usage
+
+```sh
+m365 entra organization set [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The id of the organization. Specify either `id` or `displayName`, but not both.
+
+`-d, --displayName [displayName]`
+: The name of the organization. Specify either `id` or `displayName`, but not both.
+
+`--marketingNotificationEmails [marketingNotificationEmails]`
+: The comma separated list of marketing notification emails.
+
+`--securityComplianceNotificationMails [securityComplianceNotificationMails]`
+: The comma separated list of security compliance notification emails.
+
+`--securityComplianceNotificationPhones [securityComplianceNotificationPhones]`
+: The comma separated list of security compliance notification phones.
+
+`--technicalNotificationMails [technicalNotificationMails]`
+: The comma separated list of technical notification emails.
+
+`--contactEmail [contactEmail]`
+: A valid smtp email address for the privacy statement contact
+
+`--statementUrl [statementUrl]`
+: The URL that directs to the company's privacy statement
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                                      |
+  |-----------------|--------------------------------------------------|
+  | Microsoft Graph | Organization.ReadWrite.All                       |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                                              |
+  |-----------------|----------------------------------------------------------|
+  | Microsoft Graph | Organization.ReadWrite.All                              |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Updates properties of an organization specified by id
+
+```sh
+m365 entra organization set --id 84841066-274d-4ec0-a5c1-276be684bdd3 --marketingNotificationEmails 'marketing@contoso.com'
+```
+
+Updates properties of an organization specified by displayName
+
+```sh
+m365 entra organization set --displayName Contoso --marketingNotificationEmails 'marketing@contoso.com'
+```
+
+## Response
+
+The command won't return a response on success
+
+## More information
+
+- Organization: https://learn.microsoft.com/graph/api/organization-update

package/docs/docs/cmd/planner/bucket/bucket-add.mdx

@@ -47,6 +47,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                           |
+  |-----------------|---------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                               |
+  |-----------------|-------------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Adds a Microsoft Planner bucket for a plan based on its ID with an order hint

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

@@ -47,6 +47,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                      |
+  |-----------------|----------------------------------|
+  | Microsoft Graph | Tasks.Read, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                          |
+  |-----------------|--------------------------------------|
+  | Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Gets the specified Microsoft Planner bucket 

package/docs/docs/cmd/planner/bucket/bucket-list.mdx

@@ -41,6 +41,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                      |
+  |-----------------|----------------------------------|
+  | Microsoft Graph | Tasks.Read, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                          |
+  |-----------------|--------------------------------------|
+  | Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Lists the Microsoft Planner buckets based on its plan ID

package/docs/docs/cmd/planner/bucket/bucket-remove.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # planner bucket remove
 
@@ -48,6 +50,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                           |
+  |-----------------|---------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                               |
+  |-----------------|-------------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Removes the Microsoft Planner bucket by ID

package/docs/docs/cmd/planner/bucket/bucket-set.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # planner bucket set
 
@@ -51,6 +53,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                           |
+  |-----------------|---------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                               |
+  |-----------------|-------------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Updates the Microsoft Planner bucket by its ID

package/docs/docs/cmd/planner/plan/plan-add.mdx

@@ -42,6 +42,25 @@ m365 planner plan add [options]
 
 - Hint: Unlike for groups, a Planner Roster can contain only 1 plan.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                           |
+  |-----------------|---------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                               |
+  |-----------------|-------------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Adds a Microsoft Planner plan with a Group by id.

package/docs/docs/cmd/planner/plan/plan-get.mdx

@@ -41,6 +41,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                      |
+  |-----------------|----------------------------------|
+  | Microsoft Graph | Tasks.Read, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                          |
+  |-----------------|--------------------------------------|
+  | Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Returns the Microsoft Planner plan by id.

package/docs/docs/cmd/planner/plan/plan-list.mdx

@@ -35,6 +35,25 @@ When using rosterId, the command is based on an API that is currently in preview
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                      |
+  |-----------------|----------------------------------|
+  | Microsoft Graph | Tasks.Read, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                          |
+  |-----------------|--------------------------------------|
+  | Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Returns a list of Microsoft Planner plans for the specified Group by id.

package/docs/docs/cmd/planner/plan/plan-remove.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # planner plan remove
 
@@ -35,6 +37,25 @@ m365 planner plan remove [options]
 
 If you wish to delete a Planner plan contained within a Planner Roster, you'll have to remove the roster using [planner roster remove](../roster/roster-remove.mdx).
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                           |
+  |-----------------|---------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                               |
+  |-----------------|-------------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Removes the Microsoft Planner plan by ID

package/docs/docs/cmd/planner/plan/plan-set.mdx

@@ -57,6 +57,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                           |
+  |-----------------|---------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                               |
+  |-----------------|-------------------------------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Updates a Microsoft Planner plan title.

package/docs/docs/cmd/planner/roster/roster-add.mdx

@@ -36,6 +36,25 @@ To be able to create a new Roster, the Planner Roster creation tenant setting sh
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions     |
+  |-----------------|-----------------|
+  | Microsoft Graph | Tasks.ReadWrite |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions         |
+  |-----------------|---------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Creates a new Microsoft Planner Roster

package/docs/docs/cmd/planner/roster/roster-get.mdx

@@ -29,6 +29,25 @@ This command is based on an API that is currently in preview and is subject to c
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions |
+  |-----------------|-------------|
+  | Microsoft Graph | Tasks.Read  |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Tasks.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Gets information about a specific Planner Roster.

package/docs/docs/cmd/planner/roster/roster-member-add.mdx

@@ -35,6 +35,25 @@ This command is based on an API that is currently in preview and is subject to c
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions     |
+  |-----------------|-----------------|
+  | Microsoft Graph | Tasks.ReadWrite |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions         |
+  |-----------------|---------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Adds a specific user by user name as member of the Planner Roster.

package/docs/docs/cmd/planner/roster/roster-member-get.mdx

@@ -35,6 +35,25 @@ This command is based on an API that is currently in preview and is subject to c
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions |
+  |-----------------|-------------|
+  | Microsoft Graph | Tasks.Read  |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Tasks.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Gets a specific user by user name as member of the Planner Roster.

package/docs/docs/cmd/planner/roster/roster-member-list.mdx

@@ -29,6 +29,25 @@ This command is based on an API that is currently in preview and is subject to c
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions |
+  |-----------------|-------------|
+  | Microsoft Graph | Tasks.Read  |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Tasks.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Lists members of the specified Microsoft Planner Roster.

package/docs/docs/cmd/planner/roster/roster-member-remove.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # planner roster member remove
 
@@ -42,6 +44,25 @@ The Planner Roster will be deleted when it doesn't have any users remaining in t
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions     |
+  |-----------------|-----------------|
+  | Microsoft Graph | Tasks.ReadWrite |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions         |
+  |-----------------|---------------------|
+  | Microsoft Graph | Tasks.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Remove a Roster member by its Microsoft Entra ID.

package/docs/docs/cmd/planner/roster/roster-plan-list.mdx

@@ -32,6 +32,25 @@ This command is based on an API that is currently in preview and is subject to c
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions |
+  |-----------------|-------------|
+  | Microsoft Graph | Tasks.Read  |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Tasks.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 List all Planner plans contained in a Roster where the current logged in user is member of.