@pnp/cli-microsoft365 10.11.0-beta.c2217b6 → 11.0.0-beta.1f852eb

package/dist/utils/entraGroup.js

@@ -142,6 +142,49 @@ export const entraGroup = {
         };
         const group = await request.get(requestOptions);
         return group.groupTypes.some(type => type === 'Unified');
+    },
+    /**
+     * Retrieve the IDs of groups by their display names. There is no guarantee that the order of the returned IDs will match the order of the specified names.
+     * @param names Array of group names.
+     * @returns Array of group IDs.
+     */
+    async getGroupIdsByDisplayNames(names) {
+        const groupIds = [];
+        for (let i = 0; i < names.length; i += 20) {
+            const namesChunk = names.slice(i, i + 20);
+            const requestOptions = {
+                url: `${graphResource}/v1.0/$batch`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json',
+                data: {
+                    requests: namesChunk.map((name, index) => ({
+                        id: index + 1,
+                        method: 'GET',
+                        url: `/groups?$filter=displayName eq '${formatting.encodeQueryParameter(name)}'&$select=id`,
+                        headers: {
+                            accept: 'application/json;odata.metadata=none'
+                        }
+                    }))
+                }
+            };
+            const res = await request.post(requestOptions);
+            for (const response of res.responses) {
+                if (response.body.value.length === 1) {
+                    groupIds.push(response.body.value[0].id);
+                }
+                else if (response.body.value.length > 1) {
+                    const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', response.body.value);
+                    const result = await cli.handleMultipleResultsFound(`Multiple groups with the name '${namesChunk[response.id - 1]}' found.`, resultAsKeyValuePair);
+                    groupIds.push(result.id);
+                }
+                else {
+                    throw Error(`The specified group with name '${namesChunk[response.id - 1]}' does not exist.`);
+                }
+            }
+        }
+        return groupIds;
     }
 };
 //# sourceMappingURL=entraGroup.js.map

package/dist/utils/vivaEngage.js

@@ -56,6 +56,25 @@ export const vivaEngage = {
             throw `The Microsoft Entra group with id '${entraGroupId}' is not associated with any Viva Engage community.`;
         }
         return filteredCommunity;
+    },
+    /**
+     * Get the ID of a Viva Engage role by its display name.
+     * @param roleName The display name of the role.
+     * @returns The ID of the role.
+     */
+    async getRoleIdByName(roleName) {
+        // This endpoint doesn't support filtering by displayName
+        const response = await odata.getAllItems('https://graph.microsoft.com/beta/employeeExperience/roles');
+        const roles = response.filter(role => role.displayName.toLowerCase() === roleName.toLowerCase());
+        if (roles.length === 0) {
+            throw new Error(`The specified Viva Engage role '${roleName}' does not exist.`);
+        }
+        if (roles.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', roles);
+            const selectedRole = await cli.handleMultipleResultsFound(`Multiple Viva Engage roles with name '${roleName}' found.`, resultAsKeyValuePair);
+            return selectedRole.id;
+        }
+        return roles[0].id;
     }
 };
 //# sourceMappingURL=vivaEngage.js.map

