Scan Result - Cancel Scan

サービス:

Purview

API バージョン:

2023-09-01

スキャンを取り消します。

POST {endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}:cancel?api-version=2023-09-01

URI パラメーター

名前	/	必須	型	説明
dataSourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	dataSource 名。
endpoint	path	True	string (url)	purview アカウントのスキャン エンドポイント。 例: https://{accountName}.purview.azure.com。
runId	path	True	string minLength: 36 maxLength: 36 pattern: ^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$	スキャン実行 ID。
scanName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	スキャン名。
api-version	query	True	string	使用する API バージョン。

応答

名前	型	説明
202 Accepted	OperationResponse	成功。 ヘッダー Operation-Location: string
Other Status Codes	ErrorResponseModel	スキャン サービスから受信したエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ScanResult_CancelScan

要求のサンプル

HTTP

POST {endpoint}/scan/datasources/myDataSource/scans/myScanName/runs/138301e4-f4f9-4ab5-b734-bac446b236e7:cancel?api-version=2023-09-01

応答のサンプル

状態コード:

202

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
Operation-Location: https://exampleaccountname.purview.azure.com/scan/datasources/myDataSource/scans/myScanName/runs/138301e4-f4f9-4ab5-b734-bac446b236e7

{
  "scanResultId": "138301e4-f4f9-4ab5-b734-bac446b236e7",
  "startTime": "2019-05-16T17:01:37.3089193Z",
  "endTime": null,
  "status": "Accepted",
  "error": null
}

定義

名前	説明
ErrorInfo	エラー情報。
ErrorModel	エラー モデル。
ErrorResponseModel	エラー応答モデル。
OperationResponse	操作の応答。
OperationStatus	スキャン操作の状態。

ErrorInfo

Object

エラー情報。

名前	型	説明
code	string	特定のエラーを識別する一意のエラー コード。
details	ErrorInfo[]	エラー情報の詳細。
message	string	エラーの詳細を示す、人間が判読できるエラー メッセージ。
target	string	エラーが関連付けられている特定のコンポーネント。

ErrorModel

Object

エラー モデル。

名前	型	説明
code	string	特定のエラーを識別する一意のエラー コード。
details	ErrorModel[]	追加のエラーの詳細を提供する入れ子になった ErrorModel オブジェクトの配列。
message	string	エラーの詳細を示す、人間が判読できるエラー メッセージ。
target	string	エラーが関連付けられている特定のコンポーネント。

ErrorResponseModel

Object

エラー応答モデル。

名前	型	説明
error	ErrorModel	エラー モデル。

OperationResponse

Object

操作の応答。

名前	型	説明
endTime	string (date-time)	操作の終了時刻。
error	ErrorInfo	エラー情報。
scanResultId	string (uuid)	スキャン結果識別子。
startTime	string (date-time)	操作の開始時刻。
status	OperationStatus	スキャン操作の状態。

OperationStatus

列挙

スキャン操作の状態。

値	説明
Accepted	スキャンが受け入れられる
Canceled	スキャンが取り消された
Failed	スキャンに失敗しました
InProgress	スキャンが InProgress である
Succeeded	スキャンが成功しました
TransientFailure	スキャンが一時的なエラーである