Find-CsGroup

Use the Find-CsGroup cmdlet to search groups.

Syntax

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

Description

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

Examples

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

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 --------------------------

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

-AsJob

Indicates that this cmdlet runs as a background job.

When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-ExactMatchOnly

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

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Force

PARAMVALUE: SwitchParameter

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Tenant

This parameter is reserved for internal Microsoft use.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

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.