KnowledgeBases.CancelIndexingAsync Method

Definition

Overloads

CancelIndexingAsync(WaitUntil, String, RequestContext)

Source:
KnowledgeBases.cs

Cancel indexing.

public virtual System.Threading.Tasks.Task<Azure.Operation> CancelIndexingAsync(Azure.WaitUntil waitUntil, string knowledgeBaseName, Azure.RequestContext context);
abstract member CancelIndexingAsync : Azure.WaitUntil * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.CancelIndexingAsync : Azure.WaitUntil * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
Public Overridable Function CancelIndexingAsync (waitUntil As WaitUntil, knowledgeBaseName As String, context As RequestContext) As Task(Of Operation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

knowledgeBaseName
String

The knowledgeBase name.

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.

Applies to

CancelIndexingAsync(WaitUntil, String, CancellationToken)

Source:
KnowledgeBases.cs

Cancel indexing.

public virtual System.Threading.Tasks.Task<Azure.Operation> CancelIndexingAsync(Azure.WaitUntil waitUntil, string knowledgeBaseName, System.Threading.CancellationToken cancellationToken = default);
abstract member CancelIndexingAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
override this.CancelIndexingAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
Public Overridable Function CancelIndexingAsync (waitUntil As WaitUntil, knowledgeBaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

knowledgeBaseName
String

The knowledgeBase name.

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.

Applies to