Get-UnifiedGroup

This cmdlet is available only in the cloud-based service. Use the Get-UnifiedGroup cmdlet to view Office 365 groups in your cloud-based organization. To view members, owners and subscribers for Office 365 groups, use the Get-UnifiedGroupLinks cmdlet. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-UnifiedGroup
   [-Anr <String>]
   [-Filter <String>]
   [-IncludeSoftDeletedGroups]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [<CommonParameters>]
Get-UnifiedGroup
   [[-Identity] <UnifiedGroupIdParameter>]
   [-Filter <String>]
   [-IncludeSoftDeletedGroups]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [<CommonParameters>]

Description

Office 365 groups are group objects that are available across Office 365 services.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Get-UnifiedGroup

This example returns a summary list of all Office 365 groups.

-------------------------- Example 2 --------------------------

Get-UnifiedGroup | Format-List DisplayName,EmailAddresses,Notes,ManagedBy,AccessType

This example returns the following information about all Office 365 groups:

  • Display name

  • Email address

  • Description

  • Owners

  • Privacy

-------------------------- Example 3 --------------------------

Get-UnifiedGroup -Identity "Marketing Department" | Format-List

This example returns detailed information about the Office 365 Group named Marketing Department.

Optional Parameters

-Anr

This parameter is reserved for internal Microsoft use.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Filter

The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.

  • <Property> is a filterable property.

  • -<Comparison Operator> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about_Comparison_Operators (https://go.microsoft.com/fwlink/p/?LinkId=620712).

  • <Value> is the property value. Text values with or without spaces need to be enclosed in quotation marks ('<Value>'). Don't use quotation marks with integers or the system values $true, $false, or $null.

You can chain multiple search criteria together using the logical operators -and and -or. For example, {<Criteria1>) -and <Criteria2>} or {(<Criteria1> -and <Criteria2>) -or <Criteria3>}.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Identity

The Identity parameter specifies the Office 365 Group that you want to view. You can use any value that uniquely identifies the Office 365 Group.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • Email address

  • GUID

Type:UnifiedGroupIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online
-IncludeAllProperties

The IncludeAllProperties switch specifies whether to include the values of all properties in the results. You don't need to specify a value with this switch.

If you don't use this switch, the values of some properties (for example, CalendarMemeberReadOnly, CalendarUrl, InboxUrl, PeopleUrl, and PhotoUrl) might appear blank.

Position:Named
Accept pipeline input:false
Accept wildcard characters:False
-IncludeSoftDeletedGroups

The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted Office 365 groups in the results. You don't need to specify a value with this switch.

This switch is required to return soft-deleted Office 365 groups.

Soft-deleted Office 365 groups are deleted groups that are still recoverable.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ResultSize

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-SortBy

The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto <Property1>,<Property2>... to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.

You can sort by the following properties:

  • Name

  • DisplayName

  • Alias

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.