|
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml |
| 3 | +applicable: Skype for Business Online |
| 4 | +title: Find-CsOnlineApplicationInstance |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Find-CsOnlineApplicationInstance |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +``` |
| 16 | +Find-CsOnlineApplicationInstance -SearchQuery <String> [-MaxResults <UInt32?>] [-ExactMatchOnly] [-AssociatedOnly] [-UnAssociatedOnly] [-Tenant <Guid>] [-CommonParameters] |
| 17 | +``` |
| 18 | + |
| 19 | +## DESCRIPTION |
| 20 | +Use the Find-CsOnlineApplicationInstance cmdlet to find application instances that match your search criteria. |
| 21 | + |
| 22 | +If MaxResults is not specified, the number of returned applications instances is limited to 10 application instances. |
| 23 | + |
| 24 | +## EXAMPLES |
| 25 | + |
| 26 | +### -------------------------- Example 1 -------------------------- |
| 27 | +```powershell |
| 28 | +Find-CsOnlineApplicationInstance -SearchQuery "Test" |
| 29 | +``` |
| 30 | + |
| 31 | +This example returns up to 10 application instances whose name starts with "Test". |
| 32 | + |
| 33 | +### -------------------------- Example 2 -------------------------- |
| 34 | +```powershell |
| 35 | +Find-CsOnlineApplicationInstance -SearchQuery "Test" -MaxResults 5 |
| 36 | +``` |
| 37 | + |
| 38 | +This example returns up to 5 application instances whose name starts with "Test". |
| 39 | + |
| 40 | +### -------------------------- Example 3 -------------------------- |
| 41 | +```powershell |
| 42 | +Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -ExactMatchOnly |
| 43 | +``` |
| 44 | + |
| 45 | +This example returns up to 10 application instances whose name is "Test Auto Attendant". |
| 46 | + |
| 47 | +### -------------------------- Example 4 -------------------------- |
| 48 | +```powershell |
| 49 | +Find-CsOnlineApplicationInstance -SearchQuery "Test Auto Attendant" -AssociatedOnly |
| 50 | +``` |
| 51 | + |
| 52 | +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. |
| 53 | + |
| 54 | +## PARAMETERS |
| 55 | + |
| 56 | +### -SearchQuery |
| 57 | +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. |
| 58 | + |
| 59 | +```yaml |
| 60 | +Type: System.String |
| 61 | +Parameter Sets: (All) |
| 62 | +Aliases: |
| 63 | +Applicable: Skype for Business Online |
| 64 | + |
| 65 | +Required: True |
| 66 | +Position: Named |
| 67 | +Default value: None |
| 68 | +Accept pipeline input: False |
| 69 | +Accept wildcard characters: False |
| 70 | +``` |
| 71 | +
|
| 72 | +### -ExactMatchOnly |
| 73 | +The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. The default value is false. |
| 74 | +
|
| 75 | +```yaml |
| 76 | +Type: SwitchParameter |
| 77 | +Parameter Sets: (All) |
| 78 | +Aliases: |
| 79 | +Applicable: Skype for Business Online |
| 80 | + |
| 81 | +Required: False |
| 82 | +Position: Named |
| 83 | +Default value: None |
| 84 | +Accept pipeline input: False |
| 85 | +Accept wildcard characters: False |
| 86 | +``` |
| 87 | +
|
| 88 | +### -AssociatedOnly |
| 89 | +The AssociatedOnly parameter instructs the cmdlet to return only application instances that are associated to a configuration. |
| 90 | +
|
| 91 | +```yaml |
| 92 | +Type: SwitchParameter |
| 93 | +Parameter Sets: (All) |
| 94 | +Aliases: |
| 95 | +Applicable: Skype for Business Online |
| 96 | + |
| 97 | +Required: False |
| 98 | +Position: Named |
| 99 | +Default value: None |
| 100 | +Accept pipeline input: False |
| 101 | +Accept wildcard characters: False |
| 102 | +``` |
| 103 | +
|
| 104 | +### -UnAssociatedOnly |
| 105 | +The UnAssociatedOnly parameter instructs the cmdlet to return only application instances that are not associated to any configuration. |
| 106 | +
|
| 107 | +```yaml |
| 108 | +Type: SwitchParameter |
| 109 | +Parameter Sets: (All) |
| 110 | +Aliases: |
| 111 | +Applicable: Skype for Business Online |
| 112 | + |
| 113 | +Required: False |
| 114 | +Position: Named |
| 115 | +Default value: None |
| 116 | +Accept pipeline input: False |
| 117 | +Accept wildcard characters: False |
| 118 | +``` |
| 119 | +
|
| 120 | +### -MaxResults |
| 121 | +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. |
| 122 | +
|
| 123 | +```yaml |
| 124 | +Type: UInt32 |
| 125 | +Parameter Sets: (All) |
| 126 | +Aliases: |
| 127 | +Applicable: Skype for Business Online |
| 128 | + |
| 129 | +Required: False |
| 130 | +Position: Named |
| 131 | +Default value: None |
| 132 | +Accept pipeline input: False |
| 133 | +Accept wildcard characters: False |
| 134 | +``` |
| 135 | +
|
| 136 | +### -Tenant |
| 137 | +
|
| 138 | +```yaml |
| 139 | +Type: System.Guid |
| 140 | +Parameter Sets: (All) |
| 141 | +Aliases: |
| 142 | +Applicable: Skype for Business Online |
| 143 | + |
| 144 | +Required: False |
| 145 | +Position: Named |
| 146 | +Default value: None |
| 147 | +Accept pipeline input: False |
| 148 | +Accept wildcard characters: False |
| 149 | +``` |
| 150 | +
|
| 151 | +### CommonParameters |
| 152 | +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
| 153 | + |
| 154 | +## INPUTS |
| 155 | + |
| 156 | +### None |
| 157 | + |
| 158 | + |
| 159 | +## OUTPUTS |
| 160 | + |
| 161 | +### Microsoft.Rtc.Management.Hosted.Online.Models.FindApplicationInstanceResult |
| 162 | + |
| 163 | + |
| 164 | +## NOTES |
| 165 | + |
| 166 | +## RELATED LINKS |
0 commit comments