Get-AADGroupByID

SYNOPSIS

Retrieves an Azure AD Group by hte provided Object ID

SYNTAX

Get-AADGroupByID [-AccessToken] <Object> [-ObjectId] <String[]> [[-BaseUrl] <String>] [[-APIversion] <String>]
 [-WhatIf] [-Confirm]

DESCRIPTION

Searches Azure Active Directory Graph API for a Group by the provided Object ID. The provided Object ID must be a full case-insensitive match. Partial matches and wildcards are not supported. The Object ID is the Azure AD Object ID and not the ObjectGUID synced from an On-prem AD. A MSGraphAPI.DirectoryObject.Group object will be returned for the matching group.

Get-AADGroupById requires a MSGraphAPI.Oauth.AccessToken issued for the https://graph.windows.net resource. See the Get-GraphOauthAccessToken help for more information.

Get-Help -Name Get-GraphOauthAccessToken -Parameter Resource

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

$AADGroup = Get-AADGroupByID -AccessToken $GraphAccessToken -ObjectID d377e755-9365-400f-ab42-c0bf278c386e

PARAMETERS

-AccessToken

MSGraphAPI.Oauth.AccessToken object obtained from Get-GraphOauthAccessToken. Access Token must be issued for the https://graph.windows.net resource.

Type: Object
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ObjectId

The group's Azure AD ObjectID e.g d377e755-9365-400f-ab42-c0bf278c386e This is not the ObjectGUID synced from an On-prem AD

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-BaseUrl

The Azure AD Graph Base URL. This is not required. Deafult https://graph.windows.net

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: Https://graph.windows.net
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-APIversion

Version of the API to use. Default is 1.6

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: 1.6
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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