-
Notifications
You must be signed in to change notification settings - Fork 328
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds command 'entra roledefinition list'. Closes #6464
- Loading branch information
1 parent
9449496
commit 10198fe
Showing
6 changed files
with
469 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
148 changes: 148 additions & 0 deletions
148
docs/docs/cmd/entra/roledefinition/roledefinition-list.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.