SearchModelFactory.KnowledgeSource Method

Definition

Represents a knowledge source definition. Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSource, AzureBlobKnowledgeSource, IndexedOneLakeKnowledgeSource, and WebKnowledgeSource.

public static Azure.Search.Documents.Indexes.Models.KnowledgeSource KnowledgeSource(string name = default, string description = default, string kind = default, Azure.ETag? eTag = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default);
static member KnowledgeSource : string * string * string * Nullable<Azure.ETag> * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey -> Azure.Search.Documents.Indexes.Models.KnowledgeSource
Public Shared Function KnowledgeSource (Optional name As String = Nothing, Optional description As String = Nothing, Optional kind As String = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing) As KnowledgeSource

Parameters

name
String

The name of the knowledge source.

description
String

Optional user-defined description.

kind
String

The type of the knowledge source.

eTag
Nullable<ETag>

The ETag of the knowledge source.

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 knowledge source definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge 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 knowledge source 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.

Returns

A new KnowledgeSource instance for mocking.

Applies to