Public/UserManagement/AzureAdObjects/Find-AzureAdGroup.ps1
|
# Module: TeamsFunctions # Function: Lookup # Author: David Eberhardt # Updated: 24-JAN-2021 # Status: Live function Find-AzureAdGroup { <# .SYNOPSIS Returns an Object if an AzureAd Group has been found .DESCRIPTION Simple lookup - does the Group Object exist - to avoid TRY/CATCH statements for processing .PARAMETER Identity Mandatory. String to search. Provide part or full DisplayName, MailAddress or MailNickName Returns all matching groups .EXAMPLE Find-AzureAdGroup [-Identity] "My Group" Will return all Groups that have "My Group" in the DisplayName, ObjectId or MailNickName .EXAMPLE Find-AzureAdGroup -Identity "MyGroup@domain.com" Will return all Groups that match "MyGroup@domain.com" in the DisplayName, ObjectId or MailNickName .INPUTS System.String .OUTPUTS Microsoft.Open.AzureAD.Model.Group .NOTES None .COMPONENT UserManagement .FUNCTIONALITY Queries Group Objects in Azure Ad with different mechanics .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Find-AzureAdGroup.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_UserManagement.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/ #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '', Justification = 'Required for performance. Removed with Disconnect-Me')] [CmdletBinding()] [OutputType([System.Object])] param( [Parameter(Mandatory, Position = 0, ValueFromPipeline, HelpMessage = 'This is the Name or MailAddress of the Group')] [Alias('GroupName', 'Name')] [string]$Identity ) #param begin { Show-FunctionStatus -Level Live Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" # Asserting AzureAD Connection if ( -not $script:TFPSSA) { $script:TFPSSA = Assert-AzureADConnection; if ( -not $script:TFPSSA ) { break } } # Adding Types Add-Type -AssemblyName Microsoft.Open.AzureAD16.Graph.Client Add-Type -AssemblyName Microsoft.Open.Azure.AD.CommonLibrary # Loading all Groups if ( -not $global:TeamsFunctionsTenantAzureAdGroups) { Write-Verbose -Message 'Groups not loaded yet, depending on the size of the Tenant, this will run for a while!' -Verbose $global:TeamsFunctionsTenantAzureAdGroups = Get-AzureADGroup -All $true -WarningAction SilentlyContinue -ErrorAction SilentlyContinue } $Groups = $null } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" foreach ($ID in $Identity) { [System.Collections.Generic.List[object]]$Groups = @() $Groups += $global:TeamsFunctionsTenantAzureAdGroups | Where-Object DisplayName -Like "*$ID*" $Groups += $global:TeamsFunctionsTenantAzureAdGroups | Where-Object Description -Like "*$ID*" $Groups += $global:TeamsFunctionsTenantAzureAdGroups | Where-Object ObjectId -Like "*$ID*" $Groups += $global:TeamsFunctionsTenantAzureAdGroups | Where-Object Mail -Like "*$ID*" $MailNickName = $ID.Split('@')[0] $Groups += $global:TeamsFunctionsTenantAzureAdGroups | Where-Object Mailnickname -Like "*$MailNickName*" # Output - Filtering objects if ( $Groups ) { $Groups | Sort-Object -Unique -Property ObjectId | Get-Unique } } } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } # Find-AzureAdGroup |