SearchIndexClient.DeleteKnowledgeSource Method

Definition

Overloads

Name Description
DeleteKnowledgeSource(String, MatchConditions, CancellationToken)

Deletes an existing knowledge source.

DeleteKnowledgeSource(String, CancellationToken)

Deletes an existing knowledge source.

DeleteKnowledgeSource(KnowledgeSource, Boolean, CancellationToken)

Deletes an existing knowledge source.

DeleteKnowledgeSource(String, MatchConditions, RequestContext)

[Protocol Method] Deletes an existing knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

DeleteKnowledgeSource(String, MatchConditions, CancellationToken)

Source:
SearchIndexClient.cs

Deletes an existing knowledge source.

public virtual Azure.Response DeleteKnowledgeSource(string sourceName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteKnowledgeSource : string * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response
override this.DeleteKnowledgeSource : string * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteKnowledgeSource (sourceName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

sourceName
String

The name of the knowledge source.

matchConditions
MatchConditions

The content to send as the request conditions of the request.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Exceptions

sourceName is null.

sourceName is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Applies to

DeleteKnowledgeSource(String, CancellationToken)

Source:
SearchIndexClient.KnowledgeSources.cs

Deletes an existing knowledge source.

public virtual Azure.Response DeleteKnowledgeSource(string sourceName, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteKnowledgeSource : string * System.Threading.CancellationToken -> Azure.Response
override this.DeleteKnowledgeSource : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteKnowledgeSource (sourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

sourceName
String

The name of the knowledge source to delete.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

The Response from the server.

Exceptions

sourceName is null.

Applies to

DeleteKnowledgeSource(KnowledgeSource, Boolean, CancellationToken)

Source:
SearchIndexClient.KnowledgeSources.cs
Source:
SearchIndexClient.KnowledgeSources.cs

Deletes an existing knowledge source.

public virtual Azure.Response DeleteKnowledgeSource(Azure.Search.Documents.Indexes.Models.KnowledgeSource knowledgeSource, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteKnowledgeSource : Azure.Search.Documents.Indexes.Models.KnowledgeSource * bool * System.Threading.CancellationToken -> Azure.Response
override this.DeleteKnowledgeSource : Azure.Search.Documents.Indexes.Models.KnowledgeSource * bool * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteKnowledgeSource (knowledgeSource As KnowledgeSource, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

knowledgeSource
KnowledgeSource

The definition of the knowledge source to delete.

onlyIfUnchanged
Boolean

True to throw a RequestFailedException if the ETag does not match the current service version; otherwise, the current service version will be overwritten.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

The Response from the server.

Exceptions

knowledgeSource is null.

Applies to

DeleteKnowledgeSource(String, MatchConditions, RequestContext)

Source:
SearchIndexClient.cs

[Protocol Method] Deletes an existing knowledge source.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response DeleteKnowledgeSource(string sourceName, Azure.MatchConditions matchConditions, Azure.RequestContext context);
abstract member DeleteKnowledgeSource : string * Azure.MatchConditions * Azure.RequestContext -> Azure.Response
override this.DeleteKnowledgeSource : string * Azure.MatchConditions * Azure.RequestContext -> Azure.Response
Public Overridable Function DeleteKnowledgeSource (sourceName As String, matchConditions As MatchConditions, context As RequestContext) As Response

Parameters

sourceName
String

The name of the knowledge source.

matchConditions
MatchConditions

The content to send as the request conditions of the request.

context
RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The response returned from the service.

Exceptions

sourceName is null.

sourceName is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Applies to