@pnp/cli-microsoft365 10.7.0 → 10.8.0-beta.26ade35

package/dist/m365/spo/commands/site/site-set.js

@@ -4,19 +4,16 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _SpoSiteSetCommand_instances, _SpoSiteSetCommand_initTelemetry, _SpoSiteSetCommand_initOptions, _SpoSiteSetCommand_initValidators, _SpoSiteSetCommand_initTypes;
-import { cli } from '../../../../cli/cli.js';
-import { CommandError } from '../../../../Command.js';
 import config from '../../../../config.js';
 import request from '../../../../request.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { spo } from '../../../../utils/spo.js';
 import { urlUtil } from '../../../../utils/urlUtil.js';
 import { validation } from '../../../../utils/validation.js';
-import entraM365GroupSetCommand from '../../../entra/commands/m365group/m365group-set.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
 import { SharingCapabilities } from '../site/SharingCapabilities.js';
-import spoSiteDesignApplyCommand from '../sitedesign/sitedesign-apply.js';
 import { FlowsPolicy } from './FlowsPolicy.js';
 import { setTimeout } from 'timers/promises';
 class SpoSiteSetCommand extends SpoCommand {
@@ -55,9 +52,6 @@ class SpoSiteSetCommand extends SpoCommand {
             await this.waitForSiteUpdateCompletion(logger, args, lockState);
         }
         catch (err) {
-            if (err instanceof CommandError) {
-                err = err.message;
-            }
             this.handleRejectedPromise(err);
         }
     }
