Skip to content

Get-Acctazureadsecuritygroup

Retrieve the security groups in specific Azure tenant.

Syntax

Get-AcctAzureADSecurityGroup [-AccessToken] <String> [-AzureADTenantId] <Guid> [-ObjectId <String>] [-SecurityGroupName <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability to retrieve the Azure AD security groups of specific Azure tenant.

Parameters

Name Description Required? Pipeline Input Default Value
AccessToken Access token of Microsoft Graph API. true false
AzureADTenantId The TenantId of AzureAD. true false
ObjectId The Object Id of the AzureAD security group. false false
SecurityGroupName The name of AzureAD security group. false false
BearerToken Specifies the bearer token assigned to 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 Specifies the address of a XenDesktop 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.
Error Codes
-----------
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
The given AzureADTenantId mismatchs TenantId contained in AzureAD AccessToken.

Examples

Example 1

C:\>Get-AcctAzureADSecurityGroup -AccessToken $accessToken -AzureADTenantId $azureADTenantId -SecurityGroupName "SecurityGroupOfAzureADMachineCatalog"<br><br>MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")<br><br>Name : SecurityGroupOfAzureADMachineCatalog<br><br>ObjectId  : e17d1c86-efgh-efgh-efgh-97e22c7bd96c<br><br>Type : Dynamic

Description

Gets Azure AD security groups with the name of "ABCD".

Example 2

C:\>Get-AcctAzureADSecurityGroup -AccessToken $accessToken -AzureADTenantId $azureADTenantId -ObjectId "e17d1c86-efgh-efgh-efgh-97e22c7bd96c"<br><br>MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")<br><br>Name : SecurityGroupOfAzureADMachineCatalog<br><br>ObjectId  : e17d1c86-efgh-efgh-efgh-97e22c7bd96c<br><br>Type : Dynamic

Description

Gets AzureAD security group with the ObjectId of "e17d1c86-efgh-efgh-efgh-97e22c7bd96c".

Was this article helpful?