Citrix Virtual Apps and Desktops SDK

Get-AcctAzureADSecurityGroupMember

March 11, 2024

Contributed by:

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>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to retrieve all the security group members from a specific Azure AD group.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
AccessToken	Access token of Microsoft Graph API. Make sure grant consent to following permissions: - Group.Read.All - GroupMember.Read.All	true	false
GroupId	Specifies the ID of a group in Azure AD.	true	false
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.	false	false	False
MaxRecordCount	Specifies the maximum number of records to return.	false	false	250
Skip	Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.	false	false	0
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.	false	false	The default sort order is by name or unique identifier.
Filter	Gets records that match a PowerShell-style filter expression. See about_Acct_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

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.

PartialData: Only a subset of the available data was returned.
PermissionDenied: The user does not have administrative rights to perform this operation.
ConfigurationLoggingError: The operation could not be performed because of a configuration logging error
CommunicationError: An error occurred while communicating with the service.
InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.
ExceptionThrown: An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs. AzureADTenantIdMismatchAzureADAccessToken Mismatch between the given AzureADTenantID and TenantID in Azure AD AccessToken.

Examples

Example 1

C:\>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

<!--NeedCopy-->

Description

Retrieves all the security group members of a specific Azure AD security group.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-AcctAzureADSecurityGroupMember

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-AcctAzureADSecurityGroupMember

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Adidentity.Sdk.Azureadsecuritygroup

Notes

Examples

Example 1

Description

In this article