SearchModelFactory.SearchIndexKnowledgeSource Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1

Overloads

SearchIndexKnowledgeSource(String, String, Nullable<ETag>, SearchResourceEncryptionKey, SearchIndexKnowledgeSourceParameters)

Source:
SearchModelFactory.cs

Knowledge Source targeting a search index.

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

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.

searchIndexParameters
SearchIndexKnowledgeSourceParameters

The parameters for the knowledge source.

Returns

SearchIndexKnowledgeSource

A new SearchIndexKnowledgeSource instance for mocking.

Applies to

SearchIndexKnowledgeSource(String, String, String, String, SearchResourceEncryptionKey, IDictionary<String,BinaryData>, SearchIndexKnowledgeSourceParameters)

Source:
SearchModelFactory.cs

Initializes a new instance of SearchIndexKnowledgeSource(String, String, String, String, SearchResourceEncryptionKey, IDictionary<String,BinaryData>, SearchIndexKnowledgeSourceParameters).

public static Azure.Search.Documents.Indexes.Models.KnowledgeSource SearchIndexKnowledgeSource(string name = default, string description = default, string kind = default, string eTag = default, Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey encryptionKey = default, System.Collections.Generic.IDictionary<string,BinaryData> serializedAdditionalRawData = default, Azure.Search.Documents.Indexes.Models.SearchIndexKnowledgeSourceParameters searchIndexParameters = default);
static member SearchIndexKnowledgeSource : string * string * string * string * Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey * System.Collections.Generic.IDictionary<string, BinaryData> * Azure.Search.Documents.Indexes.Models.SearchIndexKnowledgeSourceParameters -> Azure.Search.Documents.Indexes.Models.KnowledgeSource
Public Shared Function SearchIndexKnowledgeSource (Optional name As String = Nothing, Optional description As String = Nothing, Optional kind As String = Nothing, Optional eTag As String = Nothing, Optional encryptionKey As SearchResourceEncryptionKey = Nothing, Optional serializedAdditionalRawData As IDictionary(Of String, BinaryData) = Nothing, Optional searchIndexParameters As SearchIndexKnowledgeSourceParameters = 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
String

The ETag of the agent.

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

serializedAdditionalRawData
IDictionary<String,BinaryData>

Keeps track of any properties unknown to the library.

searchIndexParameters
SearchIndexKnowledgeSourceParameters

The parameters for the knowledge source.

Returns

KnowledgeSource

Applies to