Skip to content

Commit

Permalink
Adds command 'entra roledefinition list'. Closes #6464
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinM85 authored and martinlingstuyl committed Dec 11, 2024
1 parent 9449496 commit 10198fe
Show file tree
Hide file tree
Showing 6 changed files with 469 additions and 0 deletions.
1 change: 1 addition & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const dictionary = [
'customizer',
'dataverse',
'default',
'definition',
'dev',
'details',
'eligibility',
Expand Down
148 changes: 148 additions & 0 deletions docs/docs/cmd/entra/roledefinition/roledefinition-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# entra roledefinition list

Lists all Microsoft Entra ID role definitions.

## Usage

```sh
m365 entra roledefinition list [options]
```

## Options

```md definition-list
`-p, --properties [properties]`
: Comma-separated list of properties to retrieve.

`-f, --filter [filter]`
: OData filter to apply when retrieving the role definitions.
```

<Global />

## Examples

Retrieve all Microsoft Entra ID role definitions

```sh
m365 entra roledefinition list
```

Retrieve only the names of the role definitions

```sh
m365 entra roledefinition list --properties 'displayName'
```

Retrieve only custom role definitions

```sh
m365 entra roledefinition list --filter 'isBuiltIn eq false'
```

## 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
id displayName isBuiltIn isEnabled
------------------------------------ --------------------------------------------- --------- ---------
f28a1f50-f6e7-4571-818b-6a12f2af6b6c SharePoint Administrator true true
```

</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 list

Date: 11/7/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>
9 changes: 9 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,15 @@ const sidebars: SidebarsConfig = {
}
]
},
{
roledefinition: [
{
type: 'doc',
label: 'roledefinition list',
id: 'cmd/entra/roledefinition/roledefinition-list'
}
]
},
{
siteclassification: [
{
Expand Down
1 change: 1 addition & 0 deletions src/m365/entra/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ export default {
PIM_ROLE_ASSIGNMENT_ELIGIBILITY_LIST: `${prefix} pim role assignment eligibility list`,
PIM_ROLE_REQUEST_LIST: `${prefix} pim role request list`,
POLICY_LIST: `${prefix} policy list`,
ROLEDEFINITION_LIST: `${prefix} roledefinition list`,
SITECLASSIFICATION_DISABLE: `${prefix} siteclassification disable`,
SITECLASSIFICATION_ENABLE: `${prefix} siteclassification enable`,
SITECLASSIFICATION_GET: `${prefix} siteclassification get`,
Expand Down
Loading

0 comments on commit 10198fe

Please sign in to comment.