@pnp/cli-microsoft365 10.0.0-beta.e925c1c → 10.0.0

package/dist/utils/urlUtil.js

@@ -198,6 +198,14 @@ export const urlUtil = {
             return rootUrl.origin;
         }
     },
+    /**
+     * Removes leading slashes from the URL.
+     * @param url The URL to process.
+     * @returns The URL without leading slashes.
+     */
+    removeLeadingSlashes(url) {
+        return url.replace(/^\/+/, '');
+    },
     /**
      * Removes trailing slashes from the URL.
      * @param url The URL to process.

package/dist/utils/vivaEngage.js

@@ -0,0 +1,61 @@
+import { cli } from '../cli/cli.js';
+import request from '../request.js';
+import { formatting } from './formatting.js';
+import { odata } from './odata.js';
+export const vivaEngage = {
+    /**
+     * Get Viva Engage group ID by community ID.
+     * @param communityId The ID of the Viva Engage community.
+     * @returns The ID of the Viva Engage group.
+     * @returns The Viva Engage community.
+     */
+    async getCommunityById(communityId, selectProperties) {
+        const requestOptions = {
+            url: `https://graph.microsoft.com/v1.0/employeeExperience/communities/${communityId}?$select=${selectProperties.join(',')}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        const community = await request.get(requestOptions);
+        if (!community) {
+            throw `The specified Viva Engage community with ID '${communityId}' does not exist.`;
+        }
+        return community;
+    },
+    /**
+     * Get Viva Engage community by display name.
+     * @param displayName Community display name.
+     * @param selectProperties Properties to select.
+     * @returns The Viva Engage community.
+     */
+    async getCommunityByDisplayName(displayName, selectProperties) {
+        const communities = await odata.getAllItems(`https://graph.microsoft.com/v1.0/employeeExperience/communities?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'&$select=${selectProperties.join(',')}`);
+        if (communities.length === 0) {
+            throw `The specified Viva Engage community '${displayName}' does not exist.`;
+        }
+        if (communities.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', communities);
+            const selectedCommunity = await cli.handleMultipleResultsFound(`Multiple Viva Engage communities with name '${displayName}' found.`, resultAsKeyValuePair);
+            return selectedCommunity;
+        }
+        return communities[0];
+    },
+    /**
+     * Get Viva Engage community by Microsoft Entra group ID.
+     * Note: The Graph API doesn't support filtering by groupId, so we need to retrieve all communities and filter them in memory.
+     * @param entraGroupId The ID of the Microsoft Entra group.
+     * @param selectProperties Properties to select.
+     * @returns The Viva Engage community.
+     */
+    async getCommunityByEntraGroupId(entraGroupId, selectProperties) {
+        const properties = selectProperties.includes('groupId') ? selectProperties : [...selectProperties, 'groupId'];
+        const communities = await odata.getAllItems(`https://graph.microsoft.com/v1.0/employeeExperience/communities?$select=${properties.join(',')}`);
+        const filteredCommunity = communities.find(c => c.groupId === entraGroupId);
+        if (!filteredCommunity) {
+            throw `The Microsoft Entra group with id '${entraGroupId}' is not associated with any Viva Engage community.`;
+        }
+        return filteredCommunity;
+    }
+};
+//# sourceMappingURL=vivaEngage.js.map

package/dist/utils/zod.js

@@ -60,14 +60,14 @@ function parseDefault(def, _options, currentOption) {
 function parseEnum(def, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'string';
-        currentOption.autocomplete = def.values;
+        currentOption.autocomplete = [...def.values];
     }
     return;
 }
 function parseNativeEnum(def, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'string';
-        currentOption.autocomplete = Object.getOwnPropertyNames(def.values);
+        currentOption.autocomplete = Object.values(def.values).map(v => String(v));
     }
     return;
 }
@@ -119,6 +119,15 @@ export const zod = {
         const options = [];
         parseDef(schema._def, options);
         return options;
-    }
+    },
+    coercedEnum: (e) => z.preprocess(val => {
+        const target = String(val)?.toLowerCase();
+        for (const k of Object.values(e)) {
+            if (String(k)?.toLowerCase() === target) {
+                return k;
+            }
+        }
+        return null;
+    }, z.nativeEnum(e))
 };
 //# sourceMappingURL=zod.js.map

