3.2 Get-AzureDRAGroup

Synopsis

Gets a group in Azure Active Directory.

Syntax

Get-AzureDRAGroup -Tenant <String> [-AzureGroupAndFilter <Hashtable>] [-AzureGroupOrFilter <Hashtable>] [-Identifier <String>] [-Attributes <String[]>] [-PowersForOperations <String[]>] [-VisiblePropertiesOnly <SwitchParameter>] [-EnforceServerLimit <SwitchParameter>] [-ObjectsPerResponse <Int32>] [-ResumeString <String>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Get-AzureDRAGroup cmdlet gets a group in Azure Active Directory. The requesting user must have the View All Azure Group Properties power or a custom power with the necessary powers for the requested attributes. You can view the default list of attributes or specify specific attributes. The default attributes for an Azure group include: Path, DisplayName, Name, FriendlyName, FriendlyPath, ID, GroupType, and TenantIntID.

See the examples for information on how to view specific attributes.

Parameters

Attribute / Description	Values
Attribute / Description	Required	Position	Default Value	Accept Pipeline input?	Accept wildcard characters?
AzureGroupAndFilter [<Hashtable>] The group properties to use when searching for group objects. Groups matching all of the listed properties will be returned.	false	named		true (ByPropertyName)	false
AzureGroupOrFilter [<Hashtable>] The group properties to when searching for group objects. Groups matching any of the listed properties will be returned.	false	named		true (ByPropertyName)	false
Identifier [<String>] The GUID of the Azure group. For example: 3FB3B182-FAA2-476A-9843-5F77B245DD03	false	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
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
PowersForOperations [<String[]>] An array of DRA operation names for which you want the server to return read/write permission information. This parameter is typically used by a UI-based client to hide or disable elements the calling user does not have powers for. The PowersForOperations parameter is applicable only if you have specified the Identifier parameter.	false	named		true (ByPropertyName)	false
VisiblePropertiesOnly [<SwitchParameter>] A flag to indicate whether DRA should return only properties the caller has power to view. By default, DRA will return an error if the caller requests a property that they do not have power to view. By specifying this flag, DRA is instructed to not return an error and instead just not return a value for such properties.	false	named		false	false
EnforceServerLimit [<SwitchParameter>] A switch parameter indicates 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
ObjectsPerResponse [<Nullable`1>] The number of objects to return in a response. The default is 250.	false	named		false	false
ResumeString [<String>] When multiple responses are needed to return all of the search results to the client, this parameter indicates the last item returned from the server. The value of this parameter would be set using the ResumeString attribute from the previous set of results.The ResumeString may look like this:"CN=MYUser160,CN=Users,DC=MyDomain,DC=corp" or "CN=679F4DD0-5C6C-412F-B600-DCADD401DA0D,az=3e6d3c95-7249-4036-8af5-e6a4f517bd68" The EnforceServerLimit, ObjectsPerResponse, and ResumeString parameters are applicable only when the Identifier parameter is not specified.	false	named		false	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-AzureDRAGroup -detailed". For technical information, type "Get-Help Get-AzureDRAGroup -full".

Example 3-3 1

PS C:\>Get-AzureDRAGroup -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Attributes "Name","ID","FriendlyPath","FriendlyParentPath","FriendlyName"

This example requests the properties of the group 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in the tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The Attributes parameter specifies what properties to return. When the Attributes parameter is not present, a default list of properties will be returned.

Example 3-4 2

PS C:\>Get-AzureDRAGroup -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -AzureGroupOrFilter @{Name="AA*"} -ObjectsPerResponse 50

PS C:\>Get-AzureDRAGroup -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -AzureGroupOrFilter @{Name="AA*"} -ObjectsPerResponse 50 -ResumeString "CN=BE4907B3-E6E3-4E22-B6A6-DCA5EC92F7DF,az=b201dhg8-087e-5n9d-9986-c4d987bfa0b1"

This example returns Azure groups whose names begin with "AA" in the tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. If there are more objects than the number specified in ObjectsPerResponse, the ResumeString will be returned which can be used in a subsequent call to retrieve the next object set. The next line in this example shows how to use the ResumeString in the subsequent call.

Example 3-5 3

PS C:\>Get-AzureDRAGroup -Tenant MyTenant -AzureUserOrFilter @{MultiMatch="PF"}

In this example, a filter search will be conducted using "PF" with Multimatch.