Scan Result - Get Scan Status

リファレンス

サービス:: Purview

API バージョン:: 2023-09-01

インジェストの詳細を含むスキャン実行の状態を取得します。

GET {endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}?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 バージョン。

応答

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

名前

型

説明

200 OK

ScanResultWithIngestion

成功。

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_GetScanStatus

要求のサンプル

HTTP

GET {endpoint}/scan/datasources/DataSource1/scans/scan1/runs/7bcde71f-4a4e-4e01-9226-c99d15fa0f30?api-version=2023-09-01

応答のサンプル

状態コード:: 200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "parentId": null,
  "id": "7bcde71f-4a4e-4e01-9226-c99d15fa0f30",
  "ingestionJobId": "7bcde71f-4a4e-4e01-9226-c99d15fa0f30",
  "resourceId": "/subscriptions/4ec8b4ae-b823-43c5-90d9-7ec52a84c0c5/resourceGroups/yongyu_scan_test/providers/Microsoft.Sql/servers/yongyu-sqlservers-0724",
  "status": "Succeeded",
  "diagnostics": {
    "notifications": [],
    "exceptionCountMap": {}
  },
  "startTime": "2023-07-31T01:40:22.6764952Z",
  "endTime": "2023-07-31T01:41:48.6834379Z",
  "scanRulesetVersion": 4,
  "scanRulesetType": "System",
  "scanLevelType": "Incremental",
  "errorMessage": null,
  "error": null,
  "runType": "Manual",
  "dataSourceType": "AzureSqlDatabase",
  "discoveryExecutionDetails": {
    "discoveryStartTime": "2023-07-31T01:41:14Z",
    "discoveryEndTime": "2023-07-31T01:41:14Z",
    "status": "Succeeded",
    "statistics": {
      "assets": {
        "discovered": 3,
        "classified": 0,
        "failed": 0
      }
    },
    "isErrorLogAvailable": false
  },
  "ingestionExecutionDetails": {
    "ingestionStartTime": "2023-07-31T01:41:10.8601338Z",
    "ingestionEndTime": "2023-07-31T01:41:48.6834379Z",
    "status": "Succeeded",
    "statistics": {
      "assets": {
        "succeeded": 2,
        "failed": 0,
        "processing": 0
      },
      "relationships": {
        "succeeded": 0,
        "failed": 0,
        "processing": 0
      }
    },
    "estimatedTimeRemainingInSeconds": 12,
    "isErrorLogAvailable": false
  }
}

定義

名前	説明
DataSourceType	データソースの種類。
DiscoveryExecutionDetails	検出の実行の詳細。
ErrorModel	エラーモデル。
ErrorResponseModel	エラー応答モデル。
IngestionExecutionDetails	インジェスト実行の詳細。
IngestionPhaseStatus	インジェストの状態。
Notification	通知モデル。
ScanDiagnostics	スキャン診断。
ScanLevelType	スキャンレベルの種類。
ScanResultWithIngestion	インジェストを含むスキャン結果。
ScanRulesetType	スキャンルールセットの種類。
ScanRunStatus	スキャン結果の状態。
ScanStatus	検出の状態。

DataSourceType

列挙

データソースの種類。

値	説明
AdlsGen1
AdlsGen2
AmazonAccount
AmazonPostgreSql
AmazonRedShift
AmazonS3
AmazonSql
ArcEnabledSqlServer
AzureCosmosDb
AzureDataExplorer
AzureFileService
AzureMySql
AzurePostgreSql
AzureResourceGroup
AzureSqlDataWarehouse
AzureSqlDatabase
AzureSqlDatabaseManagedInstance
AzureStorage
AzureSubscription
AzureSynapse
AzureSynapseWorkspace
Databricks
DatabricksHms
DatabricksUnityCatalog
Dataverse
Fabric
Hdfs
None
Oracle
PostgreSql
PowerBI
SapEcc
SapS4Hana
Snowflake
SqlServerDatabase
TableauServer
Teradata
Trident

DiscoveryExecutionDetails

Object

検出の実行の詳細。

名前	型	説明
discoveryEndTime	string (date-time)	検出の終了時刻。
discoveryStartTime	string (date-time)	検出の開始時刻。
isErrorLogAvailable	boolean	エラーログが使用可能かどうかを示します。
statistics		検出の統計情報。
status	ScanStatus	検出の状態。

ErrorModel

Object

エラーモデル。

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

ErrorResponseModel

Object

エラー応答モデル。

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

IngestionExecutionDetails

Object

インジェスト実行の詳細。

名前	型	説明
estimatedTimeRemainingInSeconds	integer (int64)	推定残り時間 (秒)。
ingestionEndTime	string (date-time)	インジェストの終了時刻。
ingestionStartTime	string (date-time)	インジェストの開始時刻。
isErrorLogAvailable	boolean	エラーログが使用可能かどうかを示します。
lastUpdatedAt	string (date-time)	最後に更新された時刻。
statistics		インジェストの統計情報。
status	IngestionPhaseStatus	インジェストの状態。

IngestionPhaseStatus

列挙

インジェストの状態。

値	説明
Canceled
Canceling
Failed
InProgress
None
PartialSucceeded
Queued
SourceUnknown
Succeeded

Notification

Object

通知モデル。

名前	型	説明
code	integer (int32)	通知コード。
message	string	通知メッセージ。

ScanDiagnostics

Object

スキャン診断。

名前	型	説明
exceptionCountMap	object	例外カウントマップ。
notifications	Notification[]	通知。

ScanLevelType

列挙

スキャンレベルの種類。

値	説明
Full	スキャンがフルスキャンである
Incremental	スキャンが増分スキャンである

ScanResultWithIngestion

Object

インジェストを含むスキャン結果。

名前	型	説明
dataSourceType	DataSourceType	データソースの種類。
diagnostics	ScanDiagnostics	スキャン診断。
discoveryExecutionDetails	DiscoveryExecutionDetails	検出の実行の詳細。
endTime	string (date-time)	スキャンの終了時刻。
error	ErrorModel	エラー。
errorMessage	string	エラーメッセージ。
id	string	スキャン結果識別子。
ingestionExecutionDetails	IngestionExecutionDetails	インジェスト実行の詳細。
ingestionJobId	string	インジェストジョブ識別子。
parentId	string	親スキャン結果識別子。
resourceId	string	リソース識別子。
runType	string	実行の種類。
scanLevelType	ScanLevelType	スキャンレベルの種類。
scanRulesetType	ScanRulesetType	スキャンルールセットの種類。
scanRulesetVersion	integer (int32)	スキャンルールセットのバージョン。
startTime	string (date-time)	スキャンの開始時刻。
status	ScanRunStatus	スキャン結果の状態。

ScanRulesetType

列挙

スキャンルールセットの種類。

値	説明
Custom	スキャンルールセットの種類がカスタムである
System	スキャンルールセットの種類がシステムの既定値です

ScanRunStatus

列挙

スキャン結果の状態。

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

ScanStatus

列挙

検出の状態。

値	説明
Cancelled
CompleteWithWarning
CompletedWithExceptions
Delayed
Failed
Queued
Running
Succeeded
Throttled

次の方法で共有

Scan Result - Get Scan Status

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ScanResult_GetScanStatus

要求のサンプル

応答のサンプル

定義

DataSourceType

DiscoveryExecutionDetails

ErrorModel

ErrorResponseModel

IngestionExecutionDetails

IngestionPhaseStatus

Notification

ScanDiagnostics

ScanLevelType

ScanResultWithIngestion

ScanRulesetType

ScanRunStatus

ScanStatus