SearchIndexerDataSourceConnection interface
Represents a datasource definition, which can be used to configure an indexer.
Properties
connection |
The connection string for the datasource. |
container | The data container for the datasource. |
data |
The data change detection policy for the datasource. |
data |
The data deletion detection policy for the datasource. |
description | The description of the datasource. |
encryption |
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. |
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. |
name | The name of the datasource. |
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
dataChangeDetectionPolicy
The data change detection policy for the datasource.
dataChangeDetectionPolicy?: DataChangeDetectionPolicy
Property Value
dataDeletionDetectionPolicy
The data deletion detection policy for the datasource.
dataDeletionDetectionPolicy?: SoftDeleteColumnDeletionDetectionPolicy
Property Value
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 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.
encryptionKey?: SearchResourceEncryptionKey
Property Value
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
name
The name of the datasource.
name: 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"
Property Value
"azuresql" | "cosmosdb" | "azureblob" | "azuretable" | "mysql" | "adlsgen2"