Package version:

Interface SearchIndexerDataSourceConnection

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

interface SearchIndexerDataSourceConnection {
    connectionString?: string;
    container: SearchIndexerDataContainer;
    dataChangeDetectionPolicy?: DataChangeDetectionPolicy;
    dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy;
    description?: string;
    encryptionKey?: SearchResourceEncryptionKey;
    etag?: string;
    identity?: SearchIndexerDataIdentity;
    name: string;
    type:
        | "azuresql"
        | "cosmosdb"
        | "azureblob"
        | "azuretable"
        | "mysql"
        | "adlsgen2"
        | "onelake";
}

Properties

connectionString? container dataChangeDetectionPolicy? dataDeletionDetectionPolicy? description? encryptionKey? etag? identity? name type

Properties

OptionalconnectionString

connectionString?: string

The connection string for the datasource.

container

container: SearchIndexerDataContainer

The data container for the datasource.

OptionaldataChangeDetectionPolicy

dataChangeDetectionPolicy?: DataChangeDetectionPolicy

The data change detection policy for the datasource.

OptionaldataDeletionDetectionPolicy

dataDeletionDetectionPolicy?: DataDeletionDetectionPolicy

The data deletion detection policy for the datasource.

Optionaldescription

description?: string

The description of the datasource.

OptionalencryptionKey

encryptionKey?: SearchResourceEncryptionKey

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 Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive 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.

Optionaletag

etag?: string

The ETag of the DataSource.

Optionalidentity

identity?: SearchIndexerDataIdentity

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.

name

name: string

The name of the datasource.

type

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

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

Settings

Member Visibility