Edit

Find-CsOnlineApplicationInstance

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria.

Syntax

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

The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration.

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

-ExactMatchOnly

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

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

-Force

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.

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

-MaxResults

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.

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

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

-UnAssociatedOnly

The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration.

Type:SwitchParameter
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.Online.Models.FindApplicationInstanceResult