Retrieve the properties of a directoryRole object.
You can use both the object ID and template ID of the directoryRole with this API.
The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center.
For details, see Role template IDs.
Retrieve the properties of a directoryRole object.
You can use both the object ID and template ID of the directoryRole with this API.
The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center.
For details, see Role template IDs.
Get-MgBetaDirectoryRole | Format-List
DeletedDateTime :
Description : Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.
DisplayName : Global Administrator
Id : a2d10e79-df32-47fc-86ef-64d199860810
Members :
RoleTemplateId : 1f12db9c-dbb3-410d-a893-4c0bc322bf85
ScopedMembers :
AdditionalProperties : {}
This examples gets all the available directory roles.
Example 2: Get a directory role by Id
Get-MgBetaDirectoryRole -DirectoryRoleId 'a2d10e79-df32-47fc-86ef-64d199860810' |
Format-List
DeletedDateTime :
Description : Can manage all aspects of Azure AD and Microsoft services that use Azure AD identities.
DisplayName : Global Administrator
Id : a2d10e79-df32-47fc-86ef-64d199860810
Members :
RoleTemplateId : 1f12db9c-dbb3-410d-a893-4c0bc322bf85
ScopedMembers :
AdditionalProperties : {}
This example gets the directory role based on the specified Id.
Parameters
-All
List all pages.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CountVariable
Specifies a count of the total number of items in a collection.
By default, this variable will be set in the global scope.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
CV
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DirectoryRoleId
The unique identifier of directoryRole
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Get
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExpandProperty
Expand related entities
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Expand
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Filter
Filter items by property values
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Headers
Optional headers that will be added to the request.
Parameter properties
Type:
IDictionary
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
Type:
IIdentityDirectoryManagementIdentity
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
GetViaIdentity
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PageSize
Sets the page size of results.
Parameter properties
Type:
Int32
Default value:
0
Supports wildcards:
False
DontShow:
False
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Property
Select properties to be returned
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
Select
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
RHV
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Search
Search items by search phrases
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Skip
Skip the first n items
Parameter properties
Type:
Int32
Default value:
0
Supports wildcards:
False
DontShow:
False
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Sort
Order items by property values
Parameter properties
Type:
String[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
OrderBy
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Top
Show only the first n items
Parameter properties
Type:
Int32
Default value:
0
Supports wildcards:
False
DontShow:
False
Aliases:
Limit
Parameter sets
List
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
To create the parameters described below, construct a hash table containing the appropriate properties.
For information on hash tables, run Get-Help about_Hash_Tables.