SearchIndexClient Class

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

The SearchIndexClient.

public class SearchIndexClient
type SearchIndexClient = class
Public Class SearchIndexClient
Inheritance
Object
SearchIndexClient

Constructors

Name Description
SearchIndexClient()

Initializes a new instance of the SearchIndexClient class for mocking.
SearchIndexClient(SearchIndexClientSettings)

Initializes a new instance of SearchIndexClient from a SearchIndexClientSettings.
SearchIndexClient(Uri, AzureKeyCredential, SearchClientOptions)

Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(Uri, AzureKeyCredential)

Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(Uri, TokenCredential, SearchClientOptions)

Initializes a new instance of the SearchIndexClient class.
SearchIndexClient(Uri, TokenCredential)

Initializes a new instance of the SearchIndexClient class.

Properties

Name Description
Endpoint

Gets the URI endpoint of the Search service. This is likely to be similar to "https://{search_service}.search.windows.net".
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.
ServiceName

Gets the name of the Search service.

Methods

Name Description
AnalyzeText(String, AnalyzeTextOptions, CancellationToken)

Shows how an analyzer breaks text into tokens.
AnalyzeText(String, RequestContent, RequestContext)

[Protocol Method] Shows how an analyzer breaks text into tokens.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
AnalyzeTextAsync(String, AnalyzeTextOptions, CancellationToken)

Shows how an analyzer breaks text into tokens.
AnalyzeTextAsync(String, RequestContent, RequestContext)

[Protocol Method] Shows how an analyzer breaks text into tokens.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateAlias(RequestContent, RequestContext)

[Protocol Method] Creates a new search alias.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateAlias(SearchAlias, CancellationToken)

Creates a new search alias.
CreateAliasAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new search alias.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateAliasAsync(SearchAlias, CancellationToken)

Creates a new search alias.
CreateIndex(RequestContent, RequestContext)

[Protocol Method] Creates a new search index.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateIndex(SearchIndex, CancellationToken)

Creates a new search index.
CreateIndexAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new search index.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateIndexAsync(SearchIndex, CancellationToken)

Creates a new search index.
CreateKnowledgeBase(KnowledgeBase, CancellationToken)

Creates a new knowledge base.
CreateKnowledgeBase(RequestContent, RequestContext)

[Protocol Method] Creates a new knowledge base.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateKnowledgeBaseAsync(KnowledgeBase, CancellationToken)

Creates a new knowledge base.
CreateKnowledgeBaseAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new knowledge base.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateKnowledgeSource(KnowledgeSource, CancellationToken)

Creates a new knowledge source.
CreateKnowledgeSource(RequestContent, RequestContext)

[Protocol Method] Creates a new knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateKnowledgeSourceAsync(KnowledgeSource, CancellationToken)

Creates a new knowledge source.
CreateKnowledgeSourceAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateAlias(SearchAlias, Boolean, CancellationToken)

Creates a new search alias or updates an alias if it already exists.
CreateOrUpdateAlias(String, SearchAlias, Boolean, CancellationToken)

Creates a new search alias or updates an alias if it already exists.
CreateOrUpdateAliasAsync(SearchAlias, Boolean, CancellationToken)

Creates a new search alias or updates an alias if it already exists.
CreateOrUpdateAliasAsync(String, SearchAlias, Boolean, CancellationToken)

Creates a new search alias or updates an alias if it already exists.
CreateOrUpdateIndex(SearchIndex, Boolean, Boolean, CancellationToken)

Creates a new search index or updates an existing index.
CreateOrUpdateIndexAsync(SearchIndex, Boolean, Boolean, CancellationToken)

Creates a new search index or updates an existing index.
CreateOrUpdateKnowledgeBase(KnowledgeBase, Boolean, CancellationToken)

Creates a new knowledge base or updates a knowledge base if it already exists.
CreateOrUpdateKnowledgeBaseAsync(KnowledgeBase, Boolean, CancellationToken)

Creates a new knowledge base or updates a knowledge base if it already exists.
CreateOrUpdateKnowledgeSource(KnowledgeSource, Boolean, CancellationToken)

Creates a new knowledge source or updates an knowledge source if it already exists.
CreateOrUpdateKnowledgeSourceAsync(KnowledgeSource, Boolean, CancellationToken)

Creates a new knowledge source or updates an knowledge source if it already exists.
CreateOrUpdateSynonymMap(SynonymMap, Boolean, CancellationToken)

Creates a new synonym map or updates an existing synonym map.
CreateOrUpdateSynonymMapAsync(SynonymMap, Boolean, CancellationToken)

