SearchModelFactory.FileKnowledgeSource Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.1

Source:

SearchModelFactory.cs

Configuration for File knowledge source that supports direct file upload and indexing.

public static Azure.Search.Documents.Indexes.Models.FileKnowledgeSource FileKnowledgeSource(string name = default, string description = default, Azure.ETag? eTag = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default, Azure.Search.Documents.Indexes.Models.FileKnowledgeSourceParameters fileParameters = default);

static member FileKnowledgeSource : string * string * Nullable<Azure.ETag> * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey * Azure.Search.Documents.Indexes.Models.FileKnowledgeSourceParameters -> Azure.Search.Documents.Indexes.Models.FileKnowledgeSource

Public Shared Function FileKnowledgeSource (Optional name As String = Nothing, Optional description As String = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing, Optional fileParameters As FileKnowledgeSourceParameters = Nothing) As FileKnowledgeSource

Parameters

name

String

The name of the knowledge source.

description

String

Optional user-defined description.

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.

fileParameters

FileKnowledgeSourceParameters

The parameters for the File knowledge source.

Returns

FileKnowledgeSource

A new FileKnowledgeSource instance for mocking.