Get-AcctAzureADSecurityGroupMember
Retrieves all the security group members of a specific security group.
Syntax
Get-AcctAzureADSecurityGroupMember
[-AccessToken] <String>
[-GroupId] <String>
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Get-AcctAzureADSecurityGroupMember
-ServiceAccountUid <Guid>
[-GroupId] <String>
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to retrieve all the security group members from a specific Azure AD group.
Examples
EXAMPLE 1
Retrieves all the security group members of a specific Azure AD security group.
Get-AcctAzureADSecurityGroupMember -AccessToken $accessToken -AzureADTenantId $azureADTenantId -GroupId $gid -Top 10"
MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")
Name : SecurityGroupOfAzureADMachineCatalog
ObjectId : e17d1c86-efgh-efgh-efgh-97e22c7bd96c
Type : Dynamic
Parameters
-ServiceAccountUid
The service account's UID.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AccessToken
Access token of Microsoft Graph API. Make sure grant consent to following permissions:
-
Group.Read.All
-
GroupMember.Read.All
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-GroupId
Specifies the ID of a group in Azure AD.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ReturnTotalRecordCount
When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Acct_Filtering for details.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SortBy
Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell-style filter expression. See about_Acct_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.ADIdentity.Sdk.AzureADSecurityGroup
This object provides details of an object of the Azure AD security group and contains the following information:
-
MembershipRule \<string\>The membershipRule of AzureAD security group.
-
Name \<string\>The name of AzureAD security group.
-
ObjectId \<Guid\>The unique Object Id of the AzureAD security group.
-
Type \<string\>The type of AzureAD security group.
Notes
In the case of failure the following errors can result:
-
PartialDataOnly a subset of the available data was returned.
-
PermissionDeniedThe user does not have administrative rights to perform this operation.
-
ConfigurationLoggingErrorThe operation could not be performed because of a configuration logging error
-
CommunicationErrorAn error occurred while communicating with the service.
-
InvalidFilterA filtering expression was supplied that could not be interpreted for this cmdlet.
-
ExceptionThrownAn unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
-
AzureADTenantIdMismatchAzureADAccessTokenMismatch between the given AzureADTenantID and TenantID in Azure AD AccessToken.