< Back

Get-AzureRmADGroup

Tue Jan 29, 2019 10:05 pm

NAME Get-AzureRmADGroup



SYNOPSIS

Filters active directory groups.





SYNTAX

Get-AzureRmADGroup [-DefaultProfile <IAzureContextContainer>] [-ObjectId <Guid>] [<CommonParameters>]



Get-AzureRmADGroup [-DefaultProfile <IAzureContextContainer>] -ObjectId <Guid> [<CommonParameters>]



Get-AzureRmADGroup [-DefaultProfile <IAzureContextContainer>] -SearchString <String> [<CommonParameters>]





DESCRIPTION

Filters active directory groups.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ObjectId <Guid>

Object id of the group.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SearchString <String>

The group display name



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

System.Collections.Generic.List`1[Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup]







NOTES









Filters groups using object id



PS C:\\> Get-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE



Gets group with 85F89C90-780E-4AA6-9F4F-6F268D322EEE id





Filters groups using Search String



PS C:\\> Get-AzureRmADGroup -SearchString Joe



Filters all ad groups that has Joe in the display name.





List AD groups



PS C:\\> Get-AzureRmADGroup



Gets all AD groups







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ermadgroup

Get-AzureRmADUser

Get-AzureRmADServicePrincipal

Get-AzureRmADGroupMember