PurviewScanClient.CancelScan(String, RequestOptions) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Scanning

Assembly:: Azure.Analytics.Purview.Scanning.dll

Package:: Azure.Analytics.Purview.Scanning v1.0.0-beta.2

Source:: PurviewScanClient.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.

Cancels a scan.

public virtual Azure.Response CancelScan (string runId, Azure.RequestOptions options);

abstract member CancelScan : string * Azure.RequestOptions -> Azure.Response
override this.CancelScan : string * Azure.RequestOptions -> Azure.Response

Public Overridable Function CancelScan (runId As String, options As RequestOptions) As Response

Parameters

runId: String

The String to use.

options: Azure.RequestOptions

The request options.

Returns

Response

Exceptions

ArgumentNullException

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

Share via