@@ -233,13 +227,7 @@ class SpoSiteSetCommand extends SpoCommand {
             promises.push(request.post(requestOptions));
         }
         if (typeof args.options.isPublic !== 'undefined') {
-            const commandOptions = {
-                id: this.groupId,
-                isPrivate: (args.options.isPublic === false),
-                debug: this.debug,
-                verbose: this.verbose
-            };
-            promises.push(cli.executeCommand(entraM365GroupSetCommand, { options: { ...commandOptions, _: [] } }));
+            promises.push(entraGroup.setGroup(this.groupId, (args.options.isPublic === false), undefined, undefined, logger, this.verbose));
         }
         if (args.options.description) {
             promises.push(this.setGroupifiedSiteDescription(args.options.description));
@@ -383,14 +371,7 @@ class SpoSiteSetCommand extends SpoCommand {
         if (typeof args.options.siteDesignId === 'undefined') {
             return;
         }
-        const options = {
-            webUrl: args.options.url,
-            id: args.options.siteDesignId,
-            asTask: false,
-            debug: this.debug,
-            verbose: this.verbose
-        };
-        return cli.executeCommand(spoSiteDesignApplyCommand, { options: { ...options, _: [] } });
+        return spo.applySiteDesign(args.options.url, args.options.siteDesignId, logger, this.verbose);
     }
     async loadSiteIds(siteUrl, logger) {
         if (this.debug) {

package/dist/m365/teams/commands/app/app-install.js

@@ -6,9 +6,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _TeamsAppInstallCommand_instances, _TeamsAppInstallCommand_initTelemetry, _TeamsAppInstallCommand_initOptions, _TeamsAppInstallCommand_initValidators, _TeamsAppInstallCommand_initOptionSets;
 import { cli } from '../../../../cli/cli.js';
 import request from '../../../../request.js';
+import { entraUser } from '../../../../utils/entraUser.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { validation } from '../../../../utils/validation.js';
-import entraUserGetCommand from '../../../entra/commands/user/user-get.js';
 import GraphCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
 class TeamsAppInstallCommand extends GraphCommand {
@@ -63,16 +63,10 @@ class TeamsAppInstallCommand extends GraphCommand {
         if (this.verbose) {
             await logger.logToStderr(`Checking if user ${args.options.userId} exists...`);
         }
-        const options = {
-            id: args.options.userId,
-            output: 'json',
-            debug: args.options.debug,
-            verbose: args.options.verbose
-        };
         try {
-            const res = await cli.executeCommandWithOutput(entraUserGetCommand, { options: { ...options, _: [] } });
+            const res = await entraUser.getUpnByUserId(args.options.userId, logger, this.verbose);
             if (this.verbose) {
-                await logger.logToStderr(res.stderr);
+                await logger.logToStderr(res);
             }
             return true;
         }

package/dist/m365/viva/commands/connections/connections-app-create.js

@@ -8,10 +8,9 @@ import AdmZip from 'adm-zip';
 import fs from 'fs';
 import path from 'path';
 import { v4 } from 'uuid';
-import { cli } from '../../../../cli/cli.js';
 import AnonymousCommand from '../../../base/AnonymousCommand.js';
-import spoWebGetCommand from '../../../spo/commands/web/web-get.js';
 import commands from '../../commands.js';
+import { spo } from '../../../../utils/spo.js';
 class VivaConnectionsAppCreateCommand extends AnonymousCommand {
     get name() {
         return commands.CONNECTIONS_APP_CREATE;
@@ -27,14 +26,13 @@ class VivaConnectionsAppCreateCommand extends AnonymousCommand {
     }
     async commandAction(logger, args) {
         try {
-            const getWebOutput = await this.getWeb(args, logger);
+            const web = await this.getWeb(args, logger);
             if (this.debug) {
-                await logger.logToStderr(getWebOutput.stderr);
+                await logger.logToStderr(web);
             }
             if (this.verbose) {
                 await logger.logToStderr(`Site found at ${args.options.portalUrl}. Checking if it's a communication site...`);
             }
-            const web = JSON.parse(getWebOutput.stdout);
             if (web.WebTemplate !== 'SITEPAGEPUBLISHING' ||
                 web.Configuration !== 0) {
                 throw `Site ${args.options.portalUrl} is not a Communication Site. Please specify a different site and try again.`;
@@ -137,13 +135,7 @@ class VivaConnectionsAppCreateCommand extends AnonymousCommand {
         if (this.verbose) {
             await logger.logToStderr(`Checking if site ${args.options.url} exists...`);
         }
-        const options = {
-            url: args.options.portalUrl,
-            output: 'json',
-            debug: this.debug,
-            verbose: this.verbose
-        };
-        return cli.executeCommandWithOutput(spoWebGetCommand, { options: { ...options, _: [] } });
+        return await spo.getWeb(args.options.portalUrl, logger, this.verbose);
     }
 }
 _VivaConnectionsAppCreateCommand_instances = new WeakSet(), _VivaConnectionsAppCreateCommand_initOptions = function _VivaConnectionsAppCreateCommand_initOptions() {

package/dist/utils/entraGroup.js

@@ -103,11 +103,17 @@ export const entraGroup = {
         }
         return groups[0].id;
     },
-    async setGroup(id, isPrivate, logger, verbose) {
+    async setGroup(id, isPrivate, displayName, description, logger, verbose) {
         if (verbose && logger) {
             await logger.logToStderr(`Updating Microsoft 365 Group ${id}...`);
         }
         const update = {};
+        if (displayName) {
+            update.displayName = displayName;
+        }
+        if (description) {
+            update.description = description;
+        }
         if (typeof isPrivate !== 'undefined') {
             update.visibility = isPrivate ? 'Private' : 'Public';
         }

package/dist/utils/entraUser.js

@@ -112,9 +112,15 @@ export const entraUser = {
     },
     /**
      * Retrieve the UPN of a user by its ID.
+     * Returns the UPN as string
      * @param id User ID.
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
      */
-    async getUpnByUserId(id) {
+    async getUpnByUserId(id, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Retrieving the upn for user ${id}`);
+        }
         const requestOptions = {
             url: `${graphResource}/v1.0/users/${id}?$select=userPrincipalName`,
             headers: {

package/dist/utils/spo.js

@@ -1003,7 +1003,7 @@ export const spo = {
                     promises.push(request.post(requestOptions));
                 }
                 if (typeof isPublic !== 'undefined') {
-                    promises.push(entraGroup.setGroup(groupId, (isPublic === false), logger, verbose));
+                    promises.push(entraGroup.setGroup(groupId, (isPublic === false), undefined, undefined, logger, verbose));
                 }
                 if (typeof owners !== 'undefined') {
                     promises.push(spo.setGroupifiedSiteOwners(spoAdminUrl, groupId, owners, logger, verbose));

package/dist/utils/zod.js

@@ -110,16 +110,41 @@ function parseDef(def, options, currentOption) {
         }
     } while (parsedDef);
 }
+function optionToString(optionInfo) {
+    let s = '';
+    if (optionInfo.short) {
+        s += `-${optionInfo.short}, `;
+    }
+    s += `--${optionInfo.long}`;
+    if (optionInfo.type !== 'boolean') {
+        s += ' ';
+        s += optionInfo.required ? '<' : '[';
+        s += optionInfo.long;
+        s += optionInfo.required ? '>' : ']';
+    }
+    return s;
+}
+;
 export const zod = {
     alias(alias, type) {
         type._def.alias = alias;
         return type;
     },
-    schemaToOptions(schema) {
+    schemaToOptionInfo(schema) {
         const options = [];
         parseDef(schema._def, options);
         return options;
     },
+    schemaToOptions(schema) {
+        const optionsInfo = this.schemaToOptionInfo(schema);
+        const options = optionsInfo.map(option => {
+            return {
+                option: optionToString(option),
+                autocomplete: option.autocomplete
+            };
+        });
+        return options;
+    },
     coercedEnum: (e) => z.preprocess(val => {
         const target = String(val)?.toLowerCase();
         for (const k of Object.values(e)) {

package/docs/docs/cmd/adaptivecard/adaptivecard-send.mdx

@@ -17,7 +17,7 @@ m365 adaptivecard send [options]
 : URL where to send the card to.
 
 `-t, --title [title]`
-: Title of the card. Specify either `title` or `card` but not both.
+: Title of the card. If you specify `title` and `card`, the `title` will be merged into the card.
 
 `-d, --description [description]`
 : Contents of the card.

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

@@ -0,0 +1,154 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# entra organization list
+
+Retrieves a list of organizations
+
+## Usage
+
+```sh
+m365 entra organization list [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --properties [properties]`
+: The comma separated list of properties to be returned.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+Applications granted the `User.Read` permission are able to read only the id, displayName, and verifiedDomains properties of the organization. 
+All other properties return with null values. To read all properties, use at least `Organization.Read.All`.
+
+:::
+
+## Examples
+
+Retrieve organizations
+
+```sh
+m365 entra organization list
+```
+
+Retrieve specific info
+
+```sh
+m365 entra organization list --properties 'id,displayName,tenantType'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "e65b162c-6f87-4eb1-a24e-1b37d3504663",
+      "deletedDateTime": null,
+      "businessPhones": [
+        "4258828080"
+      ],
+      "city": null,
+      "country": null,
+      "countryLetterCode": "IE",
+      "createdDateTime": "2023-02-21T19:56:38Z",
+      "defaultUsageLocation": null,
+      "displayName": "Contoso",
+      "isMultipleDataLocationsForServicesEnabled": null,
+      "marketingNotificationEmails": [],
+      "onPremisesLastSyncDateTime": null,
+      "onPremisesSyncEnabled": null,
+      "partnerTenantType": null,
+      "postalCode": null,
+      "preferredLanguage": "en",
+      "securityComplianceNotificationMails": [],
+      "securityComplianceNotificationPhones": [],
+      "state": null,
+      "street": null,
+      "technicalNotificationMails": [
+        "john.doe@contoso.com"
+      ],
+      "tenantType": "AAD",
+      "directorySizeQuota": {
+        "used": 1400,
+        "total": 300000
+      },
+      "assignedPlans": [],
+      "onPremisesSyncStatus": [],
+      "privacyProfile": {
+        "contactEmail": "john.doe@contoso.com",
+        "statementUrl": ""
+      },
+      "provisionedPlans": [],
+      "verifiedDomains": [
+        {
+          "capabilities": "Email, OfficeCommunicationsOnline",
+          "isDefault": true,
+          "isInitial": true,
+          "name": "contoso.onmicrosoft.com",
+          "type": "Managed"
+        },
+        {
+          "capabilities": "Email, OfficeCommunicationsOnline, MoeraDomain",
+          "isDefault": false,
+          "isInitial": false,
+          "name": "contoso2.onmicrosoft.com",
+          "type": "Managed"
+        }
+      ]
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  displayName: Contoso
+  id         : e65b162c-6f87-4eb1-a24e-1b37d3504663
+  tenantType : AAD
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,deletedDateTime,city,country,countryLetterCode,createdDateTime,defaultUsageLocation,displayName,isMultipleDataLocationsForServicesEnabled,onPremisesLastSyncDateTime,onPremisesSyncEnabled,partnerTenantType,postalCode,preferredLanguage,state,street,tenantType
+  e65b162c-6f87-4eb1-a24e-1b37d3504663,,,,IE,2023-02-21T19:56:38Z,,Contoso,,,,,,en,,,AAD
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # entra organization list --debug "false" --verbose "false"
+
+  Date: 4/18/2025
+
+  ## Contoso (e65b162c-6f87-4eb1-a24e-1b37d3504663)
+
+  Property | Value
+  ---------|-------
+  id | e65b162c-6f87-4eb1-a24e-1b37d3504663
+  countryLetterCode | IE
+  createdDateTime | 2023-02-21T19:56:38Z
+  displayName | Contoso
+  preferredLanguage | en
+  tenantType | AAD
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Organization: https://learn.microsoft.com/graph/api/organization-list

package/docs/docs/cmd/graph/openextension/openextension-set.mdx

@@ -0,0 +1,97 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph openextension set
+
+Updates an open extension for a resource
+
+## Usage
+
+```sh
+m365 graph openextension set [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: The name of the open extension.
+
+`-i, --resourceId <resourceId>`
+: The Id of the resource for which to update the open extension.
+
+`-t, --resourceType <resourceType>`
+: The type of resource. Allowed values are `user`, `group`, `device`, `organization`.
+
+`-k, --keepUnchangedProperties`
+: Keeps unspecified properties. Without this flag, any property that is not updated will be removed from the extension.
+```
+
+<Global />
+
+## Remarks
+
+This command allows using unknown options to update custom data of the open extension.
+
+When updating an open extension to a user, it's possible to use the UPN as the resourceId.
+
+:::warning[Escaping JSON in PowerShell]
+
+When updating open extensions it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+:::info
+
+If a property of the open extension is not specified, the property is removed from the open extension.
+
+If a property of the open extension is not specified and `keepUnchangedProperties` is specified, the property will be kept in the open extension.
+
+:::
+
+## Examples
+
+Updates an open extension for a user specified by id
+
+```sh
+m365 graph openextension set --userId eb77fbcf-6fe8-458b-985d-1747284793bc --name 'com.contoso.roamingSettings' --resourceType user --theme dark --color red --language English
+```
+
+Updates an open extension for a user specified by UPN
+
+```sh
+m365 graph openextension set --userName john.doe@contoso.com --name 'com.contoso.roamingSettings' --resourceType user --theme dark --color red --language English
+```
+
+Updates an open extension for a group specified by id, one of the property represents a JSON object
+
+```sh
+m365 graph openextension set --resourceId c956e711-f074-40c3-8431-fbd69bb67d9c --name 'com.contoso.roamingSettings' --resourceType group --settings '{"theme": "dark", "color": "red" }'
+```
+
+Updates an open extension, but keeps the properties that are not specified
+
+```sh
+m365 graph openextension set --userId eb77fbcf-6fe8-458b-985d-1747284793bc --name 'com.contoso.roamingSettings' --resourceType user --color red --keepUnchangedProperties
+```
+
+Updates an open extension, but removes the properties that are not specified
+
+```sh
+m365 graph openextension set --userId eb77fbcf-6fe8-458b-985d-1747284793bc --name 'com.contoso.roamingSettings' --resourceType user --color red
+```
+
+Clears the value of the property
+
+```sh
+m365 graph openextension set --userId eb77fbcf-6fe8-458b-985d-1747284793bc --name 'com.contoso.roamingSettings' --resourceType user --theme ""
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- Open extensions: https://learn.microsoft.com/graph/extensibility-overview?tabs=http#open-extensions

package/docs/docs/cmd/spe/container/container-permission-list.mdx

@@ -0,0 +1,90 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spe container permission list
+
+Lists permissions of a SharePoint Embedded Container
+
+## Usage
+
+```sh
+m365 spe container permission list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --containerId <id>`
+: The ID of the SharePoint Embedded Container.
+```
+
+<Global />
+
+## Examples
+
+Lists Container permissions.
+
+```sh
+m365 spe container permission list --containerId "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "X2k6MCMuZnxtZW1iZXJzaGlwfGRlYnJhYkBuYWNoYW4zNjUub25taWNyb3NvZnQuY29t",
+      "roles": [
+        "owner"
+      ],
+      "grantedToV2": {
+        "user": {
+          "displayName": "John Doe",
+          "email": "john.doe@contoso.onmicrosoft.com",
+          "userPrincipalName": "john.doe@contoso.onmicrosoft.com"
+        }
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                                                    userPrincipalName                 roles
+  --------------------------------------------------------------------  --------------------------------  ------
+  X2k6MCMuZnxtZW1iZXJzaGlwfGRlYnJhYkBuYWNoYW4zNjUub25taWNyb3NvZnQuY29t  john.doe@contoso.onmicrosoft.com  owner
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,roles,userPrincipalName
+  X2k6MCMuZnxtZW1iZXJzaGlwfGRlYnJhYkBuYWNoYW4zNjUub25taWNyb3NvZnQuY29t,owner,john.doe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spe container permission list --containerId "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z"
+
+  Date: 3/3/2025
+
+  ## X2k6MCMuZnxtZW1iZXJzaGlwfGRlYnJhYkBuYWNoYW4zNjUub25taWNyb3NvZnQuY29t
+
+  Property | Value
+  ---------|-------
+  id | X2k6MCMuZnxtZW1iZXJzaGlwfGRlYnJhYkBuYWNoYW4zNjUub25taWNyb3NvZnQuY29t
+  roles | owner
+  userPrincipalName | john.doe@contoso.onmicrosoft.com
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/spo/field/field-get.mdx

@@ -32,7 +32,6 @@ m365 spo field get [options]
 
 `-t, --title [title]`
 : The display name (case-sensitive) of the field to retrieve. Specify either `id`, `title` or `internalName`.
-```
 
 `--internalName [internalName]`
 : The internal name (case-sensitive) of the field to retrieve. Specify either `id`, `title` or `internalName`.