Class SearchIndexerClient

constructor

• new SearchIndexerClient(endpoint, credential, options?): SearchIndexerClient

• Creates an instance of SearchIndexerClient.

  Example usage:

  const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");
  
  const client = new SearchIndexerClient(
    "<endpoint>",
    new AzureKeyCredential("<Admin Key>");
  );
  Copy

  Parameters

  • endpoint: string

    The endpoint of the search service
  • credential: any

    Used to authenticate requests to the service.
  • options: SearchIndexerClientOptions = {}

    Used to configure the Search client.

  Returns SearchIndexerClient

ReadonlyapiVersion

Readonlyendpoint

Readonlypipeline

ReadonlyserviceVersion

createDataSourceConnection

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

• Creates a new dataSource in a search service.

  Parameters

  • dataSourceConnection: SearchIndexerDataSourceConnection

    The dataSource definition to create in a search service.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexerDataSourceConnection>

createIndexer

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

• Creates a new indexer in a search service.

  Parameters

  • indexer: SearchIndexer

    The indexer definition to create in a search service.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexer>

createOrUpdateDataSourceConnection

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

• Creates a new datasource or modifies an existing one.

  Parameters

  • dataSourceConnection: SearchIndexerDataSourceConnection

    The information describing the datasource to be created/updated.
  • options: CreateorUpdateDataSourceConnectionOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer

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

• Creates a new indexer or modifies an existing one.

  Parameters

  • indexer: SearchIndexer

    The information describing the indexer to be created/updated.
  • options: CreateorUpdateIndexerOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexer>

createOrUpdateSkillset

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

• Creates a new Skillset or modifies an existing one.

  Parameters

  • skillset: SearchIndexerSkillset

    The information describing the index to be created.
  • options: CreateOrUpdateSkillsetOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexerSkillset>

createSkillset

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

• Creates a new skillset in a search service.

  Parameters

  • skillset: SearchIndexerSkillset

    The skillset containing one or more skills to create in a search service.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexerSkillset>

deleteDataSourceConnection

• deleteDataSourceConnection(dataSourceConnection, options?): Promise<void>

• Deletes an existing datasource.

  Parameters

  • dataSourceConnection: string | SearchIndexerDataSourceConnection
  • options: DeleteDataSourceConnectionOptions = {}

    Additional optional arguments.

  Returns Promise<void>

deleteIndexer

• deleteIndexer(indexer, options?): Promise<void>

• Deletes an existing indexer.

  Parameters

  • indexer: string | SearchIndexer

    Indexer/Name of the indexer to delete.
  • options: DeleteIndexerOptions = {}

    Additional optional arguments.

  Returns Promise<void>

deleteSkillset

• deleteSkillset(skillset, options?): Promise<void>

• Deletes an existing Skillset.

  Parameters

  • skillset: string | SearchIndexerSkillset

    Skillset/Name of the Skillset to delete.
  • options: DeleteSkillsetOptions = {}

    Additional optional arguments.

  Returns Promise<void>

getDataSourceConnection

• getDataSourceConnection(dataSourceConnectionName, options?): Promise<SearchIndexerDataSourceConnection>

• Retrieves information about a DataSource

  Parameters

  • dataSourceConnectionName: string
  • options: OperationOptions = {}

    Additional optional arguments

  Returns Promise<SearchIndexerDataSourceConnection>

getIndexer

• getIndexer(indexerName, options?): Promise<SearchIndexer>

• Retrieves information about an Indexer.

  Parameters

  • indexerName: string

    The name of the Indexer.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexer>

getIndexerStatus

• getIndexerStatus(indexerName, options?): Promise<SearchIndexerStatus>

• Returns the current status and execution history of an indexer.

  Parameters

  • indexerName: string

    The name of the indexer.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexerStatus>

getSkillset

• getSkillset(skillsetName, options?): Promise<SearchIndexerSkillset>

• Retrieves information about an Skillset.

  Parameters

  • skillsetName: string
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexerSkillset>

listDataSourceConnections

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

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

  Parameters

  • options: OperationOptions = {}

    Options to the list indexers operation.

  Returns Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames

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

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

  Parameters

  • options: OperationOptions = {}

    Options to the list indexers operation.

  Returns Promise<string[]>

listIndexers

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

• Retrieves a list of existing indexers in the service.

  Parameters

  • options: OperationOptions = {}

    Options to the list indexers operation.

  Returns Promise<SearchIndexer[]>

listIndexersNames

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

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

  Parameters

  • options: OperationOptions = {}

    Options to the list indexers operation.

  Returns Promise<string[]>

listSkillsets

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

• Retrieves a list of existing Skillsets in the service.

  Parameters

  • options: OperationOptions = {}

    Options to the list Skillsets operation.

  Returns Promise<SearchIndexerSkillset[]>

listSkillsetsNames

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

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

  Parameters

  • options: OperationOptions = {}

    Options to the list Skillsets operation.

  Returns Promise<string[]>

resetDocuments

• resetDocuments(indexerName, options?): Promise<void>

• Resets specific documents in the datasource to be selectively re-ingested by the indexer.

  Parameters

  • indexerName: string

    The name of the indexer to reset documents for.
  • options: ResetDocumentsOptions = {}

    Additional optional arguments.

  Returns Promise<void>

resetIndexer

• resetIndexer(indexerName, options?): Promise<void>

• Resets the change tracking state associated with an indexer.

  Parameters

  • indexerName: string

    The name of the indexer to reset.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<void>

resetSkills

• resetSkills(skillsetName, options?): Promise<void>

• Reset an existing skillset in a search service.

  Parameters

  • skillsetName: string

    The name of the skillset to reset.
  • options: ResetSkillsOptions = {}

    The options parameters.

  Returns Promise<void>

runIndexer

• runIndexer(indexerName, options?): Promise<void>

• Runs an indexer on-demand.

  Parameters

  • indexerName: string

    The name of the indexer to run.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<void>