SearchIndexClient.DeleteKnowledgeSourceFileAsync Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

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

Overloads

Name	Description
DeleteKnowledgeSourceFileAsync(String, String, CancellationToken)	Deletes a file from a File knowledge source and removes all indexed content derived from it.
DeleteKnowledgeSourceFileAsync(String, String, RequestContext)	[Protocol Method] Deletes a file from a File knowledge source and removes all indexed content derived from it. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

DeleteKnowledgeSourceFileAsync(String, String, CancellationToken)

Source:

SearchIndexClient.cs

Deletes a file from a File knowledge source and removes all indexed content derived from it.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeSourceFileAsync(string fileId, string sourceName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteKnowledgeSourceFileAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeSourceFileAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteKnowledgeSourceFileAsync (fileId As String, sourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

fileId

String

The unique identifier of the file to delete.

sourceName

String

The name of the knowledge source.

cancellationToken

CancellationToken

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

Returns

Task<Response>

Exceptions

ArgumentNullException

fileId or sourceName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

DeleteKnowledgeSourceFileAsync(String, String, RequestContext)

Source:

SearchIndexClient.cs

[Protocol Method] Deletes a file from a File knowledge source and removes all indexed content derived from it.

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

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeSourceFileAsync(string fileId, string sourceName, Azure.RequestContext context);

abstract member DeleteKnowledgeSourceFileAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeSourceFileAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteKnowledgeSourceFileAsync (fileId As String, sourceName As String, context As RequestContext) As Task(Of Response)

Parameters

fileId

String

The unique identifier of the file to delete.

sourceName

String

The name of the knowledge source.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

fileId or sourceName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.