Find-CsGroup

Module:

MicrosoftTeamsPowerShell

Applies to:

Microsoft Teams

Use the Find-CsGroup cmdlet to search groups.

Syntax

PowerShell

Find-CsGroup
    [-Tenant <Guid>]
    -SearchQuery <String>
    [-MaxResults <UInt32>]
    [-ExactMatchOnly <Boolean>]
    [-MailEnabledOnly <Boolean>][-Force]
    [<CommonParameters>]

Description

The Find-CsGroup cmdlet lets you search groups in the Azure Address Book Service (AABS).

Examples

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

PowerShell

Find-CsGroup -SearchQuery "Contoso Group" -MaxResults 5

This example finds and displays up to five groups that match the "Contoso Group" search query.

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

PowerShell

Find-CsGroup -SearchQuery "ed0d1180-169e-47c7-b718-bf9e60543914" -ExactMatchOnly $true

This example finds and displays only those groups that are an exact match to the search query.

Parameters

-ExactMatchOnly

The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Force

PARAMVALUE: SwitchParameter

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-MailEnabledOnly

Instructs the cmdlet to return mail enabled only groups.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxResults

The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10.

Type:	UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-SearchQuery

The SearchQuery parameter defines a search query to search the display name or the sip address or the GUID of groups. This parameter accepts partial search query. The search is not case sensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Tenant

This parameter is reserved for internal Microsoft use.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

Inputs

None

Outputs

Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel

The Find-CsGroup cmdlet returns a list of Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel. Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel contains Id and DisplayName.