SearchIndexerDataSourceConnection interface

Package:

@azure/search-documents

Represents a datasource definition, which can be used to configure an indexer.

Properties

connectionString	The connection string for the datasource.
container	The data container for the datasource.
dataChangeDetectionPolicy	The data change detection policy for the datasource.
dataDeletionDetectionPolicy	The data deletion detection policy for the datasource.
description	The description of the datasource.
encryptionKey	A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure AI Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure AI Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
etag	The ETag of the DataSource.
identity	An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared.
indexerPermissionOptions	Ingestion options with various types of permission data.
name	The name of the datasource.
subType	A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the datasource. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql', 'AdlsGen2'

Property Details

connectionString

The connection string for the datasource.

connectionString?: string

Property Value

string

container

The data container for the datasource.

container: SearchIndexerDataContainer

Property Value

SearchIndexerDataContainer

dataChangeDetectionPolicy

The data change detection policy for the datasource.

dataChangeDetectionPolicy?: DataChangeDetectionPolicy

Property Value

DataChangeDetectionPolicy

dataDeletionDetectionPolicy

The data deletion detection policy for the datasource.

dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy

Property Value

DataDeletionDetectionPolicy

description

The description of the datasource.

description?: string

Property Value

string

encryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure AI Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure AI Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

encryptionKey?: SearchResourceEncryptionKey

Property Value

SearchResourceEncryptionKey

etag

The ETag of the DataSource.

etag?: string

Property Value

string

identity

An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared.

identity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

indexerPermissionOptions

Ingestion options with various types of permission data.

indexerPermissionOptions?: string[]

Property Value

string[]

name

The name of the datasource.

name: string

Property Value

string

subType

A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. NOTE: This property will not be serialized. It can only be populated by the server.

subType?: string

Property Value

string

type

The type of the datasource. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql', 'AdlsGen2'

type: "azuresql" | "cosmosdb" | "azureblob" | "azuretable" | "mysql" | "adlsgen2" | "onelake" | "sharepoint"

Property Value

"azuresql" | "cosmosdb" | "azureblob" | "azuretable" | "mysql" | "adlsgen2" | "onelake" | "sharepoint"