Get-Acctazureadsecuritygroup¶
Retrieve the security groups in specific Azure tenant.
Syntax¶
Get-AcctAzureADSecurityGroup [-AccessToken] <String> [-GroupId <String>] [-Name <String>] [-SearchString <String>] [-Assigned <Boolean>] [-Dynamic <Boolean>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-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.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| AccessToken | Access token of Microsoft Graph API. | true | false | |
| GroupId | The ObjectId of an AzureAD security group. | false | false | |
| Name | The Name of the AzureAD security group. | false | false | |
| SearchString | The search expression of the AzureAD security group display name. | false | false | |
| Assigned | Specify only assigned AzureAD security group will retrieve. | false | false | |
| Dynamic | Specify only dynamic AzureAD security group will retrieve. | false | 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 | |
| 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¶
The parameter of GroupId is the most priority over other parameters. When all parameters are empty, it will return all assigned security groups under current tenant id that encoded in assess token.
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
Examples¶
Example 1¶
C:\>Get-AcctAzureADSecurityGroup -AccessToken $accessToken -GroupId "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 Azure AD security groups with the object id of "e17d1c86-efgh-efgh-efgh-97e22c7bd96c".
Example 2¶
C:\>Get-AcctAzureADSecurityGroup -AccessToken $accessToken -Name "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 AzureAD security group with the name of "ABCD".
Example 3¶
C:\>Get-AcctAzureADSecurityGroup -AccessToken $accessToken -SearchString "SecurityGroup"<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 name contains of "ABCD".
Example 4¶
C:\>Get-AcctAzureADSecurityGroup -AccessToken $accessToken -AssignedOnly<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 : Assigned
Description¶
Gets all AzureAD assigned security groups.