-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
Get-AcctAzureADSecurityGroup
-
-
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-AcctAzureADSecurityGroup
Introduced in: Citrix Virtual Apps and Desktop 7 2206
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>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Provides the ability to retrieve the Azure AD security groups of specific Azure tenant.
Examples
EXAMPLE 1
Gets Azure AD security groups with the object id of “e17d1c86-efgh-efgh-efgh-97e22c7bd96c”.
Get-AcctAzureADSecurityGroup -AccessToken $accessToken -GroupId "e17d1c86-efgh-efgh-efgh-97e22c7bd96c"
MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")
Name : SecurityGroupOfAzureADMachineCatalog
ObjectId : e17d1c86-efgh-efgh-efgh-97e22c7bd96c
Type : Dynamic
<!--NeedCopy-->
EXAMPLE 2
Gets AzureAD security group with the name of “ABCD”.
Get-AcctAzureADSecurityGroup -AccessToken $accessToken -Name "SecurityGroupOfAzureADMachineCatalog"
MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")
Name : SecurityGroupOfAzureADMachineCatalog
ObjectId : e17d1c86-efgh-efgh-efgh-97e22c7bd96c
Type : Dynamic
<!--NeedCopy-->
EXAMPLE 3
Gets AzureAD security group with name contains of “ABCD”.
Get-AcctAzureADSecurityGroup -AccessToken $accessToken -SearchString "SecurityGroup"
MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")
Name : SecurityGroupOfAzureADMachineCatalog
ObjectId : e17d1c86-efgh-efgh-efgh-97e22c7bd96c
Type : Dynamic
<!--NeedCopy-->
EXAMPLE 4
Gets all AzureAD assigned security groups.
Get-AcctAzureADSecurityGroup -AccessToken $accessToken -AssignedOnly
MembershipRule : (device.displayName -match "AzureADMC[0-9]{3}$")
Name : SecurityGroupOfAzureADMachineCatalog
ObjectId : e17d1c86-efgh-efgh-efgh-97e22c7bd96c
Type : Assigned
<!--NeedCopy-->
Parameters
-AccessToken
Access token of Microsoft Graph API. Make sure grant consent to following permissions:
- Group.Read.All
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-GroupId
The ObjectId of an AzureAD security group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-Name
The Name of the AzureAD security group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-SearchString
The search expression of the AzureAD security group display name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-Assigned
Specify only assigned AzureAD security group will retrieve.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-Dynamic
Specify only dynamic AzureAD security group will retrieve.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
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
The parameter GroupId will take 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:
-
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
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.