Find-CsGroup
Use the Find-CsGroup cmdlet to search groups.
Syntax
Default (Default)
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
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
-ExactMatchOnly
Applicable: Microsoft Teams
The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Microsoft Teams
PARAMVALUE: SwitchParameter
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MailEnabledOnly
Instructs the cmdlet to return mail enabled only groups.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaxResults
Applicable: Microsoft Teams
The MaxResults parameter identifies the maximum number of results to return. If this parameter is not provided, the default is value is 10.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SearchQuery
Applicable: Microsoft Teams
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Applicable: Microsoft Teams
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.