package/docs/docs/_clisettings.mdx

@@ -22,5 +22,4 @@ Setting name|Definition|Default value
 `prompt`|Prompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.|`true`
 `promptListPageSize`|By default, lists of choices longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once.|7
 `showHelpOnFailure`|Automatically display help when executing a command failed|`true`
-`showSpinner`|Display spinner when executing commands|`true`
 `tenantId`|ID of the default tenant to use when authenticating with|``

package/docs/docs/cmd/cli/cli-doctor.mdx

@@ -22,7 +22,7 @@ This command gets all the necessary diagnostic information needed to triage and
 
 ## Examples
 
-Retrieve diagnostic information
+Retrieve diagnostic information.
 
 ```sh
 m365 cli doctor
@@ -42,18 +42,20 @@ m365 cli doctor
     },
     "cliVersion": "6.1.0",
     "nodeVersion": "v16.13.0",
-    "cliAadAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
-    "cliAadAppTenant": "common",
-    "authMode": "DeviceCode",
+    "cliEntraAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+    "cliEntraAppTenant": "common",
+    "authMode": "deviceCode",
     "cliEnvironment": "",
     "cliConfig": {
       "output": "json",
       "showHelpOnFailure": false
     },
     "roles": [],
-    "scopes": [
-      "AllSites.FullControl"
-    ]
+    "scopes": {
+      "https://graph.microsoft.com": [
+        "AllSites.FullControl"
+      ]
+    }
   }
   ```
 
@@ -61,24 +63,24 @@ m365 cli doctor
   <TabItem value="Text">
 
   ```text
-  authMode       : DeviceCode
-  cliAadAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
-  cliAadAppTenant: common
-  cliConfig      : {"output":"json","showHelpOnFailure":false}
-  cliEnvironment :
-  cliVersion     : 6.1.0
-  nodeVersion    : v16.13.0
-  os             : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
-  roles          : []
-  scopes         : ["AllSites.FullControl"]
+  authMode         : deviceCode
+  cliConfig        : {"output":"json","showHelpOnFailure":false}
+  cliEntraAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
+  cliEntraAppTenant: common
+  cliEnvironment   :
+  cliVersion       : 6.1.0
+  nodeVersion      : v16.13.0
+  os               : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
+  roles            : []
+  scopes           : {"https://graph.microsoft.com":["AllSites.FullControl"]}
   ```
 
   </TabItem>
   <TabItem value="CSV">
 
   ```csv
-  os,cliVersion,nodeVersion,cliAadAppId,cliAadAppTenant,authMode,cliEnvironment,cliConfig,roles,scopes
-  "{""platform"":""win32"",""version"":""Windows 10 Pro"",""release"":""10.0.19045""}",6.1.0,v16.13.0,31359c7f-bd7e-475c-86db-fdb8c937548e,common,DeviceCode,,"{""output"":""json"",""showHelpOnFailure"":false}",[],"[""AllSites.FullControl""]"
+  os,cliVersion,nodeVersion,cliEntraAppId,cliEntraAppTenant,authMode,cliEnvironment,cliConfig,roles,scopes
+  "{""platform"":""win32"",""version"":""Windows 10 Pro"",""release"":""10.0.19045""}",6.1.0,v16.13.0,31359c7f-bd7e-475c-86db-fdb8c937548e,common,deviceCode,,"{""output"":""json"",""showHelpOnFailure"":false}",[],"{""https://graph.microsoft.com"":[""AllSites.FullControl""]}"
   ```
 
   </TabItem>
@@ -93,12 +95,11 @@ m365 cli doctor
   ---------|-------
   cliVersion | 6.1.0
   nodeVersion | v16.13.0
