Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

SearchIndexClient.GetSearchClient(String) Method

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v12.1.0-beta.1
Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get a SearchClient for the given indexName to use for document operations like querying or adding documents to a Search Index.

public virtual Azure.Search.Documents.SearchClient GetSearchClient(string indexName);
abstract member GetSearchClient : string -> Azure.Search.Documents.SearchClient
override this.GetSearchClient : string -> Azure.Search.Documents.SearchClient
Public Overridable Function GetSearchClient (indexName As String) As SearchClient

Parameters

indexName
String

The name of the desired Search Index.

Returns

A SearchClient for the desired Search Index.

Exceptions

Thrown when the indexName is null.

Thrown when the indexName is empty.

Remarks

The same request HttpPipeline (including authentication and any other configuration) will be used for the SearchClient.

Applies to

Feedback

Was this page helpful?