Class SearchClientOptions

Provides the client configuration options for connecting to Azure Cognitive Search.

Inheritance

Azure.Core.ClientOptions

SearchClientOptions

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Search.Documents.dll

Syntax

public class SearchClientOptions : Azure.Core.ClientOptions

Constructors

SearchClientOptions(SearchClientOptions+ServiceVersion)

Initializes a new instance of the SearchClientOptions class.

Declaration

public SearchClientOptions (Azure.Search.Documents.SearchClientOptions.ServiceVersion version = Azure.Search.Documents.SearchClientOptions+ServiceVersion.V2023_07_01_Preview);

Parameters

SearchClientOptions.ServiceVersion version An optional SearchClientOptions.ServiceVersion to specify the version of the REST API to use. For more, see API versions in Azure Cognitive Search. If not provided, the version will default to the latest supported by this client library. It is recommended that application authors allow the version to float to the latest and library authors pin to a specific version.

Exceptions

System.ArgumentOutOfRangeException Thrown when the version is not supported by this client library.

Properties

Audience

Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.

Declaration

public Nullable<Azure.Search.Documents.SearchAudience> Audience { get; set; }

Property Value

System.Nullable<SearchAudience> If null, AzurePublicCloud will be assumed.

Serializer

Gets or sets an Azure.Core.Serialization.ObjectSerializer that can be used to customize the serialization of strongly typed models. The serializer needs to support JSON and Azure.Core.Serialization.JsonObjectSerializer will be used if no value is provided.

Declaration

public Azure.Core.Serialization.ObjectSerializer Serializer { get; set; }

Property Value

Azure.Core.Serialization.ObjectSerializer

Version

Gets the SearchClientOptions.ServiceVersion of the service API used when making requests. For more, see API versions in Azure Cognitive Search.

Declaration

public Azure.Search.Documents.SearchClientOptions.ServiceVersion Version { get; }

Property Value

SearchClientOptions.ServiceVersion