@pnp/cli-microsoft365 10.8.0-beta.708bf27 → 10.8.0-beta.cdb5c81

package/dist/m365/spe/commands.js

@@ -1,10 +1,15 @@
 const prefix = 'spe';
 export default {
     CONTAINER_ACTIVATE: `${prefix} container activate`,
+    CONTAINER_ADD: `${prefix} container add`,
     CONTAINER_GET: `${prefix} container get`,
     CONTAINER_LIST: `${prefix} container list`,
+    CONTAINER_REMOVE: `${prefix} container remove`,
+    CONTAINER_PERMISSION_LIST: `${prefix} container permission list`,
+    CONTAINER_RECYCLEBINITEM_LIST: `${prefix} container recyclebinitem list`,
     CONTAINERTYPE_ADD: `${prefix} containertype add`,
     CONTAINERTYPE_GET: `${prefix} containertype get`,
-    CONTAINERTYPE_LIST: `${prefix} containertype list`
+    CONTAINERTYPE_LIST: `${prefix} containertype list`,
+    CONTAINERTYPE_REMOVE: `${prefix} containertype remove`
 };
 //# sourceMappingURL=commands.js.map

package/dist/m365/spo/commands/page/page-section-add.js

@@ -59,19 +59,25 @@ class SpoPageSectionAddCommand extends SpoCommand {
                 };
                 await request.post(requestOptions);
             }
-            // get columns
-            const columns = canvasContent
-                .filter(c => typeof c.controlType === 'undefined');
             // get unique zoneIndex values given each section can have 1 or more
             // columns each assigned to the zoneIndex of the corresponding section
-            const zoneIndices = columns
+            const zoneIndices = canvasContent
+                // Exclude the vertical section
+                .filter(c => c.position)
                 .map(c => c.position.zoneIndex)
                 .filter((value, index, array) => {
                 return array.indexOf(value) === index;
             })
-                .sort();
-            // zoneIndex for the new section to add
-            const zoneIndex = this.getSectionIndex(zoneIndices, args.options.order);
+                .sort((a, b) => a - b);
+            // Add a new zoneIndex  at the end of the array
+            zoneIndices.push(zoneIndices.length > 0 ? zoneIndices[zoneIndices.length - 1] + 1 : 1);
+            // get section number. if not specified, get the last section
+            let section = args.options.order || zoneIndices.length;
+            if (section > zoneIndices.length) {
+                section = zoneIndices.length;
+            }
+            // zoneIndex that represents the section where the web part should be added
+            const zoneIndex = zoneIndices[section - 1];
             let zoneId;
             let backgroundControlToAdd = undefined;
             if (args.options.zoneEmphasis && ['image', 'gradient'].includes(args.options.zoneEmphasis.toLowerCase())) {
@@ -83,11 +89,17 @@ class SpoPageSectionAddCommand extends SpoCommand {
                     canvasContent.push(backgroundControlToAdd);
                 }
             }
+            // Increment the zoneIndex of all columns that are greater than or equal to the new zoneIndex
+            canvasContent.forEach((c) => {
+                if (c.position && c.position.zoneIndex >= zoneIndex) {
+                    c.position.zoneIndex += 1;
+                }
+            });
             // get the list of columns to insert based on the selected template
             const columnsToAdd = this.getColumns(zoneIndex, args, zoneId);
             // insert the column in the right place in the array so that
             // it stays sorted ascending by zoneIndex
-            let pos = canvasContent.findIndex(c => typeof c.controlType === 'undefined' && c.position && c.position.zoneIndex > zoneIndex);
+            let pos = canvasContent.findIndex(c => c.position && c.position.zoneIndex >= zoneIndex);
             if (pos === -1) {
                 pos = canvasContent.length - 1;
             }
@@ -109,21 +121,6 @@ class SpoPageSectionAddCommand extends SpoCommand {
             this.handleRejectedODataJsonPromise(err);
         }
     }
