Edit

Share via

Get-AzureADDirectoryRole

  • Reference
Module:
AzureADPreview

Gets a directory role.

Syntax

Get-AzureADDirectoryRole
   [-Filter <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Get-AzureADDirectoryRole
   -ObjectId <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Get-AzureADDirectoryRole cmdlet gets a directory role from Azure Active Directory (AD).

Examples

Example 1: Get a directory role by ID

PS C:\>Get-AzureADDirectoryRole -ObjectId "87166072-c682-42c6-8d6b-68c8fb88a868"

ObjectId                             DisplayName                        Description
--------                             -----------                        -----------
87166072-c682-42c6-8d6b-68c8fb88a868 Directory Writers              Can read and write basic directory information. For granting access to applications, not intended for users.

Example 2: Get all directory roles

PS C:\>Get-AzureADDirectoryRole

ObjectId                             DisplayName                        Description
--------                             -----------                        -----------
87166072-c682-42c6-8d6b-68c8fb88a868 Directory Writers                  Can read and write basic directory information. For granting access to applications, not intended for users.
67efd1ad-1046-4fb8-bb57-1d2e4f66c74e Directory Readers                  Can read basic directory information. Commonly used to grant directory read access to applications and guests.

Parameters

-Filter

{{ Fill Filter Description }}

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ObjectId

Specifies the ID of a directory role in Azure AD.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False