azure.azcollection.azure_rm_searchdatasource module – Manage a data source 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_searchdatasource.

New in azure.azcollection 4.2.0

Synopsis

  • Create, update, and delete a data source connection within an Azure AI Search service (data plane). A data source tells an indexer where to read documents from (Blob storage, Azure SQL, Cosmos DB, ADLS Gen2, or Table).

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"

connection_string

string

Connection string for the data source. Required when creating a data source.

Sent to Azure as credentials.connectionString. Azure redacts this value on read, so changes to the connection string alone are not detected as drift; every other field is compared normally.

On update, if omitted, the existing connection string is preserved.

container

dictionary

The container/table/collection the indexer reads from.

name

string / required

Name of the container, table, or collection.

query

string

Optional query that narrows or shapes the rows/blobs returned (for example a SQL query, a blob path prefix, or a Cosmos DB query).

data_change_detection_policy

dictionary

Change-detection policy used for incremental indexing.

Passed through to the Azure AI Search API using camelCase keys; see the Azure AI Search reference for structure.

data_deletion_detection_policy

dictionary

Soft-delete detection policy used to remove documents from the index.

Passed through to the Azure AI Search API using camelCase keys; see the Azure AI Search reference for structure.

description

string

Free-text description of the data source.

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

identity

dictionary

Explicit managed identity the data source uses to connect (as an alternative to a key in the connection string).

Passed through to the Azure AI Search API as identity using camelCase keys; set its @odata.type to #Microsoft.Azure.Search.DataNoneIdentity (system-assigned or none) or #Microsoft.Azure.Search.DataUserAssignedIdentity with a userAssignedIdentity resource ID. See the Azure AI Search reference.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

Name of the data source.

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.

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.

search_service_name

string / required

Name of the Azure AI Search service that hosts the data source.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

Assert the state of the data source. Use present to create/update, absent to delete.

Choices:

  • "present" ← (default)

  • "absent"

subscription_id

string

Your Azure subscription Id.

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.

type

string

The type of the data source. Required when creating a data source.

Choices:

  • "azureblob"

  • "azuretable"

  • "azuresql"

  • "cosmosdb"

  • "adlsgen2"

  • "mysql"

  • "onelake"

  • "sharepoint"

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 blob data source
  azure.azcollection.azure_rm_searchdatasource:
    resource_group: myResourceGroup
    search_service_name: mysearchsvc
    name: blob-ds
    type: azureblob
    connection_string: "{{ storage_connection_string }}"
    container:
      name: documents
      query: knowledge-base/
    state: present

- name: Delete a data source
  azure.azcollection.azure_rm_searchdatasource:
    resource_group: myResourceGroup
    search_service_name: mysearchsvc
    name: blob-ds
    state: absent

Return Values

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

Key

Description

state

dictionary

The data source definition as returned by Azure AI Search.

The connection string is redacted by Azure and is not returned in clear text.

Returned: when state=present

Sample: {"container": {"name": "documents"}, "name": "blob-ds", "type": "azureblob"}

Authors

  • Bill Peck (@p3ck)