SearchIndexClient.GetSearchClient(String) Method

Reference

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.5.1

Package:: Azure.Search.Documents v11.6.0-beta.3

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

SearchClient

A SearchClient for the desired Search Index.

Exceptions

ArgumentNullException

Thrown when the indexName is null.

ArgumentException

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