-    getSectionIndex(zoneIndices, order) {
-        // zoneIndex of the first column on the page
-        const minIndex = zoneIndices.length === 0 ? 0 : zoneIndices[0];
-        // zoneIndex of the last column on the page
-        const maxIndex = zoneIndices.length === 0 ? 0 : zoneIndices[zoneIndices.length - 1];
-        if (!order || order > zoneIndices.length) {
-            // no order specified, add section to the end
-            return maxIndex === 0 ? 1 : maxIndex * 2;
-        }
-        // add to the beginning
-        if (order === 1) {
-            return minIndex / 2;
-        }
-        return zoneIndices[order - 2] + ((zoneIndices[order - 1] - zoneIndices[order - 2]) / 2);
-    }
     getColumns(zoneIndex, args, zoneId) {
         const columns = [];
         let sectionIndex = 1;

package/dist/utils/entraServicePrincipal.js

@@ -41,6 +41,17 @@ export const entraServicePrincipal = {
             return await cli.handleMultipleResultsFound(`Multiple service principals with name '${appName}' found in Microsoft Entra ID.`, resultAsKeyValuePair);
         }
         return apps[0];
+    },
+    /**
+     * Get all available service principals.
+     * @param properties Comma-separated list of properties to include in the response.
+     */
+    async getServicePrincipals(properties) {
+        let url = `https://graph.microsoft.com/v1.0/servicePrincipals`;
+        if (properties) {
+            url += `?$select=${properties}`;
+        }
+        return odata.getAllItems(url);
     }
 };
 //# sourceMappingURL=entraServicePrincipal.js.map

package/dist/utils/formatting.js

@@ -177,6 +177,18 @@ export const formatting = {
             resultAsKeyValuePair[obj[key]] = obj;
         });
         return resultAsKeyValuePair;
+    },
+    /**
+     * Extracts the GUID from a string in CSOM format.
+     * @param str The string to extract the GUID from
+     * @description The string should be in the format /Guid(XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)/
+     * @returns The extracted GUID or the original string if no match is found
+     * @example /Guid(eae15efb-ac09-49b9-8906-e579efd622e4)/ => eae15efb-ac09-49b9-8906-e579efd622e4
+     */
+    extractCsomGuid(str) {
+        const guidPattern = /\/Guid\(([0-9a-f-]+)\)\//i;
+        const match = str.match(guidPattern);
+        return match ? match[1] : str;
     }
 };
 //# sourceMappingURL=formatting.js.map

package/dist/utils/spe.js

@@ -0,0 +1,77 @@
+import request from '../request.js';
+import { formatting } from './formatting.js';
+import { cli } from '../cli/cli.js';
+import config from '../config.js';
+import { odata } from './odata.js';
+const graphResource = 'https://graph.microsoft.com';
+export const spe = {
+    /**
+     * Get all container types.
+     * @param spoAdminUrl The URL of the SharePoint Online admin center site (e.g. https://contoso-admin.sharepoint.com)
+     * @returns Array of container types
+     */
+    async getAllContainerTypes(spoAdminUrl) {
+        const requestOptions = {
+            url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json',
+            data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="46" ObjectPathId="45" /><Method Name="GetSPOContainerTypes" Id="47" ObjectPathId="45"><Parameters><Parameter Type="Enum">1</Parameter></Parameters></Method></Actions><ObjectPaths><Constructor Id="45" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
+        };
+        const json = await request.post(requestOptions);
+        const response = json[0];
+        if (response.ErrorInfo) {
+            throw new Error(response.ErrorInfo.ErrorMessage);
+        }
+        const containerTypes = json[json.length - 1];
+        // Format the response to remove CSOM GUIDs and convert them to real GUIDs
+        containerTypes.forEach(ct => {
+            delete ct._ObjectType_;
+            ct.AzureSubscriptionId = formatting.extractCsomGuid(ct.AzureSubscriptionId);
+            ct.ContainerTypeId = formatting.extractCsomGuid(ct.ContainerTypeId);
+            ct.OwningAppId = formatting.extractCsomGuid(ct.OwningAppId);
+            ct.OwningTenantId = formatting.extractCsomGuid(ct.OwningTenantId);
+        });
+        return containerTypes;
+    },
+    /**
+     * Get the ID of a container type by its name.
+     * @param spoAdminUrl SharePoint Online admin center URL (e.g. https://contoso-admin.sharepoint.com)
+     * @param name Name of the container type to search for
+     * @returns ID of the container type
+     */
+    async getContainerTypeIdByName(spoAdminUrl, name) {
+        const allContainerTypes = await this.getAllContainerTypes(spoAdminUrl);
+        const containerTypes = allContainerTypes.filter(ct => ct.DisplayName.toLowerCase() === name.toLowerCase());
+        if (containerTypes.length === 0) {
+            throw new Error(`The specified container type '${name}' does not exist.`);
+        }
+        if (containerTypes.length > 1) {
+            const containerTypeKeyValuePair = formatting.convertArrayToHashTable('ContainerTypeId', containerTypes);
+            const containerType = await cli.handleMultipleResultsFound(`Multiple container types with name '${name}' found.`, containerTypeKeyValuePair);
+            return containerType.ContainerTypeId;
+        }
+        return containerTypes[0].ContainerTypeId;
+    },
+    /**
+     * Get the ID of a container by its name.
+     * @param containerTypeId ID of the container type.
+     * @param name Name of the container to search for.
+     * @returns ID of the container.
+     */
+    async getContainerIdByName(containerTypeId, name) {
+        const containers = await odata.getAllItems(`${graphResource}/v1.0/storage/fileStorage/containers?$filter=containerTypeId eq ${containerTypeId}&$select=id,displayName`);
+        const matchingContainers = containers.filter(c => c.displayName.toLowerCase() === name.toLowerCase());
+        if (matchingContainers.length === 0) {
+            throw new Error(`The specified container '${name}' does not exist.`);
+        }
+        if (matchingContainers.length > 1) {
+            const containerKeyValuePair = formatting.convertArrayToHashTable('id', matchingContainers);
+            const container = await cli.handleMultipleResultsFound(`Multiple containers with name '${name}' found.`, containerKeyValuePair);
+            return container.id;
+        }
+        return matchingContainers[0].id;
+    }
+};
+//# sourceMappingURL=spe.js.map

