ISearchIndexClient Interface

Definition

Namespace:

Microsoft.Azure.Search

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Client that can be used to query an index and upload, merge, or delete documents.

public interface ISearchIndexClient : IDisposable

type ISearchIndexClient = interface
    interface IDisposable

Public Interface ISearchIndexClient
Implements IDisposable

Derived

Microsoft.Azure.Search.SearchIndexClient

Implements

IDisposable

Properties

AcceptLanguage	The preferred language for the response.
ApiVersion	Client Api Version.
Credentials	Credentials needed for the client to connect to Azure.
DeserializationSettings	Gets or sets json deserialization settings.
Documents	Gets the IDocumentsOperations.
GenerateClientRequestId	Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
IndexName	The name of the index.
LongRunningOperationRetryTimeout	The retry timeout in seconds for Long Running Operations. Default value is 30.
SearchCredentials	Gets the credentials used to authenticate to an Azure Cognitive Search service. This can be either a query API key or an admin API key.
SearchDnsSuffix	The DNS suffix of the search service. The default is search.windows.net.
SearchServiceName	The name of the search service.
SerializationSettings	The base URI of the service.
UseHttpGetForQueries	Indicates whether the index client should use HTTP GET for making Search, Suggest, and Autocomplete requests to the Azure Cognitive Search REST API. The default is false, which indicates that HTTP POST will be used.

Methods

TargetDifferentIndex(String)

Obsolete. Changes the BaseUri of this client to target a different index in the same Azure Cognitive Search service. This method is NOT thread-safe; You must guarantee that no other threads are using the client before calling it.