package/docs/docs/cmd/cli/app/app-add.mdx

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# cli app add
+
+Create a new app registration to use for the CLI for Microsoft 365
+
+## Usage
+
+```sh
+m365 cli app add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name [name]`
+: Name of the app registration. Defaults to CLI for M365
+
+`-s, --scopes [scopes]`
+: Which scopes should be added? Valid values are: `minimal`, `all`, or a list of scopes. Defaults to `minimal`.
+
+`--saveToConfig`
+: Save the app registration info to the CLI config. This way the new app registration will be used as the default app registration to sign in.
+```
+
+<Global />
+
+## Examples
+
+Create a new app registration to use for CLI for Microsoft 365
+
+```sh
+m365 cli app add
+```
+
+Create a new app registration with all permission scopes and a custom name
+
+```sh
+m365 cli app add --name "Contoso CLI app" --scopes all
+```
+
+Create a new app registration with self-defined scopes
+
+```sh
+m365 cli app add --scopes "https://graph.microsoft.com/User.Read,https://graph.microsoft.com/Group.Read.All"
+```
+
+## Response
+
+The command won't return a response on success

package/docs/docs/cmd/entra/group/group-member-add.mdx

@@ -23,10 +23,19 @@ m365 entra group member add [options]
 : The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
 
 `--ids [ids]`
-: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.
+: (deprecated. Use option `userIds` instead) Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids`, `userIds`,`userNames`, `subgroupIds`, or `subgroupNames` but not multiple.
+
+`--userIds [userIds]`
+: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids`, `userIds`,`userNames`, `subgroupIds`, or `subgroupNames` but not multiple.
 
 `--userNames [userNames]`
-: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
+: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids`, `userIds`,`userNames`, `subgroupIds`, or `subgroupNames` but not multiple.
+
+`--subgroupIds [subgroupIds]`
+: Comma-separated list of Microsoft Entra group IDs to add. Specify either `ids`, `userIds`,`userNames`, `subgroupIds`, or `subgroupNames` but not multiple.
+
+`--subgroupNames [subgroupNames]`
+: Comma-separated list of Microsoft Entra group titles to add. Specify either `ids`, `userIds`,`userNames`, `subgroupIds`, or `subgroupNames` but not multiple.
 
 `-r, --role <role>`
 : The role to be assigned to the new users. Valid values: `Owner`, `Member`.
@@ -39,19 +48,19 @@ m365 entra group member add [options]
 Add a single member specified by ID as a member to a group specified by display name.
 
 ```sh
-m365 entra group member add --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+m365 entra group member add --groupDisplayName Developers --userIds 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
 ```
 
 Add a single member specified by ID as a member to a group specified by group name.
 
 ```sh
-m365 entra group member add --groupName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+m365 entra group member add --groupName Developers --userIds 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
 ```
 
 Add multiple members specified by ID as members to a group specified by ID.
 
 ```sh
-m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
+m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userIds "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
 ```
 
 Add a single member specified by UPN as an owner to a group specified by display name.
@@ -72,6 +81,18 @@ Adds multiple members specified by UPN as owners to a group specified by ID.
 m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "john.doe@contoso.com,adele.vance@contoso.com" --role Owner
 ```
 
+Add multiple members (subgroups) specified by ID as members to a group specified by ID.
+
+```sh
+m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --subgroupIds "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
+```
+
+Adds multiple members (subgroups) specified by name as members to a group specified by ID.
+
+```sh
+m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --subgroupNames "Developers,Human Resources" --role Member
+```
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/entra/group/group-member-set.mdx

@@ -23,7 +23,10 @@ m365 entra group member set [options]
 : The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
 
 `--ids [ids]`
-: Comma-separated list of user IDs. Specify either `ids` or `userNames` but not both.
+: (deprecated. Use option `userIds` instead) Comma-separated list of user IDs. Specify either `ids`, `userIds` or `userNames` but not multiple.
+
+`--userIds [userIds]`
+: Comma-separated list of user IDs. Specify either `ids`, `userIds` or `userNames` but not multiple.
 
 `--userNames [userNames]`
 : The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
@@ -39,19 +42,19 @@ m365 entra group member set [options]
 Update a single member specified by ID to a member of a group specified by display name
 
 ```sh
-m365 entra group member set --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+m365 entra group member set --groupDisplayName Developers --userIds 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
 ```
 
 Update a single member specified by ID to a member of a group specified by group name
 
 ```sh
-m365 entra group member set --groupName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+m365 entra group member set --groupName Developers --userIds 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
 ```
 
 Update multiple members specified by ID to members of a group specified by ID
 
 ```sh
