SearchIndexClient Class

Definition

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

public class SearchIndexClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.Search.SearchIndexClient>, IDisposable, Microsoft.Azure.Search.ISearchIndexClient, Microsoft.Rest.Azure.IAzureClient
type SearchIndexClient = class
    inherit ServiceClient<SearchIndexClient>
    interface ISearchIndexClient
    interface IDisposable
    interface IAzureClient
Public Class SearchIndexClient
Inherits ServiceClient(Of SearchIndexClient)
Implements IAzureClient, IDisposable, ISearchIndexClient
Inheritance
SearchIndexClient
Implements

Constructors

SearchIndexClient(DelegatingHandler[])

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(HttpClient, Boolean)

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(ServiceClientCredentials, DelegatingHandler[])

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(ServiceClientCredentials, HttpClient, Boolean)

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(String, String, SearchCredentials)

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(String, String, SearchCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SearchIndexClient class.

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.

FirstMessageHandler (Inherited from ServiceClient<T>)
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.

HttpClient (Inherited from ServiceClient<T>)
HttpClientHandler (Inherited from ServiceClient<T>)
HttpMessageHandlers (Inherited from ServiceClient<T>)
IndexName

The name of the Azure Search 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 Search service. This can be either a query API key or an admin API key.

SearchDnsSuffix

The DNS suffix of the Azure Search service. The default is search.windows.net.

SearchServiceName

The name of the Azure Search service.

SerializationSettings

Gets or sets json serialization settings.

UseHttpGetForQueries

Indicates whether the index client should use HTTP GET for making Search, Suggest, and Autocomplete requests to the Azure Search REST API. The default is false, which indicates that HTTP POST will be used.

UserAgent (Inherited from ServiceClient<T>)

Methods

Dispose() (Inherited from ServiceClient<T>)
Dispose(Boolean) (Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClientHandler, DelegatingHandler[]) (Inherited from ServiceClient<T>)
SetRetryPolicy(RetryPolicy) (Inherited from ServiceClient<T>)
SetUserAgent(String) (Inherited from ServiceClient<T>)
SetUserAgent(String, String) (Inherited from ServiceClient<T>)
TargetDifferentIndex(String)

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

Extension Methods

GetLongRunningOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)
GetLongRunningOperationResultAsync<THeader>(IAzureClient, AzureOperationHeaderResponse<THeader>, Dictionary<String,List<String>>, CancellationToken)
GetLongRunningOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)
GetLongRunningOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)
GetPostOrDeleteOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)
GetPostOrDeleteOperationResultAsync<THeader>(IAzureClient, AzureOperationHeaderResponse<THeader>, Dictionary<String,List<String>>, CancellationToken)
GetPostOrDeleteOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)
GetPostOrDeleteOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)
GetPutOrPatchOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)
GetPutOrPatchOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)
GetPutOrPatchOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)

Applies to