Creates a new synonym map or updates an existing synonym map.
CreateSynonymMap(RequestContent, RequestContext)

[Protocol Method] Creates a new synonym map.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateSynonymMap(SynonymMap, CancellationToken)

Creates a new synonym map.
CreateSynonymMapAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new synonym map.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateSynonymMapAsync(SynonymMap, CancellationToken)

Creates a new synonym map.
DeleteAlias(SearchAlias, Boolean, CancellationToken)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
DeleteAlias(String, CancellationToken)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
DeleteAlias(String, MatchConditions, CancellationToken)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
DeleteAlias(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteAliasAsync(SearchAlias, Boolean, CancellationToken)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
DeleteAliasAsync(String, CancellationToken)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
DeleteAliasAsync(String, MatchConditions, CancellationToken)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
DeleteAliasAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteIndex(SearchIndex, Boolean, CancellationToken)

Deletes a search index and all the documents it contains.
DeleteIndex(String, CancellationToken)

Deletes a search index and all the documents it contains.
DeleteIndex(String, MatchConditions, CancellationToken)

Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.
DeleteIndex(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)

Deletes a search index and all the documents it contains.
DeleteIndexAsync(String, CancellationToken)

Deletes a search index and all the documents it contains.
DeleteIndexAsync(String, MatchConditions, CancellationToken)

Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.
DeleteIndexAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteKnowledgeBase(KnowledgeBase, Boolean, CancellationToken)

Deletes an existing knowledge base.
DeleteKnowledgeBase(String, CancellationToken)

Deletes an existing knowledge base.
DeleteKnowledgeBase(String, MatchConditions, CancellationToken)

Deletes a knowledge base.
DeleteKnowledgeBase(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a knowledge base.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteKnowledgeBaseAsync(KnowledgeBase, Boolean, CancellationToken)

Deletes an existing knowledge base.
DeleteKnowledgeBaseAsync(String, CancellationToken)
DeleteKnowledgeBaseAsync(String, MatchConditions, CancellationToken)

Deletes a knowledge base.
DeleteKnowledgeBaseAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a knowledge base.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteKnowledgeSource(KnowledgeSource, Boolean, CancellationToken)

Deletes an existing knowledge source.
DeleteKnowledgeSource(String, CancellationToken)

Deletes an existing knowledge source.
DeleteKnowledgeSource(String, MatchConditions, CancellationToken)

Deletes an existing knowledge source.
DeleteKnowledgeSource(String, MatchConditions, RequestContext)

[Protocol Method] Deletes an existing knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteKnowledgeSourceAsync(KnowledgeSource, Boolean, CancellationToken)

Deletes an existing knowledge source.
DeleteKnowledgeSourceAsync(String, CancellationToken)

Deletes an existing knowledge source.
DeleteKnowledgeSourceAsync(String, MatchConditions, CancellationToken)

Deletes an existing knowledge source.
DeleteKnowledgeSourceAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes an existing knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteSynonymMap(String, CancellationToken)

Deletes a synonym map.
DeleteSynonymMap(String, MatchConditions, CancellationToken)

Deletes a synonym map.
DeleteSynonymMap(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a synonym map.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteSynonymMap(SynonymMap, Boolean, CancellationToken)

Deletes a synonym map.
DeleteSynonymMapAsync(String, CancellationToken)

Deletes a synonym map.
DeleteSynonymMapAsync(String, MatchConditions, CancellationToken)

Deletes a synonym map.
DeleteSynonymMapAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a synonym map.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteSynonymMapAsync(SynonymMap, Boolean, CancellationToken)

Deletes a synonym map.
GetAlias(String, CancellationToken)

Retrieves an alias definition.
GetAlias(String, RequestContext)

[Protocol Method] Retrieves an alias definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAliasAsync(String, CancellationToken)

Retrieves an alias definition.
GetAliasAsync(String, RequestContext)

[Protocol Method] Retrieves an alias definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAliases(CancellationToken)

Lists all aliases available for a search service.
GetAliases(RequestContext)

[Protocol Method] Lists all aliases available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAliasesAsync(CancellationToken)

Lists all aliases available for a search service.
GetAliasesAsync(RequestContext)

[Protocol Method] Lists all aliases available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndex(String, CancellationToken)

Retrieves an index definition.
GetIndex(String, RequestContext)

[Protocol Method] Retrieves an index definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexAsync(String, CancellationToken)

Retrieves an index definition.
GetIndexAsync(String, RequestContext)

[Protocol Method] Retrieves an index definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexes(CancellationToken)

Gets a list of all indexes.
GetIndexes(RequestContext)

[Protocol Method] Lists all indexes available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexesAsync(CancellationToken)

Gets a list of all indexes.
GetIndexesAsync(RequestContext)

[Protocol Method] Lists all indexes available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexesWithSelectedProperties(IEnumerable<String>, CancellationToken)

Lists all indexes available for a search service.
GetIndexesWithSelectedProperties(IEnumerable<String>, RequestContext)

[Protocol Method] Lists all indexes available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexesWithSelectedPropertiesAsync(IEnumerable<String>, CancellationToken)

Lists all indexes available for a search service.
GetIndexesWithSelectedPropertiesAsync(IEnumerable<String>, RequestContext)

[Protocol Method] Lists all indexes available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexNames(CancellationToken)

Gets a list of all index names.
GetIndexNamesAsync(CancellationToken)

Gets a list of all index names.
GetIndexStatistics(String, CancellationToken)

Returns statistics for the given index, including a document count and storage usage.
GetIndexStatistics(String, RequestContext)

[Protocol Method] Returns statistics for the given index, including a document count and storage usage.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexStatisticsAsync(String, CancellationToken)

Returns statistics for the given index, including a document count and storage usage.
GetIndexStatisticsAsync(String, RequestContext)

[Protocol Method] Returns statistics for the given index, including a document count and storage usage.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexStatsSummary(CancellationToken)

Retrieves a summary of statistics for all indexes in the search service.
GetIndexStatsSummaryAsync(CancellationToken)

Retrieves a summary of statistics for all indexes in the search service.
GetKnowledgeBase(String, CancellationToken)

Retrieves a knowledge base definition.
GetKnowledgeBase(String, RequestContext)

[Protocol Method] Retrieves a knowledge base definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeBaseAsync(String, CancellationToken)

Retrieves a knowledge base definition.
GetKnowledgeBaseAsync(String, RequestContext)

[Protocol Method] Retrieves a knowledge base definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeBases(CancellationToken)

Lists all knowledge bases available for a search service.
GetKnowledgeBases(RequestContext)

[Protocol Method] Lists all knowledge bases available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeBasesAsync(CancellationToken)

Lists all knowledge bases available for a search service.
GetKnowledgeBasesAsync(RequestContext)

[Protocol Method] Lists all knowledge bases available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSource(String, CancellationToken)

Retrieves a knowledge source definition.
GetKnowledgeSource(String, RequestContext)

[Protocol Method] Retrieves a knowledge source definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSourceAsync(String, CancellationToken)

Retrieves a knowledge source definition.
GetKnowledgeSourceAsync(String, RequestContext)

[Protocol Method] Retrieves a knowledge source definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSources(CancellationToken)

Lists all knowledge sources available for a search service.
GetKnowledgeSources(RequestContext)

[Protocol Method] Lists all knowledge sources available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSourcesAsync(CancellationToken)

Lists all knowledge sources available for a search service.
GetKnowledgeSourcesAsync(RequestContext)

[Protocol Method] Lists all knowledge sources available for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSourceStatus(String, CancellationToken)

Retrieves the status of a knowledge source.
GetKnowledgeSourceStatus(String, RequestContext)

[Protocol Method] Retrieves the status of a knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSourceStatusAsync(String, CancellationToken)

Retrieves the status of a knowledge source.
GetKnowledgeSourceStatusAsync(String, RequestContext)

[Protocol Method] Retrieves the status of a knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSearchClient(String)

Get a SearchClient for the given indexName to use for document operations like querying or adding documents to a Search Index.
GetServiceStatistics(CancellationToken)

Gets service level statistics for a search service.
GetServiceStatistics(RequestContext)

[Protocol Method] Gets service level statistics for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetServiceStatisticsAsync(CancellationToken)

Gets service level statistics for a search service.
GetServiceStatisticsAsync(RequestContext)

[Protocol Method] Gets service level statistics for a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSynonymMap(String, CancellationToken)

Retrieves a synonym map definition.
GetSynonymMap(String, RequestContext)

[Protocol Method] Retrieves a synonym map definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSynonymMapAsync(String, CancellationToken)

Retrieves a synonym map definition.
GetSynonymMapAsync(String, RequestContext)

[Protocol Method] Retrieves a synonym map definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSynonymMapNames(CancellationToken)

Gets a list of all synonym map names.
GetSynonymMapNamesAsync(CancellationToken)

Gets a list of all synonym map names.
GetSynonymMaps(CancellationToken)

Gets a list of all synonym maps.
GetSynonymMapsAsync(CancellationToken)

Gets a list of all synonym maps.

Applies to