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(KnowledgeBase, Boolean, CancellationToken) |
Deletes an existing knowledge base. |
DeleteKnowledgeBaseAsync(String, CancellationToken)
- Source:
- SearchIndexClient.Aliases.cs
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(KnowledgeBase, Boolean, CancellationToken)
- Source:
- SearchIndexClient.Aliases.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);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)Parameters
- KnowledgeBase
- 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.
