SearchIndexClient.DeleteKnowledgeBaseAsync 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 |
|---|---|
| DeleteKnowledgeBaseAsync(String, CancellationToken) | |
| DeleteKnowledgeBaseAsync(String, MatchConditions, RequestContext) |
[Protocol Method] Deletes a knowledge base.
|
| DeleteKnowledgeBaseAsync(String, MatchConditions, CancellationToken) |
Deletes a knowledge base. |
| DeleteKnowledgeBaseAsync(KnowledgeBase, Boolean, CancellationToken) |
Deletes an existing knowledge base. |
DeleteKnowledgeBaseAsync(String, CancellationToken)
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeBaseAsync(string knowledgeBaseName, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteKnowledgeBaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeBaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeBaseAsync (knowledgeBaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- knowledgeBaseName
- String
The name of the knowledge base to delete.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
The Response from the server.
Exceptions
knowledgeBaseName is null.
Applies to
DeleteKnowledgeBaseAsync(String, MatchConditions, RequestContext)
- Source:
- SearchIndexClient.cs
[Protocol Method] Deletes a knowledge base.
- 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> DeleteKnowledgeBaseAsync(string knowledgeBaseName, Azure.MatchConditions matchConditions, Azure.RequestContext context);abstract member DeleteKnowledgeBaseAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeBaseAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeBaseAsync (knowledgeBaseName As String, matchConditions As MatchConditions, context As RequestContext) As Task(Of Response)Parameters
- knowledgeBaseName
- String
The name of the knowledge base.
- 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
knowledgeBaseName is null.
knowledgeBaseName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteKnowledgeBaseAsync(String, MatchConditions, CancellationToken)
- Source:
- SearchIndexClient.cs
Deletes a knowledge base.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeBaseAsync(string knowledgeBaseName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteKnowledgeBaseAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeBaseAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeBaseAsync (knowledgeBaseName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- knowledgeBaseName
- String
The name of the knowledge base.
- 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
knowledgeBaseName is null.
knowledgeBaseName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteKnowledgeBaseAsync(KnowledgeBase, Boolean, CancellationToken)
- Source:
- SearchIndexClient.cs
Deletes an existing knowledge base.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeBaseAsync(Azure.Search.Documents.Indexes.Models.KnowledgeBase knowledgeBase, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);public virtual System.Threading.Tasks.Task<Azure.Response> DeleteKnowledgeBaseAsync(Azure.Search.Documents.Indexes.Models.KnowledgeBase KnowledgeBase, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteKnowledgeBaseAsync : Azure.Search.Documents.Indexes.Models.KnowledgeBase * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeBaseAsync : Azure.Search.Documents.Indexes.Models.KnowledgeBase * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>abstract member DeleteKnowledgeBaseAsync : Azure.Search.Documents.Indexes.Models.KnowledgeBase * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteKnowledgeBaseAsync : Azure.Search.Documents.Indexes.Models.KnowledgeBase * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteKnowledgeBaseAsync (knowledgeBase As KnowledgeBase, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Public Overridable Function DeleteKnowledgeBaseAsync (KnowledgeBase As KnowledgeBase, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- knowledgeBaseKnowledgeBase
- KnowledgeBase
The definition of the knowledge base 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
knowledgeBase is null.
