SearchIndexClient.DeleteKnowledgeSourceAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| DeleteKnowledgeSourceAsync(String, MatchConditions, CancellationToken) |
Deletes an existing knowledge source. |
| DeleteKnowledgeSourceAsync(String, MatchConditions, RequestContext) |
[Protocol Method] Deletes an existing knowledge source.
|
| DeleteKnowledgeSourceAsync(KnowledgeSource, Boolean, CancellationToken) |
Deletes an existing knowledge source. |
| DeleteKnowledgeSourceAsync(String, CancellationToken) |
Deletes an existing knowledge source. |
DeleteKnowledgeSourceAsync(String, MatchConditions, CancellationToken)
- Source:
- SearchIndexClient.cs
Deletes an existing knowledge source.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeSourceAsync(string sourceName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteKnowledgeSourceAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeSourceAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeSourceAsync (sourceName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
DeleteKnowledgeSourceAsync(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 System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeSourceAsync(string sourceName, Azure.MatchConditions matchConditions, Azure.RequestContext context);abstract member DeleteKnowledgeSourceAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeSourceAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeSourceAsync (sourceName As String, matchConditions As MatchConditions, context As RequestContext) As Task(Of 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
DeleteKnowledgeSourceAsync(KnowledgeSource, Boolean, CancellationToken)
- Source:
- SearchIndexClient.cs
Deletes an existing knowledge source.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeSourceAsync(Azure.Search.Documents.Indexes.Models.KnowledgeSource knowledgeSource, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteKnowledgeSourceAsync : Azure.Search.Documents.Indexes.Models.KnowledgeSource * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeSourceAsync : Azure.Search.Documents.Indexes.Models.KnowledgeSource * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeSourceAsync (knowledgeSource As KnowledgeSource, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
DeleteKnowledgeSourceAsync(String, CancellationToken)
Deletes an existing knowledge source.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeSourceAsync(string sourceName, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteKnowledgeSourceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeSourceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeSourceAsync (sourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.
