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

SearchIndexClient.GetIndex(String, CancellationToken) 方法

定义

命名空间:

Azure.Search.Documents.Indexes

程序集:

Azure.Search.Documents.dll

包:

Azure.Search.Documents v11.5.1

Source:

SearchIndexClient.cs

获取特定的 SearchIndex。

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex> GetIndex (string indexName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndex : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>
override this.GetIndex : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>

Public Overridable Function GetIndex (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchIndex)

参数

indexName

String

必需。 要获取的索引的名称。

cancellationToken

CancellationToken

可选 CancellationToken ，用于传播应取消操作的通知。

返回

Response<SearchIndex>

Response<T>包含请求SearchIndex的 的服务器的 。

例外

ArgumentNullException

当 indexName 为 null 时引发。

RequestFailedException

当搜索服务返回失败时引发。