你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchClient 构造函数

定义

命名空间:

Azure.Search.Documents

程序集:

Azure.Search.Documents.dll

包:

Azure.Search.Documents v11.6.0

重载

SearchClient()	初始化 SearchClient 类的新实例以供模拟。
SearchClient(Uri, String, AzureKeyCredential)	初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。
SearchClient(Uri, String, TokenCredential)	初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。
SearchClient(Uri, String, AzureKeyCredential, SearchClientOptions)	初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。
SearchClient(Uri, String, TokenCredential, SearchClientOptions)	初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。

SearchClient()

Source:

SearchClient.cs

初始化 SearchClient 类的新实例以供模拟。

protected SearchClient();

Protected Sub New ()

SearchClient(Uri, String, AzureKeyCredential)

Source:

SearchClient.cs

初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。

public SearchClient(Uri endpoint, string indexName, Azure.AzureKeyCredential credential);

new Azure.Search.Documents.SearchClient : Uri * string * Azure.AzureKeyCredential -> Azure.Search.Documents.SearchClient

Public Sub New (endpoint As Uri, indexName As String, credential As AzureKeyCredential)

参数

endpoint

Uri

必需。 搜索服务的 URI 终结点。 这很可能类似于“https://{search_service}.search.windows.net”。 URI 必须使用 HTTPS。

indexName

String

必需。 搜索索引的名称。

credential

AzureKeyCredential

必需。 用于对搜索服务的请求进行身份验证的 API 密钥凭据。 需要使用管理密钥来修改搜索索引中的文档。 有关 Azure 认知搜索 中的 API 密钥的详细信息，请参阅为 Azure 认知搜索 服务创建和管理 API 密钥。

例外

ArgumentNullException

当 、 indexName或 credential 为 null 时endpoint引发。

ArgumentException

当 未使用 HTTPS 或 indexName 为空时endpoint引发。

SearchClient(Uri, String, TokenCredential)

Source:

SearchClient.cs

初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。

public SearchClient(Uri endpoint, string indexName, Azure.Core.TokenCredential tokenCredential);

new Azure.Search.Documents.SearchClient : Uri * string * Azure.Core.TokenCredential -> Azure.Search.Documents.SearchClient

Public Sub New (endpoint As Uri, indexName As String, tokenCredential As TokenCredential)

参数

endpoint

Uri

必需。 搜索服务的 URI 终结点。 这很可能类似于“https://{search_service}.search.windows.net”。 URI 必须使用 HTTPS。

indexName

String

必需。 搜索索引的名称。

tokenCredential

TokenCredential

必需。 用于对搜索服务的请求进行身份验证的令牌凭据。 有关Azure 认知搜索中基于角色的授权的详细信息，请参阅在 Azure 认知搜索 中使用基于角色的授权。

例外

ArgumentNullException

当 、 indexName或 tokenCredential 为 null 时endpoint引发。

ArgumentException

当 未使用 HTTPS 或 indexName 为空时endpoint引发。

SearchClient(Uri, String, AzureKeyCredential, SearchClientOptions)

Source:

SearchClient.cs

初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。

public SearchClient(Uri endpoint, string indexName, Azure.AzureKeyCredential credential, Azure.Search.Documents.SearchClientOptions options);

new Azure.Search.Documents.SearchClient : Uri * string * Azure.AzureKeyCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.SearchClient

Public Sub New (endpoint As Uri, indexName As String, credential As AzureKeyCredential, options As SearchClientOptions)

参数

endpoint

Uri

必需。 搜索服务的 URI 终结点。 这很可能类似于“https://{search_service}.search.windows.net”。 URI 必须使用 HTTPS。

indexName

String

必需。 搜索索引的名称。

credential

AzureKeyCredential

必需。 用于对搜索服务的请求进行身份验证的 API 密钥凭据。 需要使用管理密钥来修改搜索索引中的文档。 有关 Azure 认知搜索 中的 API 密钥的详细信息，请参阅为 Azure 认知搜索 服务创建和管理 API 密钥。

options

SearchClientOptions

用于连接到 Azure 认知搜索 的客户端配置选项。

例外

ArgumentNullException

当 、 indexName或 credential 为 null 时endpoint引发。

ArgumentException

当 未使用 HTTPS 或 indexName 为空时endpoint引发。

SearchClient(Uri, String, TokenCredential, SearchClientOptions)

Source:

SearchClient.cs

初始化 SearchClient 类的新实例，以便查询索引以及上传、合并或删除文档。

public SearchClient(Uri endpoint, string indexName, Azure.Core.TokenCredential tokenCredential, Azure.Search.Documents.SearchClientOptions options);

new Azure.Search.Documents.SearchClient : Uri * string * Azure.Core.TokenCredential * Azure.Search.Documents.SearchClientOptions -> Azure.Search.Documents.SearchClient

Public Sub New (endpoint As Uri, indexName As String, tokenCredential As TokenCredential, options As SearchClientOptions)

参数

endpoint

Uri

必需。 搜索服务的 URI 终结点。 这很可能类似于“https://{search_service}.search.windows.net”。 URI 必须使用 HTTPS。

indexName

String

必需。 搜索索引的名称。

tokenCredential

TokenCredential

必需。 用于对搜索服务的请求进行身份验证的令牌凭据。 有关Azure 认知搜索中基于角色的授权的详细信息，请参阅在 Azure 认知搜索 中使用基于角色的授权。

options

SearchClientOptions

用于连接到 Azure 认知搜索 的客户端配置选项。

例外

ArgumentNullException

当 、 indexName或 tokenCredential 为 null 时endpoint引发。

ArgumentException

当 未使用 HTTPS 或 indexName 为空时endpoint引发。