-m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
+m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userIds "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
 ```
 
 Update a single member specified by UPN to an owner of a group specified by display name

package/docs/docs/cmd/spe/container/container-recyclebinitem-restore.mdx

@@ -0,0 +1,53 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spe container recyclebinitem restore
+
+Restores a deleted container
+
+## Usage
+
+```sh
+m365 spe container recyclebinitem restore [options]
+```
+
+## Options
+
+```md definition-list
+`--id [id]`
+: The container id. Specify either `id` or `name` but not both.
+
+`--name [name]`
+: The display name of the Container. Specify either `id` or `name` but not both.
+
+`--containerTypeId [containerTypeId]`
+: The container type ID of the container instance. Use either `containerTypeId` or `containerTypeName` but not both.
+
+`--containerTypeName [containerTypeName]`
+: The container type name of the container instance. Use either `containerTypeId` or `containerTypeName` but not both.
+```
+
+<Global />
+
+## Examples
+
+Restore a deleted container by ID.
+
+```sh
+m365 spe container recyclebinitem restore --id "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z"
+```
+
+Restore a deleted container by using its name and container type ID.
+
+```sh
+m365 spe container recyclebinitem restore --containerTypeId "91710488-5756-407f-9046-fbe5f0b4de73" --name "Invoices"
+```
+
+Restore a deleted container by using its name and container type name.
+
+```sh
+m365 spe container recyclebinitem restore --containerTypeName "My container type name" --name "Invoices"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-version-get.mdx

