Find-CsOnlineApplicationInstance
Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria.
Syntax
Default (Default)
Find-CsOnlineApplicationInstance
[-SearchQuery] <string>
[[-MaxResults] <uint>]
[-ExactMatchOnly]
[-AssociatedOnly]
[-UnAssociatedOnly]
[-Force]
[<CommonParameters>]
Description
Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria.
If MaxResults is not specified, the number of returned applications instances is limited to 10 application instances.
Examples
Example 1
Find-CsOnlineApplicationInstance -SearchQuery "Test"
This example returns up to 10 application instances whose name starts with "Test".
Example 2
Find-CsOnlineApplicationInstance -SearchQuery "Test" -MaxResults 5
This example returns up to 5 application instances whose name starts with "Test".
Example 3
Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -ExactMatchOnly
This example returns up to 10 application instances whose name is "Test Auto Attendant".
Example 4
Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -AssociatedOnly
This example returns up to 10 application instances whose name is "Test Auto Attendant", and who are associated with an application configuration, like auto attendant or call queue.
Parameters
-AssociatedOnly
Applicable: Microsoft Teams
The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration.
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 |
-ExactMatchOnly
Applicable: Microsoft Teams
The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false.
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 |
-Force
Applicable: Microsoft Teams
This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| 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. Max allowed value is 20.
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 query for application instances by display name, telephone number, or GUID of the application instance. This parameter accepts partial queries for display names and telephone numbers. The search is not case sensitive.
Parameter properties
| Type: | System.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 |
-UnAssociatedOnly
Applicable: Microsoft Teams
The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration.
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 |
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.