Share via


PurviewScanClient.CancelScanAsync(String, RequestOptions) Method

Definition

Cancels a scan.

public virtual System.Threading.Tasks.Task<Azure.Response> CancelScanAsync (string runId, Azure.RequestOptions options);
abstract member CancelScanAsync : string * Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelScanAsync : string * Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CancelScanAsync (runId As String, options As RequestOptions) As Task(Of Response)

Parameters

runId
String

The String to use.

options
Azure.RequestOptions

The request options.

Returns

Exceptions

runId is null.

Remarks

Schema for Response Body:

{
              scanResultId: OperationResponseScanResultId,
              startTime: string (ISO 8601 Format),
              endTime: string (ISO 8601 Format),
              status: "Accepted" | "InProgress" | "TransientFailure" | "Succeeded" | "Failed" | "Canceled",
              error: {
                code: string,
                message: string,
                target: string,
                details: [
                  {
                    code: string,
                    message: string,
                    target: string,
                    details: [ErrorInfo]
                  }
                ]
              }
            }

Schema for Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [
                  {
                    code: string,
                    message: string,
                    target: string,
                    details: [ErrorModel]
                  }
                ]
              }
            }

Applies to