@@ -53,6 +53,7 @@ m365 spo file version get --webUrl https://contoso.sharepoint.com --label "1.0"
   {
     "CheckInComment": "",
     "Created": "2022-10-30T12:03:06Z",
+    "ExpirationDate": "2026-01-31T08:23:43.0000000Z",
     "ID": 512,
     "IsCurrentVersion": false,
     "Length": "18898",
@@ -68,6 +69,7 @@ m365 spo file version get --webUrl https://contoso.sharepoint.com --label "1.0"
   ```text
   CheckInComment  :
   Created         : 2022-10-30T12:03:06Z
+  ExpirationDate  : 2026-01-31T08:23:43.0000000Z
   ID              : 512
   IsCurrentVersion: false
   Length          : 18898
@@ -80,8 +82,8 @@ m365 spo file version get --webUrl https://contoso.sharepoint.com --label "1.0"
   <TabItem value="CSV">
 
   ```csv
-  CheckInComment,Created,ID,IsCurrentVersion,Length,Size,Url,VersionLabel
-  ,2022-10-30T12:03:06Z,512,,18898,18898,_vti_history/512/Shared Documents/Document.docx,1.0
+  CheckInComment,Created,ExpirationDate,ID,IsCurrentVersion,Length,Size,Url,VersionLabel
+  ,2022-10-30T12:03:06Z,2026-01-31T08:23:43.0000000Z,512,0,18898,18898,_vti_history/512/Shared Documents/Document.docx,1.0
   ```
 
   </TabItem>
@@ -98,6 +100,7 @@ m365 spo file version get --webUrl https://contoso.sharepoint.com --label "1.0"
   ---------|-------
   CheckInComment |
   Created | 2022-10-30T12:03:06Z
+  ExpirationDate | 2026-01-31T08:23:43.0000000Z
   ID | 512
   IsCurrentVersion | false
   Length | 18898

package/docs/docs/cmd/spo/file/file-version-list.mdx

@@ -57,6 +57,7 @@ m365 spo file version list --webUrl https://contoso.sharepoint.com/sites/project
     {
       "CheckInComment": "",
       "Created": "2022-10-30T12:03:06Z",
+      "ExpirationDate": "2026-01-31T08:23:43.0000000Z",
       "ID": 512,
       "IsCurrentVersion": false,
       "Length": "18898",
@@ -71,17 +72,17 @@ m365 spo file version list --webUrl https://contoso.sharepoint.com/sites/project
   <TabItem value="Text">
 
   ```text
-  Created               ID    IsCurrentVersion  VersionLabel
-  --------------------  ----  ----------------  ------------
-  2022-10-30T12:03:06Z  512   false             1.0
+  Created               ID    IsCurrentVersion  VersionLabel  ExpirationDate
+  --------------------  ----  ----------------  ------------  ----------------------------
+  2022-10-30T12:03:06Z  512   false             1.0           2026-01-31T08:23:43.0000000Z
   ```
 
   </TabItem>
   <TabItem value="CSV">
 
   ```csv
-  Created,ID,IsCurrentVersion,VersionLabel
-  2022-10-30T12:03:06Z,512,false,1.0
+  CheckInComment,Created,ExpirationDate,ID,IsCurrentVersion,Length,Size,Url,VersionLabel
+  ,2022-10-30T12:03:06Z,2026-01-31T08:23:43.0000000Z,512,0,18898,18898,_vti_history/512/Shared Documents/Document.docx,1.0
   ```
 
   </TabItem>
@@ -98,6 +99,7 @@ m365 spo file version list --webUrl https://contoso.sharepoint.com/sites/project
   ---------|-------
   CheckInComment |
   Created | 2022-10-30T12:03:06Z
+  ExpirationDate | 2026-01-31T08:23:43.0000000Z
   ID | 512
   IsCurrentVersion | false
   Length | 18898

package/docs/docs/cmd/spo/site/site-appcatalog-list.mdx

@@ -14,6 +14,11 @@ m365 spo site appcatalog list [options]
 
 ## Options
 
+```md definition-list
+`--excludeDeletedSites [excludeDeletedSites]`
+: Exclude site collections that are no longer active
+```
+
 <Global />
 
 ## Remarks
@@ -32,6 +37,12 @@ List all site collection app catalogs within the tenant
 m365 spo site appcatalog list
 ```
 
+List all site collection app catalogs within the tenant and exclude deleted sites.
+
+```sh
+m365 spo site appcatalog list --excludeDeletedSites
+```
+
 ## Response
 
 <Tabs>

package/docs/docs/cmd/spo/tenant/tenant-site-unarchive.mdx

@@ -34,7 +34,7 @@ To use this command, you must be a Global or SharePoint administrator.
 
 :::warning
 
-If a site remains archived for more than **seven days**, the reactivation fee will be calculated based on the entire storage capacity of the site.
+If a site has been archived for more than **seven days**, reactivating it triggers a 120-day cooldown period during which you can't archive the site again.
 
 :::
 

package/docs/docs/cmd/teams/callrecord/callrecord-list.mdx

@@ -0,0 +1,173 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# teams callrecord list
+
+Lists all Teams calls within the tenant
+
+## Usage
+
+```sh
+m365 teams callrecord list [options]
+```
+
+## Options
+
+```md definition-list
+`--userId [userId]`
+: Filters call records to only include those where the user participated. Use the Entra user ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: Filters call records to only include those where the user participated. Use the UPN of the user. Specify either `userId` or `userName` but not both.
+
+`--startDateTime [startDateTime]`
+: Only show calls that started after this time. Defaults to 30 days ago.
+
+`--endDateTime [endDateTime]`
+: Only show calls that started before this time (exclusive). Defaults to now.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+This command only supports application permissions. Use scope `CallRecords.Read.All`.
+
+:::
+
+:::note
+
+It is only possible to retrieve call records from the past 30 days.
+
+:::
+
+## Examples
+
+Get all call records from the past 30 days.
+
+```sh
+m365 teams callrecord list
+```
+
+Get all call records where a specific user participated in.
+
+```sh
+m365 teams callrecord list --userName "john.doe@contoso.com"
+```
+
+Get all call records that started within a specific timeframe.
+
+```sh
+m365 teams callrecord list --startDateTime "2025-05-1T00:00:00Z" --endDateTime "2025-05-14T00:00:00Z"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "145ae53b-7781-47c4-a5f7-b0e043012624",
+      "version": 1,
+      "type": "peerToPeer",
+      "modalities": [
+        "audio"
+      ],
+      "lastModifiedDateTime": "2025-05-29T17:41:33.5066667Z",
+      "startDateTime": "2025-05-29T17:27:20.428943Z",
+      "endDateTime": "2025-05-29T17:37:20.428943Z",
+      "joinWebUrl": "",
+      "organizer": {
+        "acsUser": null,
+        "spoolUser": null,
+        "phone": null,
+        "guest": null,
+        "encrypted": null,
+        "onPremises": null,
+        "acsApplicationInstance": null,
+        "spoolApplicationInstance": null,
+        "applicationInstance": null,
+        "application": null,
+        "device": null,
+        "user": {
+          "id": "b51efc8b-0adf-486c-ba54-b239ffa7c1f9",
+          "displayName": "John Doe",
+          "tenantId": "de5e90f2-9a07-4ed1-b903-f801afa7b1fd"
+        }
+      },
+      "participants": [],
+      "organizer_v2": {
+        "id": "b51efc8b-0adf-486c-ba54-b239ffa7c1f9",
+        "identity": {
+          "endpointType": null,
+          "acsUser": null,
+          "spoolUser": null,
+          "phone": null,
+          "guest": null,
+          "encrypted": null,
+          "onPremises": null,
+          "acsApplicationInstance": null,
+          "spoolApplicationInstance": null,
+          "applicationInstance": null,
+          "application": null,
+          "device": null,
+          "azureCommunicationServicesUser": null,
+          "assertedIdentity": null,
+          "user": {
+            "id": "b51efc8b-0adf-486c-ba54-b239ffa7c1f9",
+            "displayName": "John Doe",
+            "tenantId": "de5e90f2-9a07-4ed1-b903-f801afa7b1fd",
+            "userPrincipalName": "john.doe@contoso.com"
+          }
+        },
+        "administrativeUnitInfos": []
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    type        startDateTime                 endDateTime
+  ------------------------------------  ----------  ----------------------------  ----------------------------
+  145ae53b-7781-47c4-a5f7-b0e043012624  peerToPeer  2025-05-29T17:27:20.428943Z   2025-05-29T17:37:20.428943Z
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,version,type,lastModifiedDateTime,startDateTime,endDateTime,joinWebUrl
+  145ae53b-7781-47c4-a5f7-b0e043012624,1,peerToPeer,2025-05-29T17:41:33.5066667Z,2025-05-29T17:27:20.428943Z,2025-05-29T17:37:20.428943Z,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # teams callrecord list
+
+  Date: 03/06/2025
+
+  ## 145ae53b-7781-47c4-a5f7-b0e043012624
+
+  Property | Value
+  ---------|-------
+  id | 145ae53b-7781-47c4-a5f7-b0e043012624
+  version | 1
+  type | peerToPeer
+  lastModifiedDateTime | 2025-05-29T17:41:33.5066667Z
+  startDateTime | 2025-05-29T17:27:20.428943Z
+  endDateTime | 2025-05-29T17:37:20.428943Z
+  joinWebUrl |
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/viva/engage/engage-role-list.mdx

@@ -0,0 +1,102 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# viva engage role list
+
+Lists all Viva Engage roles
+
+## Usage
+
+```sh
+m365 viva engage role list [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::warning
+
+This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
+
+:::
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions             |
+  |-----------------|-------------------------|
+  | Microsoft Graph | EngagementRole.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions             |
+  |-----------------|-------------------------|
+  | Microsoft Graph | EngagementRole.Read.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+  
+List all Viva Engage roles
+
+```sh
+m365 viva engage role list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "ec759127-089f-4f91-8dfc-03a30b51cb38",
+      "displayName": "Network Admin"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    displayName
+  ------------------------------------  -------------
+  ec759127-089f-4f91-8dfc-03a30b51cb38  Network Admin
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName
+  ec759127-089f-4f91-8dfc-03a30b51cb38,Network Admin
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # viva engage role list
+
+  Date: 7/11/2025
+
+  ## Network Admin (ec759127-089f-4f91-8dfc-03a30b51cb38)
+
+  Property | Value
+  ---------|-------
+  id | ec759127-089f-4f91-8dfc-03a30b51cb38
+  displayName | Network Admin
+  ```
+
+  </TabItem>
+</Tabs>