< Back
Search-AzureSearch
Post
NAME Search-AzureSearch
SYNOPSIS
Search Azure Search index
SYNTAX
Search-AzureSearch [-IndexName] <String> [[-SearchString] <String>] [[-FieldSelection] <String>] [[-Filter]
<String>] [-JsonRequest] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Search-AzureSearch cmdlet lets you search Azure Search index.
PARAMETERS
-IndexName <String>
Azure Search index Name to search documents.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SearchString <String>
Search Criteria.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FieldSelection <String>
Specify field names to retrieve. If you omit it, it gets all fields.
Required? false
Position? 3
Default value *
Accept pipeline input? false
Accept wildcard characters? false
-Filter <String>
Specify filter condition.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JsonRequest [<SwitchParameter>]
When specified, result is returned as json object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Search-AzureSearch -IndexName hotels -SearchString nice -Fields hotelName,rating,description
This example search the hotels index by 'nice' criteria and retrieves specified fields.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Search-AzureSearch -IndexName hotels -SearchString good -Fileter 'ratring eq 1'
This example search the hotels which has 1 rating.
RELATED LINKS
SYNOPSIS
Search Azure Search index
SYNTAX
Search-AzureSearch [-IndexName] <String> [[-SearchString] <String>] [[-FieldSelection] <String>] [[-Filter]
<String>] [-JsonRequest] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Search-AzureSearch cmdlet lets you search Azure Search index.
PARAMETERS
-IndexName <String>
Azure Search index Name to search documents.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SearchString <String>
Search Criteria.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FieldSelection <String>
Specify field names to retrieve. If you omit it, it gets all fields.
Required? false
Position? 3
Default value *
Accept pipeline input? false
Accept wildcard characters? false
-Filter <String>
Specify filter condition.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JsonRequest [<SwitchParameter>]
When specified, result is returned as json object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Search-AzureSearch -IndexName hotels -SearchString nice -Fields hotelName,rating,description
This example search the hotels index by 'nice' criteria and retrieves specified fields.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Search-AzureSearch -IndexName hotels -SearchString good -Fileter 'ratring eq 1'
This example search the hotels which has 1 rating.
RELATED LINKS