Share via


SearchIndexClient Constructors

Definition

Overloads

SearchIndexClient(DelegatingHandler[])

Initializes a new instance of the SearchIndexClient class.

SearchIndexClient(ServiceClientCredentials, 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, 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.

SearchIndexClient(DelegatingHandler[])

Source:
SearchIndexClient.cs

Initializes a new instance of the SearchIndexClient class.

protected SearchIndexClient (params System.Net.Http.DelegatingHandler[] handlers);
new Microsoft.Azure.Search.SearchIndexClient : System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Search.SearchIndexClient
Protected Sub New (ParamArray handlers As DelegatingHandler())

Parameters

handlers
DelegatingHandler[]

Optional. The delegating handlers to add to the http client pipeline.

Applies to

SearchIndexClient(ServiceClientCredentials, DelegatingHandler[])

Source:
SearchIndexClient.cs

Initializes a new instance of the SearchIndexClient class.

public SearchIndexClient (Microsoft.Rest.ServiceClientCredentials credentials, params System.Net.Http.DelegatingHandler[] handlers);
new Microsoft.Azure.Search.SearchIndexClient : Microsoft.Rest.ServiceClientCredentials * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Search.SearchIndexClient
Public Sub New (credentials As ServiceClientCredentials, ParamArray handlers As DelegatingHandler())

Parameters

credentials
ServiceClientCredentials

Required. Credentials needed for the client to connect to Azure.

handlers
DelegatingHandler[]

Optional. The delegating handlers to add to the http client pipeline.

Exceptions

Thrown when a required parameter is null

Applies to

SearchIndexClient(HttpClient, Boolean)

Source:
SearchIndexClient.cs

Initializes a new instance of the SearchIndexClient class.

protected SearchIndexClient (System.Net.Http.HttpClient httpClient, bool disposeHttpClient);
new Microsoft.Azure.Search.SearchIndexClient : System.Net.Http.HttpClient * bool -> Microsoft.Azure.Search.SearchIndexClient
Protected Sub New (httpClient As HttpClient, disposeHttpClient As Boolean)

Parameters

httpClient
HttpClient

HttpClient to be used

disposeHttpClient
Boolean

True: will dispose the provided httpClient on calling SearchIndexClient.Dispose(). False: will not dispose provided httpClient

Applies to

SearchIndexClient(HttpClientHandler, DelegatingHandler[])

Source:
SearchIndexClient.cs

Initializes a new instance of the SearchIndexClient class.

protected SearchIndexClient (System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);
new Microsoft.Azure.Search.SearchIndexClient : System.Net.Http.HttpClientHandler * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Search.SearchIndexClient
Protected Sub New (rootHandler As HttpClientHandler, ParamArray handlers As DelegatingHandler())

Parameters

rootHandler
HttpClientHandler

Optional. The http client handler used to handle http transport.

handlers
DelegatingHandler[]

Optional. The delegating handlers to add to the http client pipeline.

Applies to

SearchIndexClient(ServiceClientCredentials, HttpClient, Boolean)

Source:
SearchIndexClient.cs

Initializes a new instance of the SearchIndexClient class.

public SearchIndexClient (Microsoft.Rest.ServiceClientCredentials credentials, System.Net.Http.HttpClient httpClient, bool disposeHttpClient);
new Microsoft.Azure.Search.SearchIndexClient : Microsoft.Rest.ServiceClientCredentials * System.Net.Http.HttpClient * bool -> Microsoft.Azure.Search.SearchIndexClient
Public Sub New (credentials As ServiceClientCredentials, httpClient As HttpClient, disposeHttpClient As Boolean)

Parameters

credentials
ServiceClientCredentials

Required. Credentials needed for the client to connect to Azure.

httpClient
HttpClient

HttpClient to be used

disposeHttpClient
Boolean

True: will dispose the provided httpClient on calling SearchIndexClient.Dispose(). False: will not dispose provided httpClient

Exceptions

Thrown when a required parameter is null

Applies to

SearchIndexClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Source:
SearchIndexClient.cs

Initializes a new instance of the SearchIndexClient class.

public SearchIndexClient (Microsoft.Rest.ServiceClientCredentials credentials, System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);
new Microsoft.Azure.Search.SearchIndexClient : Microsoft.Rest.ServiceClientCredentials * System.Net.Http.HttpClientHandler * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Search.SearchIndexClient
Public Sub New (credentials As ServiceClientCredentials, rootHandler As HttpClientHandler, ParamArray handlers As DelegatingHandler())

Parameters

credentials
ServiceClientCredentials

Required. Credentials needed for the client to connect to Azure.

rootHandler
HttpClientHandler

Optional. The http client handler used to handle http transport.

handlers
DelegatingHandler[]

Optional. The delegating handlers to add to the http client pipeline.

Exceptions

Thrown when a required parameter is null

Applies to

SearchIndexClient(String, String, SearchCredentials)

Source:
SearchIndexClient.Customization.cs

Initializes a new instance of the SearchIndexClient class.

public SearchIndexClient (string searchServiceName, string indexName, Microsoft.Azure.Search.SearchCredentials credentials);
new Microsoft.Azure.Search.SearchIndexClient : string * string * Microsoft.Azure.Search.SearchCredentials -> Microsoft.Azure.Search.SearchIndexClient
Public Sub New (searchServiceName As String, indexName As String, credentials As SearchCredentials)

Parameters

searchServiceName
String

Required. The name of the search service.

indexName
String

Required. The name of the search index.

credentials
SearchCredentials

Required. The credentials used to authenticate to a search service. https://docs.microsoft.com/rest/api/searchservice/

Applies to

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

Source:
SearchIndexClient.Customization.cs

Initializes a new instance of the SearchIndexClient class.

public SearchIndexClient (string searchServiceName, string indexName, Microsoft.Azure.Search.SearchCredentials credentials, System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);
new Microsoft.Azure.Search.SearchIndexClient : string * string * Microsoft.Azure.Search.SearchCredentials * System.Net.Http.HttpClientHandler * System.Net.Http.DelegatingHandler[] -> Microsoft.Azure.Search.SearchIndexClient
Public Sub New (searchServiceName As String, indexName As String, credentials As SearchCredentials, rootHandler As HttpClientHandler, ParamArray handlers As DelegatingHandler())

Parameters

searchServiceName
String

Required. The name of the search service.

indexName
String

Required. The name of the search index.

credentials
SearchCredentials

Required. The credentials used to authenticate to a search service. https://docs.microsoft.com/rest/api/searchservice/

rootHandler
HttpClientHandler

Optional. The http client handler used to handle http transport.

handlers
DelegatingHandler[]

Optional. The set of delegating handlers to insert in the http client pipeline.

Applies to