-  cliAadAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
-  cliAadAppTenant | common
-  authMode | DeviceCode
+  cliEntraAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
+  cliEntraAppTenant | common
+  authMode | deviceCode
   cliEnvironment |
   ```
 
   </TabItem>
 </Tabs>
-

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-add.mdx

@@ -12,12 +12,6 @@ Creates a new administrative unit
 m365 entra administrativeunit add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit add [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx

@@ -12,12 +12,6 @@ Gets information about a specific administrative unit
 m365 entra administrativeunit get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit get [options]
-```
-
 ## Options
 
 ```md definition-list

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

@@ -12,12 +12,6 @@ Retrieves a list of administrative units
 m365 entra administrativeunit list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit list [options]
-```
-
 ## Options
 
 <Global />

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

@@ -10,12 +10,6 @@ Add a member (user, group, or device) to an administrative unit
 m365 entra administrativeunit member add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member add [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-get.mdx

@@ -12,12 +12,6 @@ Retrieves info about a specific member of an administrative unit
 m365 entra administrativeunit member get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member get [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-list.mdx

@@ -12,12 +12,6 @@ Retrieves members (users, groups, or devices) of an administrative unit
 m365 entra administrativeunit member list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member list [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-remove.mdx

@@ -10,12 +10,6 @@ Removes an administrative unit
 m365 entra administrativeunit remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit remove [options]
-```
-
 ## options
 
 ```md definition-list

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

@@ -15,7 +15,6 @@ m365 entra app add [options]
 ## Alias
 
 ```sh
-m365 aad app add [options]
 m365 entra appregistration add [options]
 ```
 

package/docs/docs/cmd/entra/app/app-get.mdx

@@ -15,7 +15,6 @@ m365 entra app get [options]
 ## Alias
 
 ```sh
-m365 aad app get [options]
 m365 entra appregistration get [options]
 ```
 

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

@@ -15,7 +15,6 @@ m365 entra app list [options]
 ## Alias
 
 ```sh
-m365 aad app list [options]
 m365 entra appregistration list [options]
 ```
 

package/docs/docs/cmd/entra/app/app-permission-add.mdx

@@ -15,7 +15,6 @@ m365 entra app permission add [options]
 ## Alias
 
 ```sh
-m365 aad app permission add [options]
 m365 entra appregistration permission add [options]
 ```
 

package/docs/docs/cmd/entra/app/app-permission-list.mdx

@@ -12,12 +12,6 @@ Lists the application and delegated permissions for a specified Entra Applicatio
 m365 entra app permission list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad app permission list [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/app/app-remove.mdx

@@ -13,7 +13,6 @@ m365 entra app remove [options]
 ## Alias
 
 ```sh
-m365 aad app remove [options]
 m365 entra appregistration remove [options]
 ```
 

package/docs/docs/cmd/entra/app/app-role-add.mdx

@@ -13,7 +13,6 @@ m365 entra app role add [options]
 ## Alias
 
 ```sh
-m365 aad app role add [options]
 m365 entra appregistration role add [options]
 ```
 

package/docs/docs/cmd/entra/app/app-role-list.mdx

@@ -15,7 +15,6 @@ m365 entra app role list [options]
 ## Alias
 
 ```sh
-m365 aad app role list [options]
 m365 entra appregistration role list [options]
 ```
 

package/docs/docs/cmd/entra/app/app-role-remove.mdx

@@ -13,7 +13,6 @@ m365 entra app role remove [options]
 ## Alias
 
 ```sh
-m365 aad app role remove [options]
 m365 entra appregistration role remove [options]
 ```
 

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

@@ -13,7 +13,6 @@ m365 entra app set [options]
 ## Alias
 
 ```sh
-m365 aad app set [options]
 m365 entra appregistration set [options]
 ```
 

package/docs/docs/cmd/entra/approleassignment/approleassignment-add.mdx

@@ -12,12 +12,6 @@ Adds service principal permissions also known as scopes and app role assignments
 m365 entra approleassignment add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad approleassignment add [options]
-```
-
 ## Options
 
 ```md definition-list

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

@@ -12,12 +12,6 @@ Lists app role assignments for the specified application registration
 m365 entra approleassignment list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad approleassignment list [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/approleassignment/approleassignment-remove.mdx

@@ -10,12 +10,6 @@ Deletes an app role assignment for the specified Entra application registration
 m365 entra approleassignment remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad approleassignment remove [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx

@@ -15,7 +15,6 @@ m365 entra enterpriseapp add [options]
 ## Alias
 
 ```sh
-m365 aad sp add [options]
 m365 entra sp add [options]
 ```
 

package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx

@@ -15,7 +15,6 @@ m365 entra enterpriseapp get [options]
 ## Alias
 
 ```sh
-m365 aad sp get [options]
 m365 entra sp get [options]
 ```
 

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

@@ -15,7 +15,6 @@ m365 entra enterpriseapp list [options]
 ## Alias
 
 ```sh
-m365 aad sp list [options]
 m365 entra sp list [options]
 ```
 

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

@@ -12,12 +12,6 @@ Creates a Microsoft Entra group
 m365 entra group add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad group add [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/group/group-get.mdx

@@ -12,12 +12,6 @@ Gets information about the specified Entra group
 m365 entra group get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad group get [options]
-```
-
 ## Options
 
 ```md definition-list

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

@@ -12,12 +12,6 @@ Lists Entra groups
 m365 entra group list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad group list [options]
-```
-
 ## Options
 
 ```md definition-list

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

@@ -0,0 +1,62 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra group member add
+
+Adds a member to a Microsoft Entra ID group
+
+## Usage
+
+```sh
+m365 entra group member add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The ID of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.
+
+`-n, --groupDisplayName [groupDisplayName]`
+: The display name of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.
+
+`--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.
+
+`--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.
+
+`-r, --role <role>`
+: The role to be assigned to the new users. Valid values: `Owner`, `Member`.
+```
+
+<Global />
+
+## Examples
+
+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
+```
+
+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
+```
+
+Add a single member specified by UPN as an owner to a group specified by display name.
+
+```sh
+m365 entra group member add --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
+```
+
+Adds multiple members specified by UPN as owners to a group specified by ID.
+
+```sh
+m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "john.doe@contoso.com,adele.vance@contoso.com" --role Owner
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/entra/group/{group-user-list.mdx → group-member-list.mdx}

@@ -2,20 +2,14 @@ import Global from '/docs/cmd/_global.mdx';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# entra group user list
+# entra group member list
 
-Lists users of a specific Entra group
+Lists members of a specific Entra group
 
 ## Usage
 
 ```sh
-m365 entra group user list [options]
-```
-
-## Alias
-
-```sh
-m365 aad group user list [options]
+m365 entra group member list [options]
 ```
 
 ## Options
@@ -28,13 +22,13 @@ m365 aad group user list [options]
 : The display name of the Entra group. Specify `groupId` or `groupName` but not both.
 
 `-r, --role [role]`
-: Filter the results to only users with the given role: `Owner`, `Member`.
+: Filter the results to only members with the given role: `Owner`, `Member`.
 
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve.
 
 `-f, --filter [filter]`
-: OData filter to use to query the list of users with.
+: OData filter to use to query the list of members with.
 ```
 
 <Global />
@@ -45,34 +39,34 @@ When the `properties` option includes values with a `/`, for example: `manager/d
 
 ## Examples
 
-List all group users from a group specified by ID.
+List all group members from a group specified by ID.
 
 ```sh
-m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
+m365 entra group member list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
 ```
 
 List all owners from a group specified by display name.
 
 ```sh
-m365 entra group user list --groupName Developers --role Owner
+m365 entra group member list --groupName Developers --role Owner
 ```
 
-List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
+List all group members from a group specified by name. For each one return the display name, e-mail address, and manager display name.
 
 ```sh
-m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
+m365 entra group member list --groupName Developers --properties "displayName,mail,manager/displayName"
 ```
 
-List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
+List all group members from a group specified by name. For each one return the display name, e-mail address, and manager information.
 
 ```sh
-m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
+m365 entra group member list --groupName Developers --properties "displayName,mail,manager/*"
 ```
 
-List all group members that are guest users.
+List all group members that are guest members.
 
 ```sh
-m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
+m365 entra group member list --groupName Developers --filter "userType eq 'Guest'"
 ```
 
 ## Response