SearchServiceClient Class

Definition

Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.

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

Constructors

SearchServiceClient(DelegatingHandler[])

Initializes a new instance of the SearchServiceClient class.

SearchServiceClient(HttpClient, Boolean)

Initializes a new instance of the SearchServiceClient class.

SearchServiceClient(HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SearchServiceClient class.

SearchServiceClient(ServiceClientCredentials, DelegatingHandler[])

Initializes a new instance of the SearchServiceClient class.

SearchServiceClient(ServiceClientCredentials, HttpClient, Boolean)

Initializes a new instance of the SearchServiceClient class.

SearchServiceClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SearchServiceClient class.

SearchServiceClient(String, SearchCredentials)

Initializes a new instance of the SearchServiceClient class.

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

Initializes a new instance of the SearchServiceClient class.

Properties

AcceptLanguage

The preferred language for the response.

ApiVersion

Client Api Version.

Credentials

Credentials needed for the client to connect to Azure.

DataSources

Gets the IDataSourcesOperations.

DeserializationSettings

Gets or sets json deserialization settings.

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>)
Indexers

Gets the IIndexersOperations.

Indexes

Gets the IIndexesOperations.

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.

Skillsets

Gets the ISkillsetsOperations.

SynonymMaps

Gets the ISynonymMapsOperations.

UserAgent (Inherited from ServiceClient<T>)

Methods

Dispose() (Inherited from ServiceClient<T>)
Dispose(Boolean) (Inherited from ServiceClient<T>)
GetServiceStatisticsWithHttpMessagesAsync(SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)

Gets service level statistics for an Azure Search service.

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>)

Extension Methods

GetServiceStatistics(ISearchServiceClient, SearchRequestOptions)

Gets service level statistics for an Azure Search service.

GetServiceStatisticsAsync(ISearchServiceClient, SearchRequestOptions, CancellationToken)

Gets service level statistics for an Azure Search service.

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