Edit

Share via

Get-AzureADMSGroup

  • Reference
Module:
AzureADPreview

Gets information about groups in Azure AD.

Syntax

Get-AzureADMSGroup
   [-All <Boolean>]
   [-Top <Int32>]
   [-Select <String>]
   [-Filter <String>]
   [<CommonParameters>]
Get-AzureADMSGroup
   [-SearchString <String>]
   [-All <Boolean>]
   [<CommonParameters>]
Get-AzureADMSGroup
   -Id <String>
   [-All <Boolean>]
   [-Select <String>]
   [<CommonParameters>]

Description

The Get-AzureADMSGroup cmdlet gets information about groups in Azure Active Directory (Azure AD). To get a group, specify the Id parameter. Specify the SearchString or Filter parameter to find particular groups. If you specify no parameters, this cmdlet gets all groups.

Examples

Example 1: Get all groups

PS C:\> Get-AzureADMSGroup

Id                            : d539a25e-2db2-482a-9dcb-2a0b27fe4f27 
Description                   : 
OnPremisesSyncEnabled         : 
DisplayName                   : 
ADSyncOperators 
OnPremisesLastSyncDateTime    : 
Mail                          : 
MailEnabled                   : False
MailNickname                  : ADSyncOperators 
OnPremisesSecurityIdentifier  : S-1-5-21-2695029449-1154706203-1063139792-1243 
ProxyAddresses                : {} 
SecurityEnabled               : True 
GroupTypes                    : {} 
MembershipRule                : 
MembershipRuleProcessingState :


Id                            : d98ddc78-6e8d-4f0d-8a3f-b923c6ebc14b 
Description                   : 
OnPremisesSyncEnabled         : 
DisplayName                   : Project Icarus 
OnPremisesLastSyncDateTime    : 
Mail                          : 
MailEnabled                   : False 
MailNickname                  : 60f3d02c-0c6e-41da-bb64-128c73b4d9e6 
OnPremisesSecurityIdentifier  : 
ProxyAddresses                : {} 
SecurityEnabled               : True 
GroupTypes                    : {DynamicMembership} 
MembershipRule                : (user.jobtitle -eq "Sales manager") -or ((user.department -eq "Marketing") -and (user.country -eq "Greece")) 
MembershipRuleProcessingState : On

This command gets all groups in Azure AD.

Example 2: Get a specific group by using an ID

PS C:\> Get-AzureADMSGroup -Id "d98ddc78-6e8d-4f0d-8a3f-b923c6ebc14b"

Id                            : d98ddc78-6e8d-4f0d-8a3f-b923c6ebc14b 
Description                   : 
OnPremisesSyncEnabled         : 
DisplayName                   : Project Icarus 
OnPremisesLastSyncDateTime    : 
Mail                          : 
MailEnabled                   : False 
MailNickname                  : 60f3d02c-0c6e-41da-bb64-128c73b4d9e6 
OnPremisesSecurityIdentifier  : 
ProxyAddresses                : {} 
SecurityEnabled               : True 
GroupTypes                    : {DynamicMembership} 
MembershipRule                : (user.jobtitle -eq "Sales manager") -or ((user.department -eq "Marketing") -and (user.country -eq "Greece")) 
MembershipRuleProcessingState : On

This command gets information for the group that has the specified ID.

Example 3: Get AssignedLabels and DisplayName property values for all groups

PS C:\> Get-AzureADMSGroup -Select "AssignedLabels,DisplayName"

AssignedLabels                : [{LabelId: "00000000-0000-0000-0000-000000000000", DisplayName: "Confidential"}]
DisplayName                   : Project Icarus 1

AssignedLabels                : [{LabelId: "00000000-0000-0000-0000-000000000000", DisplayName: "Confidential"}]
DisplayName                   : Project Icarus 2

This command gets AssignedLabels and DisplayName property values for all groups.

AssignedLabels group property could be retrieved only by Select parameter.

Example 4: Get AssignedLabels and DisplayName property values for a group

PS C:\> Get-AzureADMSGroup -Id "11111111-1111-1111-1111-111111111111" -Select "AssignedLabels,DisplayName"

AssignedLabels                : [{LabelId: "00000000-0000-0000-0000-000000000000", DisplayName: "Confidential"}]
DisplayName                   : Project Icarus 1

This command gets AssignedLabels and DisplayName property values for a specific group.

AssignedLabels group property could be retrieved only by Select parameter.

Parameters

-All

If true, return all groups. If false, return the number of objects specified by the Top parameter

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

-Filter

Specifies an oData v3.0 filter string to match a set of groups.

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

-Id

Specifies the ID of the group that this cmdlet gets.

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

-SearchString

Specifies a search string. This cmdlet gets groups that have DisplayName or Description attributes that match the search string.

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

-Select

Specifies a list of group properties to retrieve.

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

-Top

Specifies the maximum number of records that this cmldet gets. The default value is 100.

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

Inputs

String

System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

Object

Notes

This cmdlet is currently in Public Preview. While a cmdlet is in Public Preview, we may make changes to the cmdlet which could have unexpected effects. We recommend that you do not use this cmdlet in a production environment.