@pnp/cli-microsoft365 10.2.0-beta.8c41470 → 10.2.0-beta.99aaf1e

package/dist/m365/entra/commands/roledefinition/roledefinition-get.js

@@ -0,0 +1,58 @@
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { zod } from '../../../../utils/zod.js';
+import { roleDefinition } from '../../../../utils/roleDefinition.js';
+import { validation } from '../../../../utils/validation.js';
+const options = globalOptionsZod
+    .extend({
+    id: zod.alias('i', z.string().optional()),
+    displayName: zod.alias('n', z.string().optional()),
+    properties: zod.alias('p', z.string().optional())
+})
+    .strict();
+class EntraRoleDefinitionGetCommand extends GraphCommand {
+    get name() {
+        return commands.ROLEDEFINITION_GET;
+    }
+    get description() {
+        return 'Gets a specific Microsoft Entra ID role definition';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !options.id !== !options.displayName, {
+            message: 'Specify either id or displayName, but not both'
+        })
+            .refine(options => options.id || options.displayName, {
+            message: 'Specify either id or displayName'
+        })
+            .refine(options => (!options.id && !options.displayName) || options.displayName || (options.id && validation.isValidGuid(options.id)), options => ({
+            message: `The '${options.id}' must be a valid GUID`,
+            path: ['id']
+        }));
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr('Getting Microsoft Entra ID role definition...');
+        }
+        try {
+            let result;
+            if (args.options.id) {
+                result = await roleDefinition.getRoleDefinitionById(args.options.id, args.options.properties);
+            }
+            else {
+                result = await roleDefinition.getRoleDefinitionByDisplayName(args.options.displayName, args.options.properties);
+            }
+            await logger.log(result);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new EntraRoleDefinitionGetCommand();
+//# sourceMappingURL=roledefinition-get.js.map

package/dist/m365/entra/commands/roledefinition/roledefinition-remove.js

@@ -0,0 +1,74 @@
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { zod } from '../../../../utils/zod.js';
+import { roleDefinition } from '../../../../utils/roleDefinition.js';
+import { validation } from '../../../../utils/validation.js';
+import request from '../../../../request.js';
+import { cli } from '../../../../cli/cli.js';
+const options = globalOptionsZod
+    .extend({
+    id: zod.alias('i', z.string().optional()),
+    displayName: zod.alias('n', z.string().optional()),
+    force: zod.alias('f', z.boolean().optional())
+})
+    .strict();
+class EntraRoleDefinitionRemoveCommand extends GraphCommand {
+    get name() {
+        return commands.ROLEDEFINITION_REMOVE;
+    }
+    get description() {
+        return 'Removes a specific Microsoft Entra ID role definition';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !options.id !== !options.displayName, {
+            message: 'Specify either id or displayName, but not both'
+        })
+            .refine(options => options.id || options.displayName, {
+            message: 'Specify either id or displayName'
+        })
+            .refine(options => (!options.id && !options.displayName) || options.displayName || (options.id && validation.isValidGuid(options.id)), options => ({
+            message: `The '${options.id}' must be a valid GUID`,
+            path: ['id']
+        }));
+    }
+    async commandAction(logger, args) {
+        const removeRoleDefinition = async () => {
+            try {
+                let roleDefinitionId = args.options.id;
+                if (args.options.displayName) {
+                    roleDefinitionId = (await roleDefinition.getRoleDefinitionByDisplayName(args.options.displayName, 'id')).id;
+                }
+                if (args.options.verbose) {
+                    await logger.logToStderr(`Removing role definition with ID ${roleDefinitionId}...`);
+                }
+                const requestOptions = {
+                    url: `${this.resource}/v1.0/roleManagement/directory/roleDefinitions/${roleDefinitionId}`,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    }
+                };
+                await request.delete(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        };
+        if (args.options.force) {
+            await removeRoleDefinition();
+        }
+        else {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove role definition '${args.options.id || args.options.displayName}'?` });
+            if (result) {
+                await removeRoleDefinition();
+            }
+        }
+    }
+}
+export default new EntraRoleDefinitionRemoveCommand();
+//# sourceMappingURL=roledefinition-remove.js.map

package/dist/m365/entra/commands.js

@@ -88,6 +88,8 @@ export default {
     PIM_ROLE_REQUEST_LIST: `${prefix} pim role request list`,
     POLICY_LIST: `${prefix} policy list`,
     ROLEDEFINITION_LIST: `${prefix} roledefinition list`,
+    ROLEDEFINITION_GET: `${prefix} roledefinition get`,
+    ROLEDEFINITION_REMOVE: `${prefix} roledefinition remove`,
     SITECLASSIFICATION_DISABLE: `${prefix} siteclassification disable`,
     SITECLASSIFICATION_ENABLE: `${prefix} siteclassification enable`,
     SITECLASSIFICATION_GET: `${prefix} siteclassification get`,

package/dist/m365/tenant/commands/people/people-pronouns-get.js

@@ -0,0 +1,32 @@
+import request from '../../../../request.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+class TenantPeoplePronounsGetCommand extends GraphCommand {
+    get name() {
+        return commands.PEOPLE_PRONOUNS_GET;
+    }
+    get description() {
+        return 'Retrieves information about pronouns settings for an organization';
+    }
+    async commandAction(logger) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr('Retrieving information about pronouns settings...');
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/admin/people/pronouns`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const pronouns = await request.get(requestOptions);
+            await logger.log(pronouns);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new TenantPeoplePronounsGetCommand();
+//# sourceMappingURL=people-pronouns-get.js.map

package/dist/m365/tenant/commands.js

@@ -7,6 +7,7 @@ export default {
     PEOPLE_PROFILECARDPROPERTY_LIST: `${prefix} people profilecardproperty list`,
     PEOPLE_PROFILECARDPROPERTY_REMOVE: `${prefix} people profilecardproperty remove`,
     PEOPLE_PROFILECARDPROPERTY_SET: `${prefix} people profilecardproperty set`,
+    PEOPLE_PRONOUNS_GET: `${prefix} people pronouns get`,
     REPORT_ACTIVEUSERCOUNTS: `${prefix} report activeusercounts`,
     REPORT_ACTIVEUSERDETAIL: `${prefix} report activeuserdetail`,
     REPORT_OFFICE365ACTIVATIONCOUNTS: `${prefix} report office365activationcounts`,

package/dist/utils/roleDefinition.js

@@ -1,15 +1,21 @@
 import { cli } from '../cli/cli.js';
 import { formatting } from './formatting.js';
 import { odata } from './odata.js';
+import request from '../request.js';
 export const roleDefinition = {
     /**
-     * Get a directory (Microsoft Entra) role
+     * Get an Entra ID (directory) role by its name
      * @param displayName Role definition display name.
+     * @param properties Comma-separated list of properties to include in the response.
      * @returns The role definition.
      * @throws Error when role definition was not found.
      */
-    async getRoleDefinitionByDisplayName(displayName) {
-        const roleDefinitions = await odata.getAllItems(`https://graph.microsoft.com/v1.0/roleManagement/directory/roleDefinitions?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'`);
+    async getRoleDefinitionByDisplayName(displayName, properties) {
+        let url = `https://graph.microsoft.com/v1.0/roleManagement/directory/roleDefinitions?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const roleDefinitions = await odata.getAllItems(url);
         if (roleDefinitions.length === 0) {
             throw `The specified role definition '${displayName}' does not exist.`;
         }
@@ -19,6 +25,27 @@ export const roleDefinition = {
             return selectedRoleDefinition;
         }
         return roleDefinitions[0];
+    },
+    /**
+     * Get an Entra ID (directory) role by its id
+     * @param id Role definition id.
+     * @param properties Comma-separated list of properties to include in the response.
+     * @returns The role definition.
+     * @throws Error when role definition was not found.
+     */
+    async getRoleDefinitionById(id, properties) {
+        let url = `https://graph.microsoft.com/v1.0/roleManagement/directory/roleDefinitions/${id}`;
+        if (properties) {
+            url += `?$select=${properties}`;
+        }
+        const requestOptions = {
+            url: url,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return await request.get(requestOptions);
     }
 };
 //# sourceMappingURL=roleDefinition.js.map

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

@@ -0,0 +1,150 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# entra roledefinition get
+
+Gets a specific Microsoft Entra ID role definition.
+
+## Usage
+
+```sh
+m365 entra roledefinition get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The id of the role definition. Specify either `id` or `displayName`, but not both.
+
+`-n, --displayName [displayName]`
+: The display name of the role definition. Specify either `id` or `displayName`, but not both.
+
+`-p, --properties [properties]`
+: Comma-separated list of properties to retrieve.
+```
+
+<Global />
+
+## Examples
+
+Get info about a role specified by the id
+
+```sh
+m365 entra roledefinition get --id 62e90394-69f5-4237-9190-012177145e10
+```
+
+Get limited info about a role specified by the display name
+
+```sh
+m365 entra roledefinition get --displayName 'Custom SharePoint Role' --properties 'description,isEnabled'
+```
+
+## Response
+
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "f28a1f50-f6e7-4571-818b-6a12f2af6b6c",
+    "description": "Can manage all aspects of the SharePoint service.",
+    "displayName": "SharePoint Administrator",
+    "isBuiltIn": true,
+    "isEnabled": true,
+    "resourceScopes": [
+      "/"
+    ],
+    "templateId": "f28a1f50-f6e7-4571-818b-6a12f2af6b6c",
+    "version": "1",
+    "rolePermissions": [
+      {
+        "allowedResourceActions": [
+          "microsoft.azure.serviceHealth/allEntities/allTasks",
+          "microsoft.azure.supportTickets/allEntities/allTasks",
+          "microsoft.backup/oneDriveForBusinessProtectionPolicies/allProperties/allTasks",
+          "microsoft.backup/oneDriveForBusinessRestoreSessions/allProperties/allTasks",
+          "microsoft.backup/restorePoints/sites/allProperties/allTasks",
+          "microsoft.backup/restorePoints/userDrives/allProperties/allTasks",
+          "microsoft.backup/sharePointProtectionPolicies/allProperties/allTasks",
+          "microsoft.backup/sharePointRestoreSessions/allProperties/allTasks",
+          "microsoft.backup/siteProtectionUnits/allProperties/allTasks",
+          "microsoft.backup/siteRestoreArtifacts/allProperties/allTasks",
+          "microsoft.backup/userDriveProtectionUnits/allProperties/allTasks",
+          "microsoft.backup/userDriveRestoreArtifacts/allProperties/allTasks",
+          "microsoft.directory/groups/hiddenMembers/read",
+          "microsoft.directory/groups.unified/basic/update",
+          "microsoft.directory/groups.unified/create",
+          "microsoft.directory/groups.unified/delete",
+          "microsoft.directory/groups.unified/members/update",
+          "microsoft.directory/groups.unified/owners/update",
+          "microsoft.directory/groups.unified/restore",
+          "microsoft.office365.migrations/allEntities/allProperties/allTasks",
+          "microsoft.office365.network/performance/allProperties/read",
+          "microsoft.office365.serviceHealth/allEntities/allTasks",
+          "microsoft.office365.sharePoint/allEntities/allTasks",
+          "microsoft.office365.supportTickets/allEntities/allTasks",
+          "microsoft.office365.usageReports/allEntities/allProperties/read",
+          "microsoft.office365.webPortal/allEntities/standard/read"
+        ],
+        "condition": null
+      }
+    ],
+    "inheritsPermissionsFrom": [
+      {
+        "id": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  description            : Can manage all aspects of the SharePoint service.
+  displayName            : SharePoint Administrator
+  id                     : f28a1f50-f6e7-4571-818b-6a12f2af6b6c
+  inheritsPermissionsFrom: [{"id":"88d8e3e3-8f55-4a1e-953a-9b9898b8876b"}]
+  isBuiltIn              : true
+  isEnabled              : true
+  resourceScopes         : ["/"]
+  rolePermissions        : [{"allowedResourceActions":["microsoft.azure.serviceHealth/allEntities/allTasks","microsoft.azure.supportTickets/allEntities/allTasks","microsoft.office365.webPortal/allEntities/standard/read"],"condition":null}]
+  templateId             : f28a1f50-f6e7-4571-818b-6a12f2af6b6c
+  version                : 1
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,description,displayName,isBuiltIn,isEnabled,templateId,version
+  f28a1f50-f6e7-4571-818b-6a12f2af6b6c,Can manage all aspects of the SharePoint service.,SharePoint Administrator,1,1,f28a1f50-f6e7-4571-818b-6a12f2af6b6c,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # entra roledefinition get --id "f28a1f50-f6e7-4571-818b-6a12f2af6b6c"
+
+  Date: 11/15/2024
+
+  ## SharePoint Administrator (f28a1f50-f6e7-4571-818b-6a12f2af6b6c)
+
+  Property | Value
+  ---------|-------
+  id | f28a1f50-f6e7-4571-818b-6a12f2af6b6c
+  description | Can manage all aspects of the SharePoint service.
+  displayName | SharePoint Administrator
+  isBuiltIn | true
+  isEnabled | true
+  templateId | f28a1f50-f6e7-4571-818b-6a12f2af6b6c
+  version | 1
+  ```
+
+  </TabItem>
+</Tabs>

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

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra roledefinition remove
+
+Removes a custom Microsoft Entra role definition
+
+## Usage
+
+```sh
+m365 entra roledefinition remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The id of the role definition. Specify either `id` or `displayName`, but not both.
+
+`-n, --displayName [displayName]`
+: The name of the role definition. Specify either `id` or `displayName`, but not both.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+When the role definition is removed, all the associated role assignments are deleted.
+
+:::
+
+## Examples
+
+Remove a role definition specified by id without prompting
+
+```sh
+m365 entra roledefinition remove --id 0bed8b86-5026-4a93-ac7d-56750cc099f1 --force
+```
+
+Remove a role definition specified by name and prompt for confirmation
+
+```sh
+m365 entra roledefinition remove --displayName 'Custom Role'
+```
+
+## Response
+
+The command won't return a response on success

package/docs/docs/cmd/tenant/people/people-pronouns-get.mdx

@@ -0,0 +1,69 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# tenant people pronouns get
+
+Retrieves information about pronouns settings for an organization
+
+## Usage
+
+```sh
+m365 tenant people pronouns get [options]
+```
+
+<Global />
+
+## Examples
+
+Retrieve information about pronouns settings
+
+```sh
+m365 tenant people pronouns get
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "isEnabledInOrganization": true
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  isEnabledInOrganization: true
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  isEnabledInOrganization
+  1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # tenant people pronouns get
+
+  Date: 12/5/2024
+
+  Property | Value
+  ---------|-------
+  isEnabledInOrganization | true
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- https://learn.microsoft.com/graph/api/peopleadminsettings-list-pronouns

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "10.2.0-beta.8c41470",
+  "version": "10.2.0-beta.99aaf1e",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",