QuantumJobClient.CancelJobAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Quantum.Jobs

Assembly:: Azure.Quantum.Jobs.dll

Package:: Azure.Quantum.Jobs v1.0.0-beta.3

Source:: QuantumJobClient.cs

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.

Cancel a job.

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

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

Public Overridable Function CancelJobAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

jobId: String

Id of the job.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

ArgumentNullException

jobId is null.

Applies to

Share via