SearchIndexClient Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.5.1
Package:
Azure.Search.Documents v11.6.0-beta.3
Source:
SearchIndexClient.cs
Source:
SearchIndexClient.cs

Azure Cognitive Search client that can be used to manage indexes on a Search service.

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

Constructors

SearchIndexClient()

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

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

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

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

Initializes a new instance of the SearchIndexClient class.

Properties

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

AnalyzeText(String, AnalyzeTextOptions, CancellationToken)

Shows how an analyzer breaks text into tokens.
AnalyzeTextAsync(String, AnalyzeTextOptions, CancellationToken)

Shows how an analyzer breaks text into tokens.
CreateAlias(SearchAlias, CancellationToken)

Creates a new search alias.
CreateAliasAsync(SearchAlias, CancellationToken)

Creates a new search alias.
CreateIndex(SearchIndex, CancellationToken)

Creates a new search index.
CreateIndexAsync(SearchIndex, CancellationToken)

Creates a new search index.
CreateOrUpdateAlias(String, 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.
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(SynonymMap, CancellationToken)

Creates a new synonym map.
CreateSynonymMapAsync(SynonymMap, CancellationToken)

Creates a new synonym map.
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.
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.
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.
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.
DeleteSynonymMap(String, CancellationToken)

Deletes a synonym map.
DeleteSynonymMap(SynonymMap, Boolean, CancellationToken)

Deletes a synonym map.
DeleteSynonymMapAsync(String, CancellationToken)

Deletes a synonym map.
DeleteSynonymMapAsync(SynonymMap, Boolean, CancellationToken)

Deletes a synonym map.
GetAlias(String, CancellationToken)

Retrieves an alias definition.
GetAliasAsync(String, CancellationToken)

Retrieves an alias definition.
GetAliases(CancellationToken)

Gets a list of all alias definitions available for a search service.
GetAliasesAsync(CancellationToken)

Gets a list of all alias definitions available for a search service.
GetIndex(String, CancellationToken)

Gets a specific SearchIndex.
GetIndexAsync(String, CancellationToken)

Gets a specific SearchIndex.
GetIndexes(CancellationToken)

Gets a list of all indexes.
GetIndexesAsync(CancellationToken)

Gets a list of all indexes.
GetIndexNames(CancellationToken)

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

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

Gets SearchIndexStatistics for the given index, including a document count and storage usage.
GetIndexStatisticsAsync(String, CancellationToken)

Gets SearchIndexStatistics for the given index, including a document count and storage usage.
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.

This operation returns the number and type of objects in your service, the maximum allowed for each object type given the service tier, actual and maximum storage, and other limits that vary by tier. This request pulls information from the service so that you don't have to look up or calculate service limits.

Statistics on document count and storage size are collected every few minutes, not in real time. Therefore, the statistics returned by this API may not reflect changes caused by recent indexing operations.

GetServiceStatisticsAsync(CancellationToken)

Gets service level statistics for a Search service.

This operation returns the number and type of objects in your service, the maximum allowed for each object type given the service tier, actual and maximum storage, and other limits that vary by tier. This request pulls information from the service so that you don't have to look up or calculate service limits.

Statistics on document count and storage size are collected every few minutes, not in real time. Therefore, the statistics returned by this API may not reflect changes caused by recent indexing operations.

GetSynonymMap(String, CancellationToken)

Gets a specific SynonymMap.
GetSynonymMapAsync(String, CancellationToken)

Gets a specific SynonymMap.
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