Retrieves the list of groups that contain the Azure group or Azure user specified by the Identifier and IdentifierClass parameters.
Get-AzureDRAGroupMembership -Tenant <String> -IdentifierClass <String> -Identifier <String> [-EnforceServerLimit <SwitchParameter>] [-Attributes <String[]>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Get-AzureDRAGroupMembership cmdlet returns the groups that have the Identifier object as a member. The requesting user must have the View All Azure Group Properties power or a custom power with the necessary powers for the requested attribute. You can view the default list of attributes or specify specific attributes. You can also control the number of groups returned in the results, and iterate result sets, if necessary. See the examples for information on how to view specific attributes and control the pages of results returned from the server. The response will also have the attribute TotalObjectCount which contains the total number of groups containing the Identifier object as a member.
|
Attribute / Description |
Values |
||||
|---|---|---|---|---|---|
|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
|
IdentifierClass <String> Specifies the object type of the Identifier. Valid values are azuregroup and azureuser. |
true |
named |
|
true (ByPropertyName) |
false |
|
Identifier <String> The GUID of the Azure object. For example: 3FB3B182-FAA2-476A-9843-5F77B245DD03 |
true |
named |
|
true (ByPropertyName) |
false |
|
Tenant <String> The Tenant ID of the object in GUID or displayname format. For example: b201dhg8-087e-5n9d-9986-c4d987bfa0b1 or MyTenant |
true |
named |
|
true (ByPropertyName) |
false |
|
EnforceServerLimit [<SwitchParameter>] A switch parameter to indicate that the search results should be limited by the search result limit on the DRA Server. The typical server limit is 1000 items. The default is true. |
false |
named |
|
false |
false |
|
Attributes [<String[]>] An array of attributes to retrieve specific values. If this parameter is missing, a default list of attributes is returned. |
false |
named |
|
true (ByPropertyName) |
false |
|
DRARestServer [<String>] The name of the computer running the DRA REST Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'. |
false |
named |
true (ByPropertyName) |
false |
|
|
DRARestPort [<Int32>] The port where the DRA REST Service listens for requests. This parameter is used only when the DRARestServer parameter is also specified. If the parameter is not specified, the value defaults to 8755. |
false |
named |
8755 |
true (ByPropertyName) |
false |
|
IgnoreCertificateErrors [<SwitchParameter>] Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate. |
false |
named |
false |
false |
|
|
Force [<SwitchParameter>] Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user. |
false |
named |
false |
false |
|
|
Timeout [<Int32>] The wait time in seconds before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1. |
false |
named |
100 seconds |
true (ByPropertyName) |
false |
|
<CommonParameters> Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters. |
|
|
|
|
|
NOTE:For more information, type "Get-Help Get-AzureDRAGroupMembership -detailed". For technical information, type "Get-Help Get-AzureDRAGroupMembership -full".
Example 3-8 1
PS C:\>Get-AzureDRAGroupMembership -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -IdentifierClass "azuregroup" -Attributes "Id","Name"
This example retrieves the list of Azure groups that contain the Azure group in the tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the object. The results will include the set of attributes requested through the Attributes parameter. If the Attributes parameter is not specified, a default list of properties will be returned.
Example 3-9 1
PS C:\>Get-AzureDRAGroupMembership -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -IdentifierClass "azuregroup" -Attributes "Id","Name" -StartRow 501 -ResumeString "{904E1327-F859-490A-A420-8DE8D0F299EF}"
This example retrieves the list of Azure groups that contain the Azure group in the tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the object. The results will include the properties “Id" and "Name" for each Azure group. The server will return 500 items in the result, starting from the index specified in the StartRow parameter. ResumeString is used when there are multiple pages of results to be returned. If more data is available, the results will include the ResumeString property to retrieve the next page of results