SearchIndexerClient 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:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

Azure Cognitive Search client that can be used to manage and query indexes and documents, as well as manage other resources, on a Search Service.

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

Constructors

SearchIndexerClient()

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

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

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

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

Initializes a new instance of the SearchIndexerClient 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

CreateDataSourceConnection(SearchIndexerDataSourceConnection, CancellationToken)

Creates a new data source connection.
CreateDataSourceConnectionAsync(SearchIndexerDataSourceConnection, CancellationToken)

Creates a new data source connection.
CreateIndexer(SearchIndexer, CancellationToken)

Creates a new indexer.
CreateIndexerAsync(SearchIndexer, CancellationToken)

Creates a new indexer.
CreateOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, Boolean, Nullable<Boolean>, CancellationToken)

Creates a new data source or updates an existing data source connection.
CreateOrUpdateDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, Nullable<Boolean>, CancellationToken)

Creates a new data source or updates an existing data source connection.
CreateOrUpdateIndexer(SearchIndexer, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new indexer or updates an existing indexer.
CreateOrUpdateIndexerAsync(SearchIndexer, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new indexer or updates an existing indexer.
CreateOrUpdateSkillset(SearchIndexerSkillset, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new skillset or updates an existing skillset.
CreateOrUpdateSkillsetAsync(SearchIndexerSkillset, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new skillset or updates an existing skillset.
CreateSkillset(SearchIndexerSkillset, CancellationToken)

Creates a new skillset.
CreateSkillsetAsync(SearchIndexerSkillset, CancellationToken)

Creates a new skillset.
DeleteDataSourceConnection(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnection(String, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnectionAsync(String, CancellationToken)

Deletes a data source connection.
DeleteIndexer(SearchIndexer, Boolean, CancellationToken)

Deletes an indexer.
DeleteIndexer(String, CancellationToken)

Deletes an indexer.
DeleteIndexerAsync(SearchIndexer, Boolean, CancellationToken)

Deletes an indexer.
DeleteIndexerAsync(String, CancellationToken)

Deletes an indexer.
DeleteSkillset(SearchIndexerSkillset, Boolean, CancellationToken)

Deletes a skillset.
DeleteSkillset(String, CancellationToken)

Deletes a skillset.
DeleteSkillsetAsync(SearchIndexerSkillset, Boolean, CancellationToken)

Deletes a skillset.
DeleteSkillsetAsync(String, CancellationToken)

Deletes a skillset.
GetDataSourceConnection(String, CancellationToken)

Gets a specific SearchIndexerDataSourceConnection.
GetDataSourceConnectionAsync(String, CancellationToken)

Gets a specific SearchIndexerDataSourceConnection.
GetDataSourceConnectionNames(CancellationToken)

Gets a list of all data source connection names.
GetDataSourceConnectionNamesAsync(CancellationToken)

Gets a list of all data source connection names.
GetDataSourceConnections(CancellationToken)

Gets a list of all data source connections.
GetDataSourceConnectionsAsync(CancellationToken)

Gets a list of all data source connections.
GetIndexer(String, CancellationToken)

Gets a specific SearchIndexer.
GetIndexerAsync(String, CancellationToken)

Gets a specific SearchIndexer.
GetIndexerNames(CancellationToken)

Gets a list of all indexer names.
GetIndexerNamesAsync(CancellationToken)

Gets a list of all indexer names.
GetIndexers(CancellationToken)

Gets a list of all indexers.
GetIndexersAsync(CancellationToken)

Gets a list of all indexers.
GetIndexerStatus(String, CancellationToken)

Gets the current status and execution history of an indexer.
GetIndexerStatusAsync(String, CancellationToken)

Gets the current status and execution history of an indexer.
GetSkillset(String, CancellationToken)

Gets a specific SearchIndexerSkillset.
GetSkillsetAsync(String, CancellationToken)

Gets a specific SearchIndexerSkillset.
GetSkillsetNames(CancellationToken)

Gets a list of all skillset names.
GetSkillsetNamesAsync(CancellationToken)

Gets a list of all skillset names.
GetSkillsets(CancellationToken)

Gets a list of all skillsets.
GetSkillsetsAsync(CancellationToken)

Gets a list of all skillsets.
ResetDocuments(String, Nullable<Boolean>, ResetDocumentOptions, CancellationToken)

Resets specific documents in the datasource to be selectively re-ingested by the indexer.
ResetDocumentsAsync(String, Nullable<Boolean>, ResetDocumentOptions, CancellationToken)

Resets specific documents in the datasource to be selectively re-ingested by the indexer.
ResetIndexer(String, CancellationToken)

Resets the change tracking state associated with an indexer.
ResetIndexerAsync(String, CancellationToken)

Resets the change tracking state associated with an indexer.
ResetSkills(String, ResetSkillsOptions, CancellationToken)

Resets skills in an existing skillset in a search service.
ResetSkillsAsync(String, ResetSkillsOptions, CancellationToken)

Resets skills in an existing skillset in a search service.
RunIndexer(String, CancellationToken)

Run an indexer now.
RunIndexerAsync(String, CancellationToken)

Run an indexer now.

Applies to