SearchIndexerClient Class

Close the session. :return: None :rtype: None

async close() -> None

Creates a new data source connection. :param data_source_connection: The definition of the data source connection to create. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

async create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection

Examples

Create a SearchIndexerDataSourceConnection

   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source = SearchIndexerDataSourceConnection(
       name="async-sample-data-source-connection",
       type="azureblob",
       connection_string=connection_string,
       container=container,
   )
   result = await client.create_data_source_connection(data_source)
   print("Create new Data Source Connection - async-sample-data-source-connection")

Creates a new SearchIndexer.

async create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer

Parameters

Returns

Examples

Create a SearchIndexer

   # create a datasource
   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source_connection = SearchIndexerDataSourceConnection(
       name="async-indexer-datasource", type="azureblob", connection_string=connection_string, container=container
   )
   data_source = await indexers_client.create_data_source_connection(data_source_connection)

   # create an indexer
   indexer = SearchIndexer(
       name="async-sample-indexer",
       data_source_name="async-indexer-datasource",
       target_index_name="async-indexer-hotels",
   )
   result = await indexers_client.create_indexer(indexer)
   print("Create new Indexer - async-sample-indexer")

Creates a new data source connection or updates a data source connection if it already exists. :param data_source_connection: The definition of the data source connection to create or update. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: The match condition to use upon the etag :paramtype match_condition: ~azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

async create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection

Creates a new indexer or updates a indexer if it already exists.

async create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

Parameters

Keyword-Only Parameters

Returns

Create a new SearchIndexerSkillset in an Azure Search service, or update an existing one.

async create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset

Parameters

Keyword-Only Parameters

Returns

Create a new SearchIndexerSkillset in an Azure Search service

async create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset

Parameters

Returns

Deletes a data source connection. To use access conditions, the SearchIndexerDataSourceConnection model must be provided instead of the name. It is enough to provide the name of the data source connection to delete unconditionally

async delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameters

Keyword-Only Parameters

Examples

Delete a SearchIndexerDataSourceConnection

   await client.delete_data_source_connection("async-sample-data-source-connection")
   print("Data Source Connection 'async-sample-data-source-connection' successfully deleted")

Deletes an indexer. To use access conditions, the SearchIndexer model must be provided instead of the name. It is enough to provide the name of the indexer to delete unconditionally.

async delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameters

Keyword-Only Parameters

Examples

Delete a SearchIndexer

   await indexers_client.delete_indexer("async-sample-indexer")
   print("Indexer 'async-sample-indexer' successfully deleted")

Delete a named SearchIndexerSkillset in an Azure Search service. To use access conditions, the SearchIndexerSkillset model must be provided instead of the name. It is enough to provide the name of the skillset to delete unconditionally

async delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameters

Keyword-Only Parameters

Retrieves a data source connection definition.

async get_data_source_connection(name: str, *, select: List[str] | None = None, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parameters

Keyword-Only Parameters

Returns

Lists all data source connection names available for a search service.

async get_data_source_connection_names(**kwargs) -> Sequence[str]

Returns

Lists all data source connections available for a search service.

async get_data_source_connections(**kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

Returns

Examples

List all SearchIndexerDataSourceConnections

   result = await client.get_data_source_connections()
   names = [x.name for x in result]
   print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))

Retrieves a indexer definition.

async get_indexer(name: str, **kwargs: Any) -> SearchIndexer

Parameters

Returns

Examples

Retrieve a SearchIndexer

   result = await indexers_client.get_indexer("async-sample-indexer")
   print("Retrived Indexer 'async-sample-indexer'")
   return result

Lists all indexer names available for a search service.

async get_indexer_names(**kwargs) -> Sequence[str]

Returns

Get the status of the indexer.

async get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus

Parameters

Returns

Examples

Get a SearchIndexer's status

   result = await indexers_client.get_indexer_status("async-sample-indexer")
   print("Retrived Indexer status for 'async-sample-indexer'")
   return result

Lists all indexers available for a search service.

async get_indexers(*, select: List[str] | None = None, **kwargs) -> Sequence[SearchIndexer]

Keyword-Only Parameters

Returns

Examples

List all the SearchIndexers

   result = await indexers_client.get_indexers()
   names = [x.name for x in result]
   print("Found {} Indexers in the service: {}".format(len(result), ", ".join(names)))

Retrieve a named SearchIndexerSkillset in an Azure Search service

async get_skillset(name: str, **kwargs) -> SearchIndexerSkillset

Parameters

Returns

Exceptions

List the SearchIndexerSkillset names in an Azure Search service.

async get_skillset_names(**kwargs) -> List[str]

Returns

Exceptions

List the SearchIndexerSkillsets in an Azure Search service.

async get_skillsets(*, select: List[str] | None = None, **kwargs) -> List[SearchIndexerSkillset]

Keyword-Only Parameters

Returns

Exceptions

Resets the change tracking state associated with an indexer.

async reset_indexer(name: str, **kwargs: Any) -> None

Parameters

Examples

Reset a SearchIndexer's change tracking state

   await indexers_client.reset_indexer("async-sample-indexer")
   print("Reset the Indexer 'async-sample-indexer'")
   return

Run an indexer.

async run_indexer(name: str, **kwargs: Any) -> None

Parameters

Examples

Run a SearchIndexer

   await indexers_client.run_indexer("async-sample-indexer")
   print("Ran the Indexer 'async-sample-indexer'")
   return