package/dist/utils/spo.js

@@ -53,24 +53,6 @@ export const spo = {
         };
         return context;
     },
-    async getAllContainerTypes(spoAdminUrl, logger, verbose) {
-        const formDigestInfo = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, verbose);
-        const requestOptions = {
-            url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-            headers: {
-                'X-RequestDigest': formDigestInfo.FormDigestValue
-            },
-            data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="46" ObjectPathId="45" /><Method Name="GetSPOContainerTypes" Id="47" ObjectPathId="45"><Parameters><Parameter Type="Enum">1</Parameter></Parameters></Method></Actions><ObjectPaths><Constructor Id="45" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
-        };
-        const res = await request.post(requestOptions);
-        const json = JSON.parse(res);
-        const response = json[0];
-        if (response.ErrorInfo) {
-            throw new Error(response.ErrorInfo.ErrorMessage);
-        }
-        const containerTypes = json[json.length - 1];
-        return containerTypes;
-    },
     async waitUntilFinished({ operationId, siteUrl, logger, currentContext, debug, verbose }) {
         const resFormDigest = await spo.ensureFormDigest(siteUrl, logger, currentContext, debug);
         currentContext = resFormDigest;

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/cli/app/app-reconsent.mdx

@@ -0,0 +1,63 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# cli app reconsent
+
+Reconsent all permission scopes used in CLI for Microsoft 365
+
+## Usage
+
+```sh
+m365 cli app reconsent [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+This command will add all missing scopes used in CLI for Microsoft 365 to your current app registration. It will only add missing scopes and won't remove any scopes that are already present in the app registration.
+
+## Examples
+
+Consent all permission scopes used in CLI for Microsoft 365 to the current app registration
+
+```sh
+m365 cli app reconsent
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  "To consent to the new scopes for your Microsoft Entra application registration, please navigate to the following URL: https://login.microsoftonline.com/f72203fd-b0a0-472d-85eb-079a117a80de/adminconsent?client_id=62b981af-59d3-4d25-8baf-6cc067a03102"
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  To consent to the new scopes for your Microsoft Entra application registration, please navigate to the following URL: https://login.microsoftonline.com/f72203fd-b0a0-472d-85eb-079a117a80de/adminconsent?client_id=62b981af-59d3-4d25-8baf-6cc067a03102
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  To consent to the new scopes for your Microsoft Entra application registration, please navigate to the following URL: https://login.microsoftonline.com/f72203fd-b0a0-472d-85eb-079a117a80de/adminconsent?client_id=62b981af-59d3-4d25-8baf-6cc067a03102
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  To consent to the new scopes for your Microsoft Entra application registration, please navigate to the following URL: https://login.microsoftonline.com/f72203fd-b0a0-472d-85eb-079a117a80de/adminconsent?client_id=62b981af-59d3-4d25-8baf-6cc067a03102
+  ```
+
+  </TabItem>
+</Tabs>
+

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-activate.mdx

@@ -1,6 +1,4 @@
 import Global from '/docs/cmd/_global.mdx';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
 # spe container activate