SearchIndexerClient class

Creates an instance of SearchIndexerClient.

Example usage:

const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexerClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Parameters

The API version to use when communicating with the service.

apiVersion: string

Property Value

The endpoint of the search service

endpoint: string

Property Value

The API version to use when communicating with the service.

serviceVersion: string

Property Value

Creates a new dataSource in a search service.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parameters

Returns

Creates a new indexer in a search service.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parameters

Returns

Creates a new datasource or modifies an existing one.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parameters

Returns

Creates a new indexer or modifies an existing one.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parameters

Returns

Creates a new Skillset or modifies an existing one.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parameters

Returns

Creates a new skillset in a search service.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parameters

Returns

Deletes an existing datasource.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parameters

Returns

Deletes an existing indexer.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parameters

Returns

Deletes an existing Skillset.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parameters

Returns

Retrieves information about a DataSource

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parameters

Returns

Retrieves information about an Indexer.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parameters

Returns

Returns the current status and execution history of an indexer.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parameters

Returns

Retrieves information about an Skillset.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parameters

Returns

Retrieves a list of existing data sources in the service.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parameters

Returns

Retrieves a list of names of existing data sources in the service.

function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>

Parameters

Returns

Retrieves a list of existing indexers in the service.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parameters

Returns

Retrieves a list of names of existing indexers in the service.

function listIndexersNames(options?: OperationOptions): Promise<string[]>

Parameters

Returns

Retrieves a list of existing Skillsets in the service.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parameters

Returns

Retrieves a list of names of existing Skillsets in the service.

function listSkillsetsNames(options?: OperationOptions): Promise<string[]>

Parameters

Returns

Resets the change tracking state associated with an indexer.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parameters

Returns

Runs an indexer on-demand.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parameters

Returns