Share via


SearchIndexerDataSourceConnection Class

Definition

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

public class SearchIndexerDataSourceConnection
type SearchIndexerDataSourceConnection = class
Public Class SearchIndexerDataSourceConnection
Inheritance
SearchIndexerDataSourceConnection

Constructors

SearchIndexerDataSourceConnection(String, SearchIndexerDataSourceType, String, SearchIndexerDataContainer)

Creates a new instance of the SearchIndexerDataSourceConnection class.

Properties

ConnectionString

Gets or sets a connection string to the Container.

Container

The data container for the datasource.

DataChangeDetectionPolicy

The data change detection policy for the datasource. Please note DataChangeDetectionPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include HighWaterMarkChangeDetectionPolicy and SqlIntegratedChangeTrackingPolicy.

DataDeletionDetectionPolicy

The data deletion detection policy for the datasource. Please note DataDeletionDetectionPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include NativeBlobSoftDeleteDeletionDetectionPolicy and SoftDeleteColumnDeletionDetectionPolicy.

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. Once you have encrypted your data source definition, it will always remain encrypted. The search service 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 SearchIndexerDataSourceConnection.

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. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity.

Name

The name of the datasource.

Type

The type of the datasource.

Applies to