azure.azcollection.azure_rm_searchindexer module – Manage an indexer in an Azure AI Search service

Note

This module is part of the azure.azcollection collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_searchindexer.

New in azure.azcollection 4.2.0

Synopsis

• Create, update, delete, run, and reset an indexer within an Azure AI Search service (data plane).

• An indexer is the automated ingestion pipeline that pulls data from a data source, optionally enriches it through a skillset, and writes it into a search index on a schedule.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• The host that executes this module must have the azure.azcollection collection installed via galaxy

• All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
admin_key string	Admin API key for the search service, used to authenticate data-plane requests via the api-key header. This is supplementary to the standard Azure credentials. The module always requires standard Azure authentication parameters and a subscription ID (see the azure.azcollection.azure documentation fragment) to run, regardless of whether this is set. If omitted, data-plane requests are authenticated with an RBAC bearer token (managed identity / service principal) using the data-plane scope https://search.azure.com/.default.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. Default: "latest"
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables. When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The msi was added in Ansible 2.6. Choices: "auto" ← (default) "cli" "credential_file" "env" "msi"
cert_validation_mode string added in azure.azcollection 0.0.1	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. Choices: "ignore" "validate"
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the AZURE_CLIENT_ID environment variable.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. Default: "AzureCloud"
data_source_name string	Name of the data source the indexer reads documents from. Required when creating an indexer.
description string	Free-text description of the indexer.
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable. Choices: false ← (default) true
disabled boolean	Whether the indexer is disabled. A disabled indexer does not run on its schedule and cannot be run on demand until re-enabled. Choices: false true
field_mappings list / elements=dictionary	Mappings from source fields to target index fields. Each entry is a dict with sourceFieldName, targetFieldName, and optionally mappingFunction.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	Name of the indexer.
oidc_token string added in azure.azcollection 3.17.0	Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication. This token is exchanged with Azure AD using OIDC federated identity. Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform. Can also be set via the AZURE_FEDERATED_TOKEN environment variable.
oidc_token_file_path path added in azure.azcollection 3.17.0	Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication. The file must contain only raw token. This method is commonly used in platforms that materialize OIDC tokens as files Can also be set via the AZURE_FEDERATED_TOKEN_FILE environment variable.
output_field_mappings list / elements=dictionary	Mappings from enriched (skillset output) fields to target index fields. Each entry is a dict with sourceFieldName, targetFieldName, and optionally mappingFunction.
parameters dictionary	Indexer execution parameters such as batchSize, maxFailedItems, and a configuration block (for example parsingMode and excludedFileNameExtensions).
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	Name of the resource group containing the search service.
schedule dictionary	Indexing schedule for the indexer. Omit for an on-demand indexer.
interval string / required	The interval between indexer runs, as an ISO 8601 duration (for example P1D for daily or PT6H for every six hours). The smallest supported interval is five minutes (PT5M).
start_time string	The UTC start time for the schedule, as an ISO 8601 datetime. If omitted, Azure assigns one.
search_service_name string / required	Name of the Azure AI Search service that hosts the indexer.
secret string	Azure client secret. Use when authenticating with a Service Principal.
skillset_name string	Name of a skillset to run against documents during ingestion.
state string	Assert the state of the indexer. present creates or updates, absent deletes. run triggers an on-demand run of an existing indexer. reset clears the indexer’s change-tracking state so the next run reprocesses all documents. run and reset are actions and always report changed=true. Choices: "present" ← (default) "absent" "run" "reset"
subscription_id string	Your Azure subscription Id.
target_index_name string	Name of the search index the indexer writes documents to. Required when creating an indexer.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes

Note

• For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

• Authentication is also possible using a service principal or Active Directory user.

• To authenticate via OIDC, pass client_id, tenant and oidc_token or oidc_token_file_path, or set environment variables AZURE_CLIENT_ID, AZURE_TENANT and AZURE_FEDERATED_TOKEN or AZURE_FEDERATED_TOKEN_FILE.

• To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

• To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

• Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create a scheduled indexer for a RAG knowledge base
  azure.azcollection.azure_rm_searchindexer:
    resource_group: myResourceGroup
    search_service_name: mysearchsvc
    name: blob-indexer
    target_index_name: knowledge-index
    data_source_name: blob-datasource
    skillset_name: embedding-skillset
    schedule:
      interval: PT6H
    field_mappings:
      - sourceFieldName: metadata_storage_name
        targetFieldName: title
    output_field_mappings:
      - sourceFieldName: /document/embeddings
        targetFieldName: vector
    parameters:
      batchSize: 50
      configuration:
        parsingMode: default
        excludedFileNameExtensions: ".png,.jpg"
    state: present

- name: Trigger an on-demand indexer run
  azure.azcollection.azure_rm_searchindexer:
    resource_group: myResourceGroup
    search_service_name: mysearchsvc
    name: blob-indexer
    state: run

- name: Reset the indexer's change-tracking state
  azure.azcollection.azure_rm_searchindexer:
    resource_group: myResourceGroup
    search_service_name: mysearchsvc
    name: blob-indexer
    state: reset

- name: Delete an indexer
  azure.azcollection.azure_rm_searchindexer:
    resource_group: myResourceGroup
    search_service_name: mysearchsvc
    name: blob-indexer
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
state dictionary	The indexer definition as returned by Azure AI Search. Returned: when state=present Sample: {"dataSourceName": "blob-datasource", "name": "blob-indexer", "targetIndexName": "knowledge-index"}

Authors

• Bill Peck (@p3ck)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)